Docs
Catalog API
Categories
Sort Order

Sort order

Get Product Sort Order

GET /catalog/categories/{category_id}/products/sort-order

Request

Returns a list of products and their sort order for a specific category.

Limits

  • page=2&limit=250 will return page 2 of the results with 250 items per page.

Usage Notes

  • Data pairs are displayed in ascending order based on products' sort_order values.
  • null values are allowed for products without specified sort_order values.
  • Products with sort_order value of null will be displayed after products with valid numerical values.
  • The priorities for determining product sort order on a storefront are the following:
    • Priority 1: Manually specified sort order on Category Level (API).
    • Priority 2: Manually specified sort order on Product (Global) Level (UI/API).
    • Priority 3: Default sorting by Product ID (newly added products go first) (UI/API).

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • category_id in path - integer
    required

    The ID of the Category to which the resource belongs.

  • page in query - integer

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

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/categories/[category_id]/products/sort-order' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

{
"data": [
{
"product_id": 99,
"sort_order": 4
}
],
"meta": {
"pagination": {
"total": 36,
"count": 36,
"per_page": 50,
"current_page": 1,
"total_pages": 1,
"links": {
"previous": "string",
"current": "?page=1&limit=50",
"next": "string"
}
}
}
}

Update Product Sort Order

PUT /catalog/categories/{category_id}/products/sort-order

Request

Updates sort order of products within a specific category.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • category_id in path - integer
    required

    The ID of the Category to which the resource belongs.

  • page in query - integer

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

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

    The ID of the associated product.
    Min: 1
    Example: 99

  • sort_order    integer
    required

    Min: 0
    Example: 4

example

[
{
"product_id": 99,
"sort_order": 4
}
]

Response

Body

array | application/json

  • product_id    integer
    required

    The ID of the associated product.
    Min: 1
    Example: 99

  • sort_order    integer
    required

    Min: 0
    Example: 4

example

[
{
"product_id": 99,
"sort_order": 4
}
]
Did you find what you were looking for?
Delete a Category MetafieldGet Product Sort Order