Skip to Content
B2b EditionB2B Edition APIsServer to Server Management APIsChannelChannelsChannels

Channels

Get all Channels

GET /channels

Request

Returns all enabled channels for the current store. Analogous to Get All Channels in the BigCommerce API.

Authentication

  • X-Auth-Token in header

Parameters

  • X-Store-Hash in header - string
    required
    The unique store hash associated with a BigCommerce store that has B2B Edition enabled.
    Example: abc123

example

Response

SUCCESS

Body

object | application/json

  • code    integer

    Default: 200

  • data    array[object]

  • meta    object

example

Get Channel Details by channel ID

GET /channels/{channel_id}

Request

Returns data for the specific channel associated with channel_id. Analogous to Get A Channel in the BigCommerce API.

Authentication

  • X-Auth-Token in header

Parameters

  • X-Store-Hash in header - string
    required
    The unique store hash associated with a BigCommerce store that has B2B Edition enabled.
    Example: abc123
  • channel_id in path - integer
    required
    The unique BigCommerce channel ID.

example

Response

SUCCESS

Body

object | application/json

  • code    integer

    Default: 200

  • data    object

    A BigCommerce store channel object

  • meta    object

example

Did you find what you were looking for?
ChannelCompany