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
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
  • Models
    • Introduction
    • Contact Object
    • Consumer Object
    • Discount Object
    • Item Object
    • Money Object
    • Order Details Object
    • Payment Object
    • Refund Object
    • Shipping Courier Object
  • Service Status
    • GETPing
  • Configuration
    • GETGet Configuration
  • Orders
    • Introduction
    • GETGet Order
    • POSTCreate Order
  • Javascript afterpay.js
    • Information
    • Redirect Method
  • Payments
    • Introduction
    • POSTCapture Payment
    • PUTUpdate Shipping Courier
    • GETGet Payment By Order ID
    • GETGet Payment By Token
    • GETList Payment(s)
    • POSTCreate Refund
    • PUTUpdate Payment by Order ID
    • POSTReverse Payment By Token
  • Errors
    • Introduction
    • Get Errors
    • Put/Post Errors
  • Reference
LogoLogo
On this page
  • Attributes
  • Example Order Details object
  • Australia
  • New Zealand
  • United States of America
Models

Order Details object

Was this page helpful?
Previous

Payment Object

Next
Built with

Attributes

AttributeTypeDescription
consumerConsumer requiredThe consumer who placed or is placing the order.
billingContactThe consumer’s billing address.
shippingContactThe consumer’s shipping address.
courierShipping CourierThe consumer’s chosen shipping courier.
itemsItem[]An array of order items.
discountsDiscount[]An array of discounts.
taxAmountMoneyThe included tax amount, after applying all discounts.
shippingAmountMoneyThe shipping price charged to the consumer.

Example Order Details object

Australia

1{
2 "consumer": {
3 "phoneNumber": "0400 000 000",
4 "givenNames": "Joe",
5 "surname": "Consumer",
6 "email": "test@example.com"
7 },
8 "billing": {
9 "name": "Joe Consumer",
10 "line1": "Level 5",
11 "line2": "406 Collins Street",
12 "suburb": "Melbourne",
13 "state": "VIC",
14 "postcode": "3000",
15 "countryCode": "AU",
16 "phoneNumber": "0400 000 000"
17 },
18 "shipping": {
19 "name": "Joe Consumer",
20 "line1": "Level 5",
21 "line2": "406 Collins Street",
22 "suburb": "Melbourne",
23 "state": "VIC",
24 "postcode": "3000",
25 "countryCode": "AU",
26 "phoneNumber": "0400 000 000"
27 },
28 "courier" : {
29 "shippedAt" : "2019-01-01T00:00:00+10:00",
30 "name" : "Australia Post",
31 "tracking" : "AA0000000000000",
32 "priority" : "STANDARD"
33 },
34 "items": [
35 {
36 "name": "T-Shirt",
37 "sku": "12341234",
38 "quantity": 1,
39 "price": {
40 "amount": "10.00",
41 "currency": "AUD"
42 }
43 },
44 {
45 "name": "Jeans",
46 "sku": "12341235",
47 "quantity": 1,
48 "price": {
49 "amount": "20.00",
50 "currency": "AUD"
51 }
52 }
53 ],
54 "discounts": [
55 {
56 "displayName": "10% Off Subtotal",
57 "amount": {
58 "amount": "3.00",
59 "currency": "AUD"
60 }
61 }
62 ],
63 "taxAmount": {
64 "amount": "3.70",
65 "currency": "AUD"
66 },
67 "shippingAmount": {
68 "amount": "10.00",
69 "currency": "AUD"
70 }
71}

New Zealand

1{
2 "consumer": {
3 "phoneNumber": "0200 000 000",
4 "givenNames": "Joe",
5 "surname": "Consumer",
6 "email": "test@example.com"
7 },
8 "billing": {
9 "name": "Joe Consumer",
10 "line1": "75 Queen St",
11 "state": "Auckland",
12 "postcode": "1010",
13 "countryCode": "NZ",
14 "phoneNumber": "0200 000 000"
15 },
16 "shipping": {
17 "name": "Joe Consumer",
18 "line1": "75 Queen St",
19 "state": "Auckland",
20 "postcode": "1010",
21 "countryCode": "NZ",
22 "phoneNumber": "0200 000 000"
23 },
24 "courier" : {
25 "shippedAt" : "2019-01-01T00:00:00+13:00",
26 "name" : "CourierPost",
27 "tracking" : "AA999999999AA",
28 "priority" : "STANDARD"
29 },
30 "items": [
31 {
32 "name": "T-Shirt",
33 "sku": "12341234",
34 "quantity": 1,
35 "price": {
36 "amount": "10.00",
37 "currency": "NZD"
38 }
39 },
40 {
41 "name": "Jeans",
42 "sku": "12341235",
43 "quantity": 1,
44 "price": {
45 "amount": "20.00",
46 "currency": "NZD"
47 }
48 }
49 ],
50 "discounts": [
51 {
52 "displayName": "10% Off Subtotal",
53 "amount": {
54 "amount": "3.00",
55 "currency": "NZD"
56 }
57 }
58 ],
59 "taxAmount": {
60 "amount": "5.55",
61 "currency": "NZD"
62 },
63 "shippingAmount": {
64 "amount": "10.00",
65 "currency": "NZD"
66 }
67}

United States of America

1{
2 "consumer": {
3 "phoneNumber": "(415) 200-0000",
4 "givenNames": "Joe",
5 "surname": "Consumer",
6 "email": "test@example.com"
7 },
8 "billing": {
9 "name": "Joe Consumer",
10 "line1": "3655 Lawton St",
11 "suburb": "San Francisco",
12 "state": "CA",
13 "postcode": "94122",
14 "countryCode": "US",
15 "phoneNumber": "(415) 200-0000"
16 },
17 "shipping": {
18 "name": "Joe Consumer",
19 "line1": "3655 Lawton St",
20 "suburb": "San Francisco",
21 "state": "CA",
22 "postcode": "94122",
23 "countryCode": "US",
24 "phoneNumber": "(415) 200-0000"
25 },
26 "courier" : {
27 "shippedAt" : "2019-01-01T00:00:00-08:00",
28 "name" : "FedEx",
29 "tracking" : "000 000 000 000",
30 "priority" : "STANDARD"
31 },
32 "items": [
33 {
34 "name": "T-Shirt",
35 "sku": "12341234",
36 "quantity": 1,
37 "price": {
38 "amount": "10.00",
39 "currency": "USD"
40 }
41 },
42 {
43 "name": "Jeans",
44 "sku": "12341235",
45 "quantity": 1,
46 "price": {
47 "amount": "20.00",
48 "currency": "USD"
49 }
50 }
51 ],
52 "discounts": [
53 {
54 "displayName": "10% Off Subtotal",
55 "amount": {
56 "amount": "3.00",
57 "currency": "USD"
58 }
59 }
60 ],
61 "taxAmount": {
62 "amount": "0.00",
63 "currency": "USD"
64 },
65 "shippingAmount": {
66 "amount": "10.00",
67 "currency": "USD"
68 }
69}