listItemsInCategory( )

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.
Method Declaration
Copy
Method Parameters
categoryIdstringRequired

Category ID.

treeReferenceTreeReferenceRequired

Category tree reference details.

optionsListItemsInCategoryOptions
Returns
Return Type:Promise<ListItemsInCategoryResponse>
Was this helpful?
Yes
No