exchangeExternalCustomerToken mutation

The exchangeExternalCustomerToken mutation provides the capability for social login authentication using App Builder. With integration token credentials, it allows a shopper to log in. If the shopper does not have an account, the mutation creates one.. It returns a customer authentication token.

This mutation requires that an integration with the external authenticating system be configured and implemented. Adobe Commerce supports OAuth 1.0. Your calls must supply the following information:

• Consumer key
• Consumer secret
• Access token
• Token secret

You can view these values in the Admin at System > Integrations.

Syntax

mutation: {exchangeExternalCustomerToken(input: ExchangeExternalCustomerTokenInput!) {ExchangeExternalCustomerTokenOutput}}

Example usage

The following call creates a new customer if does not exist and returns the customer token.

Request:

Copy
mutation {
    exchangeExternalCustomerToken(
        input: {
            customer: {
                firstname: "Roni"
                lastname: "Cost"
                email: "roni_cost@example.com"
                is_subscribed: false
            }
        }
    ) {
        customer {
            email
            firstname
            lastname
            is_subscribed
        }
        token
    }
}
Copied to your clipboard
mutation {
    exchangeExternalCustomerToken(
        input: {
            customer: {
                firstname: "Roni"
                lastname: "Cost"
                email: "roni_cost@example.com"
                is_subscribed: false
            }
        }
    ) {
        customer {
            email
            firstname
            lastname
            is_subscribed
        }
        token
    }
}

Response:

Copy
{
  "data": {
    "exchangeExternalCustomerToken": {
      "customer": {
        "email": "roni_cost@example.com",
        "firstname": "Roni",
        "lastname": "Cost",
        "is_subscribed": false
      },
      "token": "eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjYsInV0eXBpZCI6MywiaWF0IjoxNzQ4NDk5NDIxLCJleHAiOjE3NDg1MDMwMjF9.hDPDh41C4KOHloM2xlUYJ0asCqunQHCELG-3x_IsIZo"
    }
  }
}
Copied to your clipboard
{
  "data": {
    "exchangeExternalCustomerToken": {
      "customer": {
        "email": "roni_cost@example.com",
        "firstname": "Roni",
        "lastname": "Cost",
        "is_subscribed": false
      },
      "token": "eyJraWQiOiIxIiwiYWxnIjoiSFMyNTYifQ.eyJ1aWQiOjYsInV0eXBpZCI6MywiaWF0IjoxNzQ4NDk5NDIxLCJleHAiOjE3NDg1MDMwMjF9.hDPDh41C4KOHloM2xlUYJ0asCqunQHCELG-3x_IsIZo"
    }
  }
}

Errors

Related topic

• customer query

Last updated 6/4/2025

Was this helpful?

Yes

No