Online APIData Models

Item object

This data model is used to store crucial product details. The price field represents the unit price of the individual item. The quantity field shows the number of units of the item. The name field denotes the name of the product, while sku holds the Stock Keeping Unit identifier. 100 is the maximum number of item objects in the items array.

Attributes

AttributeTypeDescription
namestring requiredProduct name. Limited to 255 characters.
skustringProduct SKU. Limited to 128 characters.
quantityinteger requiredThe 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.
priceMoney  requiredThe 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.
Warning

It is crucial that the price represents the unit price of the individual item.

Never populate the price by multiplying the quantity by the unit cost. Always enter the price for a single unit to maintain data accuracy.

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": "GBP"
10  },
11  "categories": [
12    ["Sporting Goods", "Climbing Equipment", "Climbing", "Climbing Carabiners"],
13    ["Sale", "Climbing"]
14  ],
15	"estimatedShipmentDate": "2021-03-01"
16}