B2B Edition
B2B Edition APIs
Server to Server Management APIs
Authentication

Authentication

API auth manage

Get Server to Server Tokens

POST /auth/backend

Request

Get Server to Server Tokens.

Administrators are the only role allowed to create API tokens.

Authentication

  • authToken in header

Body

object | application/json

  • storeHash    string
    required

    Your store unique store_hash
    >= 1 characters

  • password    string
    required

    You can use the backend user password to log into the B2B Edition APP.
    >= 1 characters

  • name    string
    required

    The token name, if you want to specify it.

example-1

Response

OK

Body

object | application/json

  • code    number
    required

  • data    array[object]
    required

  • meta    object
    required

example-1

Delete Backend API Tokens

DELETE /auth/backend

Request

Delete backend API tokens.

Authentication

  • authToken in header

Body

object | application/json

  • name    string

    The token name, which will be used as a query parameter.

  • id    integer
    required

    Token ID

example

Response

OK

Body

object | application/json
Response for successful request

  • code    integer

    Response code of success request.
    Example: 200

  • meta    object

  • data    array[]

example-1

Get All Server to Server Tokens

GET /backend/tokens

Request

Get all Server to Server tokens

Authentication

  • authToken in header

Parameters

  • limit in query with default of 10 - integer
    Pagination limit
  • offset in query0 - integer
    Pagination offset

example

Response

OK

Body

object | application/json

  • code    integer

  • data    array[object]

  • meta    object

example-1

Get a Storefront API authToken

GET /auth/storefront

Request

Get a storefront API authToken

Authentication

  • authToken in header

Parameters

  • jwtToken in query - string
    required
    BC JWT token
  • channelId in query - string
    The BigCommerce channel ID. Do not use this parameter if you do not have an opened multi-storefront.

example

Response

OK

Body

object | application/json

  • code    number
    required

  • data    object
    required

  • meta    object
    required

example-1

Get Storefront authToken with Credentials

POST /auth/customers

Request

BigCommerce customer gets an authentication token

Authentication

  • authToken in header

Body

object | application/json

  • storeHash    string
    required

    Your store unique store_hash
    >= 1 characters

  • password    string
    required

    BC customer password
    >= 1 characters

  • channelId    number
    required

    BigCommerce channel ID

  • name    string
    required

    The token name, if you want to specify it.
    >= 1 characters

example-1

Response

OK

Body

object | application/json

  • code    number
    required

  • data    object
    required

  • meta    object
    required

example-1

Get a B2B Storefront Token

POST /auth/customers/storefront

Request

Get B2B storefront token by v3 io token

Authentication

  • authToken in header

Body

object | application/json

  • customerId    integer
    required

    BigCommerce customer ID

  • channelId    integer

    BigCommerce channel ID

  • customerAccessToken    object

    BigCommerce Customer Access Token

Example 1

Response

OK

Body

object | application/json

  • code    number

  • data    object

  • meta    object

Example 1

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
Get Address Extra Field ConfigsGet Server to Server Tokens