Get a list of categories visible to this user.
GET
/me/categories
200Description
Only available to Buyer Users.
Parameters
Name | Type | Description | Possible Values | |
---|---|---|---|---|
depth | string | Indicates 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. | --- | |
catalogID | string | The 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. | --- | |
productID | string | ID of the product. | --- | |
search | string | Word or phrase to search for. | --- | |
searchOn | array | Comma-delimited list of fields to search on. | ID, Name, Description | |
sortBy | array | Comma-delimited list of fields to sort by. | ID, Name, !ID, !Name | |
page | integer | Page 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. | --- | |
pageSize | integer | Number of results to return per page. Default: 20, max: 100. | --- | |
filters | object | An 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
Property | Type | Format | Max Length | Possible Values | ||
---|---|---|---|---|---|---|
Items | array | --- | --- | --- | ||
Meta | object | --- | --- | --- | ||