For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Reference
    • Introduction
      • Capture Payment
      • Consumer
      • Consumer Offers
      • Contact
      • Create Refund
      • Discount
      • Interval
      • Item
      • Money
      • Offer
      • Offers Request
      • Offers Response
      • Order Details
      • Payment Event
      • Payment
      • Payment (Auth)
      • Payment Schedule
      • Refund
      • Shipping Courier
LogoLogo
ReferenceModels

Item

Example
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": "AUD"
10  },
11  "categories": [
12    [
13      "Sporting Goods",
14      "Climbing Equipment",
15      "Climbing",
16      "Climbing Carabiners"
17    ],
18    [
19      "Sale",
20      "Climbing"
21    ]
22  ],
23  "estimatedShipmentDate": "2023-08-01"
24}
Was this page helpful?
Previous

Money

Next
Built with

Response

itemobjectRequired
This data model is used to store crucial product details. The `price.amount` 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. <Warning title="Important Note"> It is crucial that the `price.amount` represents the unit price of the individual item. **Never** populate the `price.amount` by multiplying the quantity by the unit cost. Always enter the price for a single unit to maintain data accuracy. </Warning>