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.

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

Argument

Type

Description

product.epi

number/string

Variant id of the product

product.empi

number/string

Product id of the product

product.du

string

Canonical uri of the product

product.qty
(optional)

number

Defaults to 1. Quantity included for the action

product.note (optional)

string

Optional note

product.cprops
(optional)

object

Optional. Map of custom fields

product.lbls
(optional)

array

Optional. Array of strings indicating labels, rooms, etc. for HTC. Only one value supported in array. eg: 0-0": "li

product._av

bool

Optional. 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