Fields in List Item (Product)

Fields in List Item (product)

📘
Product metadata source of truth
Swym may return product metadata such as product title, price, image URL, product URL, brand, category, and variant details with list items. Use these values only for the initial render of a storefront experience. 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.

{
  "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"
}

Argument	Type	Description
lid	string	List id - system generated guid for the list
epi	number/string	Variant id of the product
empi	number/string	Product id of the product
du	string	Canonical uri of the product
dt	string	Product title
qty	number	Defaults to 1. Quantity included for the action
pr	float	Product Price
iu	string	Product image url
note (optional)	string	Optional note
cprops (optional)	object	Optional. Map of custom fields
bt (optional)	string	Optional. Brand name
ct (optional)	string	Optional. Category/collection name
vi (optional)	string	Optional. Selected variant info
av (optional)	bool	Optional. true if the list action was done without user explicitly
cts	number	Created time at in milliseconds
uts (optional)	number	Last updated time at in milliseconds
cby (optional)	string	Email address of the user if known when list item was created
uby (optional)	string	Email address of the user if known when list item was last updated
lity (optional)	string	Optional. Maps to list item type. Implicitly set to "custom" or "customBundle" based on custom item added. More here
bundle (optional)	array of objects	Optional. Maps to items bundled under a custom item. Contains metadata defined here