commerce/catalog/storefront/categories

Use the Storefront Categories resource to view the product category hierarchy as it appears to shoppers who are browsing the storefront. The hierarchy can be returned as a flat list or as a category tree.

JSON Example

Category Properties

Property	Description
categoryCode	type: string External unique identifier of the category.
categoryId	type: int ID of the relevant category.
childrenCategories	type: list of Mozu.ProductRuntime.Contracts.Category List of the subcategories in the hierarchy for the specified categories.
content	type: categoryContent Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.
categoryContent.categoryImages	type: list of categoryImage Array list of media images associated to a product category. These images may be localized in the language specified by the LocaleCode. Images display with the category on the storefront according to the code and formatting of your site theme. Each image includes the name, alt text, and URL location.
categoryContent.categoryImage.altText	type: string Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding.
categoryContent.categoryImage.cmsId	type: string The identifier of the image in the Kibo eCommerce CMS. Supply a value for either the CMS ID or Image URL parameter.
categoryContent.categoryImage.imageLabel	type: string The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site.
categoryContent.categoryImage.imageUrl	type: string The URL link for the image file associated with a product or category.
categoryContent.categoryImage.mediaType	type: string Type of media specification required to successfully render the image, video, or other media content for products and categories.
categoryContent.categoryImage.sequence	type: int The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories.
categoryContent.categoryImage.videoUrl	type: string The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode.
categoryContent.description	type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.
categoryContent.metaTagDescription	type: string Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content.
categoryContent.metaTagKeywords	type: string Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content.
categoryContent.metaTagTitle	type: string Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content.
categoryContent.name	type: string The user supplied name that appears in Admin. You can use this field for identification purposes.
categoryContent.pageTitle	type: string Title that appears on new product category pages, in the language specified by the `localeCode`.
categoryContent.slug	type: string Slug is used in place of a name, code, or ID to give an SEO, human-friendly URL link for an object, used by categories.
count	type: int The total number of associated items.
isDisplayed	type: bool Indicates if the object is displayed on the storefront. If true, the admin product category is displayed in the store. If false, the category is not displayed.
parentCategory	type: Mozu.ProductRuntime.Contracts.Category If applicable, the parent category in the hierarchy for the specified category.
sequence	type: int The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories.

Operations

Operation Name	Request URI	Description
GetCategories	GET %3ffilter%3d%7bfilter%7d%26startIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26responseFields%3d%7bresponseFields%7d	Retrieves a list of categories according to any specified filter criteria and sort options.
GetCategory	GET %7bcategoryId%7d%3fallowInactive%3d%7ballowInactive%7d%26responseFields%3d%7bresponseFields%7d	Retrieves the details of a single category.
GetCategoryTree	GET tree%3fresponseFields%3d%7bresponseFields%7d	Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list.