Server to Server Management APIs
Channel

Channel

Related with BigCommerce store channels. Only support 'bigcommerce' platform and 'storefront' type.

Get Store Channels

GET /channels

Request

Get store channels

Authentication

  • authToken in header

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/channels \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'

Response

OK

Body

object | application/json
  • code
    number

  • data
    array[object]

  • meta
    object

example-1

{
"code": 200,
"data": [
{
"id": 1,
"channelId": 1,
"channelName": "msf2",
"createdAt": 1645582457,
"updatedAt": 1645582457,
"type": "storefront",
"platform": "bigcommerce",
"status": "active",
"site": "https://msfbeta2.mybigcommerce.com",
"isVisible": true,
"isEnabled": true
}
],
"meta": {
"message": "SUCCESS"
}
}

Get a Store Channel

GET /channels/{channelId}

Request

Get a store channel

Authentication

  • authToken in header

Parameters

  • channelId in path - number
    required
    BigCommerce channel ID

example

curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/channels/[channelId]' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'

Response

OK

Body

object | application/json
  • code
    number

  • data
    object

  • meta
    object

example-1

{
"code": 200,
"data": {
"id": 1,
"channelId": 1,
"channelName": "msf2",
"createdAt": 1645582457,
"updatedAt": 1645582457,
"type": "storefront",
"platform": "bigcommerce",
"status": "active",
"site": "https://msfbeta2.mybigcommerce.com",
"isVisible": true,
"isEnabled": true
},
"meta": {
"message": "SUCCESS"
}
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?