Category Document (Shop API 17.3)

(supports custom properties)

Document representing a category.

Property Type Constraints Description
categories [Category]   Array of subcategories. Can be empty.
description Localized<String>   The localized description of the category.
id String   The id of the category.
image String   The URL to the category image.
name Localized<String>   The localized name of the category.
page_description Localized<String>   The localized page description of the category.
page_keywords Localized<String>   The localized page keywords of the category.
page_title Localized<String>   The localized page title of the category.
parent_category_id String   The id of the parent category.
thumbnail String   The URL to the category thumbnail.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.