Get Channel Details by Channel ID

GET

https://api-b2b.bigcommerce.com/api/v3/io/channels/:channel_id

GET

/api/v3/io/channels/:channel_id

curl https://api-b2b.bigcommerce.com/api/v3/io/channels/1 \
     -H "X-Auth-Token: <apiKey>"

{
  "code": 200,
  "data": {
    "id": 42,
    "channelId": 1,
    "channelName": "Main Storefront",
    "type": "storefront",
    "platform": "bigcommerce",
    "status": "active",
    "site": "https://store.example.com",
    "isVisible": true,
    "isEnabled": true,
    "iconUrl": "https://cdn.bigcommerce.com/icons/storefront.png",
    "b2bEnabled": true,
    "allowGlobalLogins": false,
    "storeLogo": {
      "url": "https://cdn.example.com/logos/default.png"
    },
    "homeRoute": "/",
    "loginRoute": "/login.php",
    "forgotPasswordRoute": "/login.php?action=reset_password",
    "createdAt": 1714564800,
    "updatedAt": 1718033400
  },
  "meta": {
    "message": "SUCCESS"
  }
}

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

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

channel_idintegerRequired

The unique BigCommerce channel ID.

Response

SUCCESS

codeintegerOptionalDefaults to 200

dataobjectOptional

A BigCommerce store channel object

metaobjectOptional

Errors

404

Not Found Error

422

Unprocessable Entity Error