login | BigCommerce Developer Center

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
    }
  }
}

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

{
  "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": "DateTime"
      }
    }
  }
}

Customer login.

Returns

an Object

Arguments

Returns