Salesforce B2C Commerce 24.7 > Open Commerce API 23.2 > Data API documents 23.2

Catalog document (Data API 23.2)

(supports custom properties)

Document representing a catalog

Property Type Constraints Description
assigned_product_count Integer   The count of products assigned to the catalog. It is read only.
assigned_sites [Site]   The sites assigned to the catalog. It is read only.
category_count Integer   The category count of catalog. It is read only.
creation_date Date   Returns the value of attribute 'creationDate'.
description Localized<String>   The description of catalog
id String   The catalog Id
last_modified Date   Returns the value of attribute 'lastModified'.
link String   URL that is used to get this instance. It is read only.
name Localized<String>   The catalog name
online Boolean   The online status of catalog
owned_product_count Integer   The count of products owned by the catalog. It is read only.
recommendation_count Integer   The recommendation count of the catalog. It is read only.
root_category String   The root category of the catalog. It is read only

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.