A valid request URL is required to generate request examples{
"startIndex": 123,
"pageSize": 123,
"pageCount": 123,
"totalCount": 123,
"items": [
{
"id": 123,
"categoryType": "<string>",
"catalogId": 123,
"parentCategoryId": 123,
"parentCategoryCode": "<string>",
"parentCategoryName": "<string>",
"parentIsActive": true,
"categoryCode": "<string>",
"isActive": true,
"isDisplayed": true,
"sequence": 123,
"content": {
"categoryImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123
}
],
"name": "<string>",
"description": "<string>",
"pageTitle": "<string>",
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"slug": "<string>"
},
"localizedContent": [
{
"categoryImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123
}
],
"name": "<string>",
"description": "<string>",
"pageTitle": "<string>",
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"slug": "<string>"
}
],
"dynamicExpression": {
"text": "<string>",
"tree": {
"type": "<string>",
"logicalOperator": "<string>",
"nodes": "<array>",
"left": "<string>",
"operator": "<string>",
"right": "<unknown>"
}
},
"productCount": 123,
"childCount": 123,
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"shouldSlice": true,
"activeDateStart": "2023-11-07T05:31:56Z",
"activeDateEnd": "2023-11-07T05:31:56Z",
"attributes": [
{
"fullyQualifiedName": "<string>",
"attributeDefinitionId": 123,
"values": [
"<unknown>"
]
}
]
}
]
}Retrieves a list of categories according to any specified filter criteria and sort options for attributes. This current version of the Categories API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access category data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”.
A valid request URL is required to generate request examples{
"startIndex": 123,
"pageSize": 123,
"pageCount": 123,
"totalCount": 123,
"items": [
{
"id": 123,
"categoryType": "<string>",
"catalogId": 123,
"parentCategoryId": 123,
"parentCategoryCode": "<string>",
"parentCategoryName": "<string>",
"parentIsActive": true,
"categoryCode": "<string>",
"isActive": true,
"isDisplayed": true,
"sequence": 123,
"content": {
"categoryImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123
}
],
"name": "<string>",
"description": "<string>",
"pageTitle": "<string>",
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"slug": "<string>"
},
"localizedContent": [
{
"categoryImages": [
{
"id": 123,
"localeCode": "<string>",
"imageLabel": "<string>",
"altText": "<string>",
"imageUrl": "<string>",
"cmsId": "<string>",
"videoUrl": "<string>",
"mediaType": "<string>",
"sequence": 123
}
],
"name": "<string>",
"description": "<string>",
"pageTitle": "<string>",
"localeCode": "<string>",
"metaTagTitle": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"slug": "<string>"
}
],
"dynamicExpression": {
"text": "<string>",
"tree": {
"type": "<string>",
"logicalOperator": "<string>",
"nodes": "<array>",
"left": "<string>",
"operator": "<string>",
"right": "<unknown>"
}
},
"productCount": 123,
"childCount": 123,
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"shouldSlice": true,
"activeDateStart": "2023-11-07T05:31:56Z",
"activeDateEnd": "2023-11-07T05:31:56Z",
"attributes": [
{
"fullyQualifiedName": "<string>",
"attributeDefinitionId": 123,
"values": [
"<unknown>"
]
}
]
}
]
}JWT Authorization header using the Bearer scheme.
limits which fields are returned in the response body