PublicProductListItemResult document (Shop API 23.2)

Result document containing an array of product list items.

Property Type Constraints Description
count Integer   The number of returned documents.
data [PublicProductListItem]   The array of product list item documents.
total Integer   The total number of documents.

A Flash Message extends a document with additional context information.

Flashs

Type Description
ProductAlreadyOnList Returned if the product was already on the list and duplicates are not allowed. In this case, quantity, priority and the public flag are not updated.
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.