On this page
No Headings
Product item for cart creation/updates
objectitem_idstringUnique product identifier (DEPRECATED - optional in v1 for backwards compatibility)
variant_idstringProduct variant identifier (color, size, etc.) - unique id of the product
parent_idstringItem grouping identifier - passed when item is part of a group in product catalog
quantityrequiredintegerNumber of items
namestringProduct display name
descriptionstringProduct description
item_urlstringuriURL for product details page
priceobjectMonetary amount with currency
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes.
selected_attributesarraySelected product attributes
itemsobjectnamestringvaluestringgift_optionsobjectGift-specific options
is_giftbooleanWhether this is a gift
recipientobjectGift recipient information
namestringemailstringemailphonestringdelivery_datestringdate-time^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Scheduled delivery date in RFC3339 format. Seconds are required while fractional seconds are optional.
sender_namestringName of gift sender
gift_messagestringPersonal message (max 500 characters)
gift_wrapbooleanWhether to include gift wrapping
custom_optionsarrayCustom product options
itemsobjectnamestringvaluestringprice_modifierstringAdditional cost for this option