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

Order Details

Example
1{
2  "consumer": {
3    "email": "test@example.com",
4    "givenNames": "Joe",
5    "surname": "Consumer",
6    "phoneNumber": "0400 000 000"
7  },
8  "billing": {
9    "name": "Joe Consumer",
10    "line1": "Level 5",
11    "line2": "390 Collins Street",
12    "area1": "Melbourne",
13    "region": "VIC",
14    "postcode": "3000",
15    "countryCode": "AU",
16    "phoneNumber": "0400 000 000"
17  },
18  "courier": {
19    "shippedAt": "2023-08-24T14:15:22Z",
20    "name": "Australia Post",
21    "tracking": "AA0000000000000",
22    "priority": "STANDARD"
23  },
24  "items": [
25    {
26      "name": "Blue Carabiner",
27      "sku": "12341234",
28      "quantity": 1,
29      "pageUrl": "https://merchant.example.com/carabiner-354193.html",
30      "imageUrl": "https://merchant.example.com/carabiner-7378-391453-1.jpg",
31      "price": {
32        "amount": "40.00",
33        "currency": "AUD"
34      },
35      "categories": [
36        [
37          "Sporting Goods",
38          "Climbing Equipment",
39          "Climbing",
40          "Climbing Carabiners"
41        ],
42        [
43          "Sale",
44          "Climbing"
45        ]
46      ],
47      "estimatedShipmentDate": "2023-08-01"
48    }
49  ],
50  "discounts": [
51    {
52      "displayName": "New Customer Coupon",
53      "amount": {}
54    }
55  ],
56  "taxAmount": {
57    "amount": "100.00",
58    "currency": "AUD"
59  },
60  "shippingAmount": {
61    "amount": "100.00",
62    "currency": "AUD"
63  }
64}
Was this page helpful?
Previous

Payment Event

Next
Built with

Response

order_detailsobjectRequired
This comprehensive schema is designed to store an entire transaction's detail, covering crucial aspects like consumer information, billing and shipping details, courier particulars, item list, discounts, tax, and shipping amount.