Catalog - Products
Get Products Channel Assignments
GET /stores/{store_hash}/v3/catalog/products/channel-assignments
Request
Returns a list of products channel assignments.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- 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.
- channel_id:in in query - array
Pass a comma-separated list to filter by one or more channel IDs.
example
Response
Collection of channel assignments.
Body
dataarray[]
metaobject
example
Create Products Channel Assignments
PUT /stores/{store_hash}/v3/catalog/products/channel-assignments
Request
Creates products channel assignments.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
product_idinteger
channel_idinteger
example
Response
Updated
Delete Products Channel Assignments
DELETE /stores/{store_hash}/v3/catalog/products/channel-assignments
Request
Delete products channel assignments. A filter must be supplied.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- product_id:in in query - array
Pass a comma-separated list to filter by one or more product IDs.
- channel_id:in in query - array
Pass a comma-separated list to filter by one or more channel IDs.
example
Response
Deleted