CustomerProductListItem document (Shop API 19.3)

(supports custom properties)

Document representing a customer product list item.

Property Type Constraints Description
id String   The id of this product list item.
priority Integer   The priority of the item.
product Product   The product item
product_details_link ProductSimpleLink   A link to the product.
product_id String   The id of the product.
public Boolean   Is 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 product list item.
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.