Item object

Attributes

AttributeTypeStatusDescription
namestringrequiredProduct name. Limited to 255 characters.
skustringProduct SKU. Limited to 128 characters.
quantityintegerrequiredThe quantity of the item, stored as a signed 32-bit integer.
pageUrlstringThe canonical URL for the item’s Product Detail Page. Limited to 2048 characters.
imageUrlstringA URL for a web-optimised photo of the item, suitable for use directly as the src attribute of an img tag. Limited to 2048 characters.
priceMoneyrequiredThe unit price of the individual item. Must be a positive value.
categories[]An array of arrays to accommodate multiple categories that apply to the item. Each array represents a hierarchical path to a category, with the left-most category being the top-level parent category.
estimatedShipmentDatestringThe estimated date when the order will be shipped, in YYYY-MM or YYYY-MM-DD format.
preorderbooleanIf this item is not expected to be fulfilled immediately, and therefore should be marked as a preorder at checkout, set to true. Set to false otherwise.

Example Item object

1{
2 "name": "Blue Carabiner",
3 "sku": "12341234",
4 "quantity": 1,
5 "pageUrl": "https://merchant.example.com/carabiner-354193.html",
6 "imageUrl": "https://merchant.example.com/carabiner-7378-391453-1.jpg",
7 "price": {
8 "amount": "40.00",
9 "currency": "USD"
10 },
11 "categories": [
12 ["Sporting Goods", "Climbing Equipment", "Climbing", "Climbing Carabiners"],
13 ["Sale", "Climbing"]
14 ],
15 "estimatedShipmentDate": "2024-03-01"
16}