ProductList Document (Shop API 16.5)

(supports custom properties)

Document representing a product List.

Property Type Constraints Description
co_registrant ProductListRegistrant   The coRegistrant of this product list.
current_shipping_address_link AddressLink   The resource link to the currentShippingAddress of this product list.
description String   The description of this product list.
event ProductListEvent   The event of this product list.
id String minLength=1 The id of this product list.
items_link ProductListItemLink   The resource link to the currentShippingAddress of this product list.
name String   The name of this product list.
post_event_shipping_address_link AddressLink   The resource link to the postEventShippingAddress of this product list.
product_list_shipping_address ProductListShippingAddress   The abbreviated shipping address of this product list representing what anonymous user can see.
public Boolean   Indicates whether the owner made this product list available for access by other customers.
registrant ProductListRegistrant   The registrant of this product list.
shipping_address_link AddressLink   The resource link to the shippingAddress of this product list.
type Enum {wish_list, gift_registry, shopping_list, custom_1, custom_2, custom_3}   The type of the product list.
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.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.