API reference
A valid request URL is required to generate request examples{
"attributes": [
{
"dataType": 123,
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"categoryCode": "<string>",
"categoryId": 123,
"childrenCategories": [
{}
],
"content": {
"categoryImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"description": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"name": "<string>",
"pageTitle": "<string>",
"slug": "<string>"
},
"count": 123,
"isDisplayed": true,
"parentCategory": {},
"sequence": 123,
"shouldSlice": true,
"updateDate": "2023-11-07T05:31:56Z"
}Get Product Category
Retrieves the name and details of a category that appears on the storefront.
A valid request URL is required to generate request examples{
"attributes": [
{
"dataType": 123,
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"categoryCode": "<string>",
"categoryId": 123,
"childrenCategories": [
{}
],
"content": {
"categoryImages": [
{
"altText": "<string>",
"cmsId": "<string>",
"imageLabel": "<string>",
"imageUrl": "<string>",
"mediaType": "<string>",
"sequence": 123,
"videoUrl": "<string>"
}
],
"description": "<string>",
"metaTagDescription": "<string>",
"metaTagKeywords": "<string>",
"metaTagTitle": "<string>",
"name": "<string>",
"pageTitle": "<string>",
"slug": "<string>"
},
"count": 123,
"isDisplayed": true,
"parentCategory": {},
"sequence": 123,
"shouldSlice": true,
"updateDate": "2023-11-07T05:31:56Z"
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Required. Unique identifier of the category whose details you want to get.
Query Parameters
Optional. Allow the return of items with the IsDisplayed flag set to false.
Optional. If True, Return Category Attributes collection with Category
limits which fields are returned in the response body
Response
Success
The category hierarchy of your store as it appears on the storefront. This is the category heirarchy defined with the admin/category resource except for any categories with an IsDisplayed value set to false.
Show child attributes
Show child attributes
External unique identifier of the category.
Internal unique identifier of the category. System-supplied and read-only.
List of subcategories that belong to this category.
Name of the category and optionally, a description, page title, friendly URL, associated images, and any metadata.
Show child attributes
Show child attributes
Indicates whether the category should be displayed.
Indicates whether the category should be displayed.
Order in which categories appear when they are at the same level (siblings). For example, categories can be sequenced so that a specific category always appears first (or last).
Indicates whether the category should be sliced
Last Modified Date Time