v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB

Get Product Category

Retrieves the name and details of a category that appears on the storefront.

get/commerce/catalog/storefront/categories/{categoryId}

Path parameters

categoryIdinteger required

Required. Unique identifier of the category whose details you want to get.

Query parameters

allowInactiveboolean

Optional. Allow the return of items with the IsDisplayed flag set to false.

includeAttributesboolean

Optional. If True, Return Category Attributes collection with Category

responseFieldsstring

limits which fields are returned in the response body

Response

categoryCodestring nullable

External unique identifier of the category.

categoryIdinteger

Internal unique identifier of the category. System-supplied and read-only.

childrenCategoriesobject[] nullable

List of subcategories that belong to this category.

countinteger nullable

Indicates whether the category should be displayed.

isDisplayedboolean

Indicates whether the category should be displayed.

parentCategoryobject

sequenceinteger nullable

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).

shouldSliceboolean

Indicates whether the category should be sliced

updateDatestring date-time

Last Modified Date Time