API Reference

Fields in List Item (Product)

Fields in List Item

Fields in List Item (product)

{
  "lid": "List id",
  "epi": "Product Variant ID, unique per item within a list",
  "empi": "Product ID",
  "du": "Canonical uri of the product",
  "dt": "Product title",
  "qty": "Quantity",
  "pr": "Product price",
  "iu": "Product Image url",
  "note": "Item level note, single line of note at the list item level",
  "cprops": {},
  "bt": "Brand name",
  "ct": "Category/collection name",
  "vi": "Selected variant info",
  "_av": false,
  "cby": "Created by email address",
  "uby": "Updated by email address",
  "cts": "Created at milliseconds",
  "uts": "Updated at milliseconds"
}
ArgumentTypeDescription
lidstringList id - system generated guid for the list
epinumber/stringVariant id of the product
empinumber/stringProduct id of the product
dustringCanonical uri of the product
dtstringProduct title
qtynumberDefaults to 1. Quantity included for the action
prfloatProduct Price
iustringProduct image url
note (optional)stringOptional note
cprops
(optional)
objectOptional. Map of custom fields
bt (optional)stringOptional. Brand name
ct (optional)stringOptional. Category/collection name
vi (optional)stringOptional. Selected variant info
_av (optional)boolOptional. true if the list action was done without user explicitly
ctsnumberCreated time at in milliseconds
uts (optional)numberLast updated time at in milliseconds
cby (optional)stringEmail address of the user if known when list item was created
uby (optional)stringEmail address of the user if known when list item was last updated
lity (optional)stringOptional. Maps to list item type. Implicitly set to "custom" or "customBundle" based on custom item added. More here
bundle (optional)array of objectsOptional. Maps to items bundled under a custom item. Contains metadata defined here