Docs
Catalog API
Products
Channel Assignments

Channel assignments

Get Products Channel Assignments

GET /catalog/products/channel-assignments

Request

Returns a list of products channel assignments.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query with default of 50 - integer

    Controls the number of items per page in a limited (paginated) list of products.

  • product_id:in in query - array
    Pass a comma-separated list to filter by one or more product IDs.
    Type: array[integer]
  • channel_id:in in query - array
    Pass a comma-separated list to filter by one or more channel IDs.
    Type: array[integer]

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/channel-assignments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Collection of channel assignments.

Body

object | application/json

  • data    array[object]

  • meta    object

example

{
"data": [
{
"product_id": 0,
"channel_id": 0
}
],
"meta": {
"pagination": {
"total": 246,
"count": 5,
"per_page": 5,
"current_page": 1,
"total_pages": 50,
"links": {
"previous": "?limit=50&page=1",
"current": "?limit=50&page=1",
"next": "?limit=50&page=2"
}
}
}
}

Create Products Channel Assignments

PUT /catalog/products/channel-assignments

Request

Creates products channel assignments.

Notes:

  • Avoid parallel assignment requests if possible.
  • Do not make parallel assignment requests with the same product IDs.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

array | application/json

  • product_id    integer

  • channel_id    integer

example

[
{
"product_id": 0,
"channel_id": 0
}
]

Response

Updated

Delete Products Channel Assignments

DELETE /catalog/products/channel-assignments

Request

Delete products channel assignments. A filter must be supplied.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • product_id:in in query - array
    Pass a comma-separated list to filter by one or more product IDs.
    Type: array[integer]
  • channel_id:in in query - array
    Pass a comma-separated list to filter by one or more channel IDs.
    Type: array[integer]

example

curl --request DELETE \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/channel-assignments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Deleted
Did you find what you were looking for?
Delete Products Category AssignmentsGet Products Channel Assignments