login

Example Query

mutation ExampleMutation($email: String!, $password: String!, $guestCartEntityId: String) {
  login(email: $email, password: $password, guestCartEntityId: $guestCartEntityId) {
    result
    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

{
  "email": "example",
  "password": "example",
  "guestCartEntityId": "example"
}

Example response

{
  "data": {
    "login": {
      "result": "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-14T04:25:23.537Z"
      }
    }
  }
}

Customer login.

Arguments

emailStringRequired

An email of the customer.

passwordStringRequired

A password of the customer.

guestCartEntityIdStringOptional

The guest cart entity ID which should be assigned to customer.

Returns

a LoginResult

resultStringDeprecated

The result of a login

Deprecated: Use customer node instead.

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.