BigCommerce

BigCommerce Login Token API

The Login Token API from BigCommerce — 1 operation(s) for login token.

Documentation GitHub OpenAPI

Documentation

https://developer.bigcommerce.com/

https://developer.bigcommerce.com/docs/rest-management/abandoned-carts

https://developer.bigcommerce.com/docs/rest-management/carts

https://developer.bigcommerce.com/docs/rest-catalog/brands

https://developer.bigcommerce.com/docs/rest-catalog/categories

https://developer.bigcommerce.com/docs/rest-catalog/category-trees

https://developer.bigcommerce.com/docs/rest-catalog/product-modifiers

https://developer.bigcommerce.com/docs/rest-catalog/product-variant-options

https://developer.bigcommerce.com/docs/rest-catalog/product-variants

https://developer.bigcommerce.com/docs/rest-catalog/products

https://developer.bigcommerce.com/docs/rest-management/channels

https://developer.bigcommerce.com/docs/rest-management/checkouts

https://developer.bigcommerce.com/docs/rest-content/store-content

https://developer.bigcommerce.com/docs/rest-management/currencies

https://developer.bigcommerce.com/docs/rest-management/customers

https://developer.bigcommerce.com/docs/rest-content/email-templates

https://developer.bigcommerce.com/docs/rest-management/geography

https://developer.bigcommerce.com/docs/rest-management/orders

https://developer.bigcommerce.com/docs/rest-content/pages

https://developer.bigcommerce.com/docs/rest-payments/tokens

https://developer.bigcommerce.com/docs/rest-payments/methods-deprecated

https://developer.bigcommerce.com/docs/rest-payments/processing

https://developer.bigcommerce.com/docs/rest-management/settings

https://developer.bigcommerce.com/docs/rest-management/shipping-v2

https://developer.bigcommerce.com/docs/rest-management/channels/site

https://developer.bigcommerce.com/docs/rest-management/store-information

https://developer.bigcommerce.com/docs/rest-storefront/carts

https://developer.bigcommerce.com/docs/rest-storefront/checkouts

https://developer.bigcommerce.com/docs/rest-storefront/customers

https://developer.bigcommerce.com/docs/rest-storefront/orders

https://developer.bigcommerce.com/docs/rest-storefront/subscriptions

https://developer.bigcommerce.com/docs/integrations/webhooks

https://developer.bigcommerce.com/docs/rest-content/widgets

Specifications

https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/openapi/bigcommerce-login-token-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/asyncapi/bigcommerce-webhooks-asyncapi.yml

Other Resources

https://raw.githubusercontent.com/api-evangelist/bigcommerce/refs/heads/main/graphql/bigcommerce-graphql.md

OpenAPI Specification

openapi: 3.0.0
info:
  title: BigCommerce Abandoned Cart Emails Login Token API
  version: 3.0.0
  termsOfService: https://www.bigcommerce.com/terms
  description: Abandoned Cart Emails V3 API managing Handlebars-based emails.
  contact:
    name: BigCommerce
    url: https://www.bigcommerce.com
    email: support@bigcommerce.com
servers:
- url: https://api.bigcommerce.com/stores/{store_hash}/v3
  variables:
    store_hash:
      default: store_hash
      description: Permanent ID of the BigCommerce store.
  description: BigCommerce API Gateway
security:
- X-Auth-Token: []
tags:
- name: Login Token
paths:
  /login/token/{jwt_token}:
    get:
      tags:
      - Login Token
      summary: BigCommerce Login Token
      operationId: getCustomerLogin
      description: 'The customer login access point URL.


        [Learn more about the Customer Login API](/docs/start/authentication/customer-login).


        ## Example


        ```

        https://yourstore.example.com/login/token/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ7Y2xpZW50X2lkfSIsImlhdCI6MTUzNTM5MzExMywianRpIjoie3V1aWR9Iiwib3BlcmF0aW9uIjoiY3VzdG9tZXJfbG9naW4iLCJzdG9yZV9oYXNoIjoie3N0b3JlX2hhc2h9IiwiY3VzdG9tZXJfaWQiOjJ9.J-fAtbjRFGdLsT744DhoprFEDqIfVq72HbDzrbFy6Is

        ```'
      parameters:
      - name: jwt_token
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
components:
  securitySchemes:
    X-Auth-Token:
      name: X-Auth-Token
      description: '### OAuth scopes


        | UI Name | Permission | Parameter |

        |:--|:--|:-|

        | Information & Settings  | read-only  | `store_v2_information_read_only`|

        | Information & Settings  | modify     | `store_v2_information`          |


        ### Authentication header


        | Header | Argument | Description |

        |:-|:|:|

        | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). |


        ### Further reading


        For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests).


        For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes).


        For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).'
      type: apiKey
      in: header