loginWithCustomerLoginJwt

Example Query

mutation ExampleMutation($jwt: String!, $guestCartEntityId: String) {
  loginWithCustomerLoginJwt(jwt: $jwt, guestCartEntityId: $guestCartEntityId) {
    redirectTo
    customer {
      entityId
      company
      customerGroupId
      customerGroupName
      email
      firstName
      lastName
      notes
      phone
      taxExemptCategory
    }
    cart {
      id
      entityId
      currencyCode
      displayCurrencyCode
      isTaxIncluded
      baseAmount
      baseAmountInDisplayCurrency
      discountedAmount
      discountedAmountInDisplayCurrency
      amount
    }
    customerAccessToken {
      value
      expiresAt
    }
  }
}

Variables

{
  "jwt": "example",
  "guestCartEntityId": "example"
}

Example response

{
  "data": {
    "loginWithCustomerLoginJwt": {
      "redirectTo": "example",
      "customer": {
        "entityId": 0,
        "company": "example",
        "customerGroupId": 0,
        "customerGroupName": "example",
        "email": "example",
        "firstName": "example",
        "lastName": "example",
        "notes": "example",
        "phone": "example",
        "taxExemptCategory": "example"
      },
      "cart": {
        "id": "example",
        "entityId": "example",
        "currencyCode": "example",
        "displayCurrencyCode": "example",
        "isTaxIncluded": true,
        "baseAmount": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        },
        "baseAmountInDisplayCurrency": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        },
        "discountedAmount": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        },
        "discountedAmountInDisplayCurrency": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        },
        "amount": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        }
      },
      "customerAccessToken": {
        "value": "example",
        "expiresAt": "2026-10-30T22:30:40.754Z"
      }
    }
  }
}

Arguments

jwtStringRequired

Customer Login JWT, for more information: https://developer.bigcommerce.com/docs/start/authentication/customer-login.

guestCartEntityIdStringOptional

The guest cart entity Id which should be assigned.

Returns

a LoginWithCustomerLoginJwtResult

redirectToString

The URL to redirect to after login.

customerCustomerOptional

The currently logged in customer.

cartCartOptional

The cart that is assigned to the customer after login.

customerAccessTokenCustomerAccessTokenOptional

The customer access token. This field can only be fetched in server-to-server context.