List Channels

GET

https://api.bigcommerce.com/stores/:store_hash/v3/channels

GET

/stores/:store_hash/v3/channels

curl -G https://api.bigcommerce.com/stores/store_hash/v3/channels \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     --data-urlencode "platform:in=facebook by meta,amazon"

{
  "data": [
    {
      "id": 1,
      "name": "Test Store",
      "external_id": "",
      "is_listable_from_ui": true,
      "is_visible": true,
      "status": "prelaunch",
      "type": "storefront",
      "platform": "bigcommerce",
      "date_created": "2021-05-07T14:54:51Z",
      "date_modified": "2021-05-07T14:54:51Z",
      "icon_url": "https://storage.googleapis.com/bigcommerce-production-dev-center/images/bigcommerce_icon.svg"
    },
    {
      "id": 664179,
      "name": "Amazon",
      "external_id": "",
      "is_listable_from_ui": true,
      "is_visible": true,
      "status": "connected",
      "type": "marketplace",
      "platform": "amazon",
      "date_created": "2021-05-10T20:32:40Z",
      "date_modified": "2021-05-13T14:25:54Z",
      "icon_url": "https://storage.googleapis.com/bigcommerce-production-dev-center/images/amazon_icon.svg"
    },
    {
      "id": 667159,
      "name": "Facebook by Meta",
      "external_id": "",
      "is_listable_from_ui": false,
      "is_visible": true,
      "status": "connected",
      "type": "marketplace",
      "platform": "facebook by meta",
      "date_created": "2021-05-13T15:41:39Z",
      "date_modified": "2021-05-13T15:41:39Z",
      "icon_url": "https://storage.googleapis.com/bigcommerce-production-dev-center/images/facebook_icon.svg"
    }
  ],
  "meta": {
    "pagination": {
      "per_page": 2,
      "total": 8,
      "count": 2,
      "total_pages": 4,
      "current_page": 2,
      "links": {
        "previous": "?page=1&limit=2",
        "current": "?page=2&limit=2",
        "next": "?page=3&limit=2"
      }
    }
  }
}

Returns a list of Channels.

Will always return the default BigCommerce storefront with an ID of 1. This storefront is created by default when you provision a BigCommerce store.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Channel Listings	modify	`store_channel_listings`
Channel Listings	read-only	`store_channel_listings_read_only`
Channel Settings	modify	`store_channel_settings`
Channel Settings	read-only	`store_channel_settings_read_only`
Sites & Routes	modify	`store_sites`
Sites & Routes	read-only	`store_sites_read_only`

Authentication header

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

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

includeenumOptional

Channels subresources that can be included in the response.

Allowed values:

availablebooleanOptional

Filter items based on whether the channel is currently available for integration. Setting this query parameter to true will return channels with the status of prelaunch, active , inactive, and connected. Setting this query parameter to false will return channels with the status of disconnected, archived, deleted, and terminated.

status:inlist of enumsOptional

Filter items by a comma-separated list of statuses.

type:inlist of enumsOptional

Filter items by a comma-separated list of types.

Allowed values:

platform:inlist of stringsOptional

Filter items by a comma-separated list of platforms. For a list of supported platforms, see Platform.

date_createdstringOptional

Filter items by date created. For example, date_created=2024-05-14T09:34:00 or date_created=2024-05-14.

date_created:minstringOptional

Filter items by minimum date created. For example, date_created=2024-05-14T09:34:00 or date_created=2024-05-14. Returns metafields created after this date.

date_created:maxstringOptional

Filter items by maximum date created. For example, date_created=2024-05-14T09:34:00 or date_created=2024-05-14. Returns metafields created before this date.

date_modifiedstringOptional

Filter items by date modified. For example, date_created=2024-05-14T09:34:00 or date_created=2024-05-14.

date_modified:minstringOptional

Filter items by minimum date modified. For example, date_created=2024-05-14T09:34:00 or date_created=2024-05-14. Returns metafields modified after this date.

date_modified:maxstringOptional

Filter items by maximum date modified. For example, date_created=2024-05-14T09:34:00 or date_created=2024-05-14. Returns metafields modified before this date.

limitintegerOptional

Controls the number of items per page for paginated responses.

pageintegerOptional

Specifies the page number for a paginated response.

Response

A list of channels.

datalist of objects

metaobject

Data about the response, including pagination.

Errors

422

Unprocessable Entity Error