Skip to content

DEVDOCS-6349 - Update Product Sort Order usage notes for Featured Items page sort #1019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DEVDOCS-6349 - Update Product Sort Order usage notes for Featured Items page sort #1019

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions reference/catalog/categories_catalog.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1432,16 +1432,20 @@ paths:
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.

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

**Usage Notes**

* Product sort order only takes effect on the storefront when sorting by **Featured Items** in the category. See [Sort Order](https://support.bigcommerce.com/s/article/Sort-Order) for more information.
* 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).
* 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).

operationId: getCategorySortOrders
responses:
'200':
Expand Down Expand Up @@ -2072,7 +2076,7 @@ components:
minimum: 0
type: integer
example: 4
description: The relative priority of the product among other products inside the category.
description: The relative priority of the product among other products inside the category.
x-internal: false
Category:
x-tags:
Expand Down