POST

List Items In Category


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 items from a single category, given the provided cursor paging.

List Items In Categories defaults to sorting by the time the item was added to the category, in descending order.

Permissions
Read categories
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/categories/v1/categories/{categoryId}/list-items

Path Params
categoryIdstringRequired

Category ID.

Body Params
treeReferenceTreeReferenceRequired

Category tree reference details.


useCategoryArrangementboolean

Whether to use category arrangement for sorting items.

Default: false


includeItemsFromSubcategoriesboolean

Whether to include items from subcategories.

Default: false (only direct items of the category will be returned)


cursorPagingCursorPaging

Cursor paging options.

Learn more about cursor paging.

Response Object
itemsArray <ItemReference>maxItems 100

List of items in the category.


pagingMetadataPagingMetadata

Paging metadata.

List items in category

Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?