Appearance
GET
/product-category-property/property-keys/{propertyKeyId}/product-categoriesRequired scope:
productcategory:readReturns the product categories that have a value for the given property key, together with their value(s), ordered by category identifier. Paging is per category. The response does not contain a total count; use page.hasMore to determine whether another page exists. Translations and media URLs are not included.
Parameters
Path parameters
propertyKeyId integerThe unique identifier of the property key.
Query parameters
page integerThe page number to retrieve. The first page is 1. Cannot be less than 1.
Default value:
1pageSize integerThe size of the pages to retrieve. The default is 10. Cannot be less than 1 and larger than 100.
Default value:
10Response
The response contains a page of product categories and their values.
JSON
{
"page": {
"page": 1,
"pageSize": 100,
"hasMore": true
},
"hits": [
{
"categoryId": 101,
"propertyValue": {
"propertyValueId": 1,
"value": "Red"
},
"propertyValues": [
{
"propertyValueId": 1,
"value": "Red"
}
]
}
]
}
| Error code | Description |
|---|---|
invalid-page | The given page is invalid. |
invalid-page-size | The given page size is invalid. |
property-key-not-found | The property key was not found. |