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

ProductListItem document (Shop API 23.2)

(supports custom properties)

Document representing a product list item.

Property Type Constraints Description
id String   The id of this product list item.
priority Integer   The priority of the item.
product_details_link ProductDetailsLink   A link to the product.
public Boolean   A flag indicating whether the owner made this product list item available for access by other customers.
purchased_quantity Decimal   The quantity of products already purchased.
quantity Decimal minNumberValue=0.0 The quantity of this item on the product list.
type Enum {product, gift_certificate}   The type of the item.

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.