BigCommerce
Storefront Authentication
Customer Impersonation Token

Storefront Token

Create a Token

POST /storefront/api-token-customer-impersonation

Request

Returns a Storefront API token that allows your application to impersonate customers when making GraphQL POST requests. For more information on how to use the returned token, see customer impersonation tokens.

Required Scopes

  • Manage Storefront API Customer Impersonation Tokens

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string - required

    The MIME type of the request body.

Body

object | application/json
  • channel_id
    integer
    required

    Channel ID for requested token

    Example: 1

  • expires_at
    integer
    required

    Unix timestamp (UTC time) defining when the token should expire. Supports seconds, but does not support milliseconds, microseconds, or nanoseconds.

    Example: 1885635176

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?