BigCommerce
Catalog API
Channel Assignments

Catalog - Products

Get Products Channel Assignments

GET /catalog/products/channel-assignments

Request

Returns a list of products channel assignments.

Authentication

  • X-Auth-Token in header - required

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
  • limit in query - integer
  • product_id:in in query - string
  • channel_id:in in query - string

example

Response

Collection of channel assignments.

Body

object | application/json
  • data
    array[]

  • meta
    object

example

Create Products Channel Assignments

PUT /catalog/products/channel-assignments

Request

Creates products channel assignments.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • 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

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 - required

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 - string
  • channel_id:in in query - string

example

Response

Deleted

Did you find what you were looking for?