API ReferenceGuides
Log In
API Reference

List Contents

Contents inside a created list.

List Item

An object containing params required for creating, updating or deleting list items or products.

📘

Product metadata source of truth

List item fields can include product identifiers and metadata used by Wishlist Plus APIs and the JavaScript SDK. Use returned product metadata only for the initial render. Before relying on product details for pricing, availability, display, cart, or checkout flows, fetch the current product and variant data from Shopify using the Storefront API ProductVariant object.

let product = {
  epi: epi, // one unique list item (empi+epi) per listid
  empi: empi,
  du: du,
  qty: qty,
  note: note, //optional
  cprops: {} // Optional custom attributes
};
--data-urlencode 'epi: {{epi}}' \ # One unique list item (empi+epi) per listid
--data-urlencode 'empi: {{empi}}' \ 
--data-urlencode 'du: {{du}}' \
--data-urlencode 'qty: {{qty}}' \
--data-urlencode 'note: {{note}}' \
--data-urlencode 'cprops: {{JSON stringified cprops}}' \ # Optional custom attributes
ArgumentTypeDescription
product.epinumber/stringVariant id of the product
product.empinumber/stringProduct id of the product
product.dustringCanonical uri of the product
product.qty
(optional)
numberDefaults to 1. Quantity included for the action
product.note (optional)stringOptional note
product.cprops
(optional)
objectOptional. Map of custom fields
product.lbls
(optional)
arrayOptional. Array of strings indicating labels, rooms, etc. for HTC. Only one value supported in array. eg: 0-0": "li
product._avboolOptional. true if the list action was done without user explicitly picking a variant. Can be used by Wishlist UX to require user to pick variant before adding to cart