Sitecore OrderCloud Documentation


Portal login

Get a list of categories visible to this user.





Only available to Buyer Users.


At least one of the roles below is required to access this endpoint.



NameTypeDescriptionPossible Values
depthstringIndicates how deep down the hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to ParentID if specified. Default is 1.---
catalogIDstringThe user’s default CatalogID will be used to return categories if you do not pass another CatalogID explicitly. Listing categories across multiple catalogs is not supported.---
productIDstringID of the product.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Description
sortByarrayComma-delimited list of fields to sort by.ID, Name, !ID, !Name
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy