Skip to navigation
RESTAdminCatalogProductsChannel Assignments

List Products Channel Assignments

Returns a list of products channel assignments.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Productsmodifystore_v2_products
Productsread-onlystore_v2_products_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

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.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

pageintegerOptional

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

limitintegerOptional<=250Defaults to 50

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

product_id:inlist of integersOptional

Pass a comma-separated list to filter by one or more product IDs.

channel_id:inlist of integersOptional

Pass a comma-separated list to filter by one or more channel IDs.

Response

Collection of channel assignments.
datalist of objectsOptional
metaobjectOptional