Docs
Catalog API
Category Assignments

Category assignments

Get Products Category Assignments

GET /catalog/products/category-assignments

Request

Returns a list of products category assignments.

Authentication

  • X-Auth-Token in header
    required

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.

    Type: array[integer]

  • category_id:in in query - array

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

    Type: array[integer]

example

Response

Collection of category assignments.

Body

object | application/json
  • data
    array[object]

  • meta
    object

example

Create Products Category Assignments

PUT /catalog/products/category-assignments

Request

Creates products category 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

  • category_id
    integer

example

Response

Updated

Delete Products Category Assignments

DELETE /catalog/products/category-assignments

Request

Deletes products category assignments. A filter must be supplied.

Authentication

  • X-Auth-Token in header
    required

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.

    Type: array[integer]

  • category_id:in in query - array

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

    Type: array[integer]

example

Response

Deleted

Did you find what you were looking for?