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.
GuidesAPI Reference
GuidesAPI Reference
  • Reference
    • Introduction
      • Contact Object
      • Consumer Object
      • Discount Object
      • Item Object
      • Money Object
      • Order Details Object
      • Payment Object
      • Payment Event Object
      • Refund Object
      • Shipping Courier Object
LogoLogo
On this page
  • Attributes
  • Example Order Details object
ReferenceData Models

Order Details object

Was this page helpful?
Previous

Payment Object

Next
Built with

Attributes

AttributeTypeDescription
consumerConsumer(required)The customer who placed or is placing the order.
billingContactThe customer’s billing address.
shippingContactThe customer’s shipping address.
courierShipping CourierThe customer’s chosen shipping courier.
itemsItemAn array of order items.
discountsDiscountAn array of discounts.
taxAmountMoneyThe included tax amount, after applying all discounts.
shippingAmountMoneyThe shipping price charged to the customer.

Example Order Details object

{
"consumer": {
"phoneNumber": "(415) 200-0000",
"givenNames": "Joe",
"surname": "Customer",
"email": "test@example.com"
},
"billing": {
"name": "Joe Customer",
"line1": "3655 Lawton St",
"area1": "San Francisco",
"region": "CA",
"postcode": "94122",
"countryCode": "US",
"phoneNumber": "(415) 200-0000"
},
"shipping": {
"name": "Joe Customer",
"line1": "3655 Lawton St",
"area1": "San Francisco",
"region": "CA",
"postcode": "94122",
"countryCode": "US",
"phoneNumber": "(415) 200-0000"
},
"courier" : {
"shippedAt" : "2024-01-01T00:00:00-08:00",
"name" : "FedEx",
"tracking" : "000 000 000 000",
"priority" : "STANDARD"
},
"items": [
{
"name": "Blue Carabiner",
"sku": "12341234",
"quantity": 1,
"pageUrl": "https://merchant.example.com/carabiner-354193.html",
"imageUrl": "https://merchant.example.com/carabiner-7378-391453-1.jpg",
"price": {
"amount": "40.00",
"currency": "USD"
},
"categories": [
["Sporting Goods", "Climbing Equipment", "Climbing", "Climbing Carabiners"],
["Sale", "Climbing"]
]
},
{
"name": "LED Lantern",
"sku": "12346789",
"quantity": 1,
"pageUrl": "https://merchant.example.com/lantern-836599.html",
"imageUrl": "https://merchant.example.com/lantern-3417-983451-1.jpg",
"price": {
"amount": "60.00",
"currency": "USD"
},
"categories": [
["Camping & Outdoor", "Lighting", "Lanterns"]
]
}
],
"discounts": [
{
"displayName": "10% Off Subtotal",
"amount": {
"amount": "10.00",
"currency": "USD"
}
}
],
"taxAmount": {
"amount": "0.00",
"currency": "USD"
},
"shippingAmount": {
"amount": "20.00",
"currency": "USD"
}
}