List Channels

GET

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

GET

/api/v3/io/channels

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

{
  "code": 200,
  "data": [
    {
      "id": 101,
      "channelId": 55,
      "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-main.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": 1700040600,
      "updatedAt": 1716223500
    },
    {
      "id": 102,
      "channelId": 56,
      "channelName": "Wholesale Channel",
      "type": "storefront",
      "platform": "bigcommerce",
      "status": "active",
      "site": "https://wholesale.example.com",
      "isVisible": true,
      "isEnabled": true,
      "iconUrl": "https://cdn.bigcommerce.com/icons/storefront-wholesale.png",
      "b2bEnabled": true,
      "allowGlobalLogins": true,
      "storeLogo": {
        "url": "https://cdn.example.com/logos/default.png"
      },
      "homeRoute": "/",
      "loginRoute": "/login.php",
      "forgotPasswordRoute": "/login.php?action=reset_password",
      "createdAt": 1701432000,
      "updatedAt": 1716042000
    }
  ],
  "meta": {
    "message": "SUCCESS"
  }
}

Returns all enabled channels for the current store. Analogous to Get All Channels 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.

Response

SUCCESS

codeintegerOptionalDefaults to 200

datalist of objectsOptional

metaobjectOptional

Errors

422

Unprocessable Entity Error