Storefront APIs
Authentication

Authentication

Storefront authentication for the BigCommerce B2B Edition API

Get Storefront authToken within Stencil

POST /v2/login

Request

Get a storefront authToken. You need a BigCommerce Current Customer JWT to make the request. See the B2B Edition Authentication article for more details.

Equivalent Storefront GraphQL API Mutation: authorization. For more information, see the GraphQL Playground.

Body

object | application/json
  • bcToken
    string
    required

    BigCommerce JWT token
  • customerId
    integer

    Customer ID
  • storeHash
    string

    Store Hash
  • channelId
    integer

    BigCommerce channel ID

example-1

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

Get a Storefront authToken for a Specific Customer

POST /io/auth/customers

Request

Get an authentication token for a specific BigCommerce customer.

Equivalent Storefront GraphQL API Mutation: login. For more information, see the GraphQL Playground.

Body

object | application/json
  • storeHash
    string
    required

    >= 1 characters
  • password
    string
    required

    BigCommerce customer password
    >= 1 characters
  • channelId
    number
    required

    Store channel ID
  • name
    string
    required

    >= 1 characters

example-1

Response

OK

Body

object | application/json
  • code
    number
    required

  • data
    object
    required

  • meta
    object
    required

example-1

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?