Thanks for being patient while we implement your feedback to improve the developer experience.

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

example

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

Response

Collection of category assignments.

Body

object | application/json

  • data    array[]

  • meta    object

example

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

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

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

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
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

  • product_id:in in query - string
  • category_id:in in query - string

example

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

Response

Deleted