Attributes

Attribute

Type

Description

consumer

Consumer required

The consumer who placed or is placing the order.

billing

Contact

The consumer's billing address.

shipping

Contact

The consumer's shipping address.

courier

Shipping Courier

The consumer's chosen shipping courier.

items

Item[]

An array of order items.

discounts

Discount[]

An array of discounts.

taxAmount

Money

The included tax amount, after applying all discounts.

shippingAmount

Money

The shipping price charged to the consumer.

Example Order Details object

{
  "consumer": {  
    "phoneNumber": "0400 000 000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "Level 5",
    "line2": "406 Collins Street",
    "area1": "Melbourne",
    "region": "VIC",
    "postcode": "3000",
    "countryCode": "AU",
    "phoneNumber": "0400 000 000"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "Level 5",
    "line2": "406 Collins Street",
    "area1": "Melbourne",
    "region": "VIC",
    "postcode": "3000",
    "countryCode": "AU",
    "phoneNumber": "0400 000 000"
  },
  "courier" : {
    "shippedAt" : "2019-01-01T00:00:00+10:00",
    "name" : "Australia Post",
    "tracking" : "AA0000000000000",
    "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": "AUD"
      },
      "categories": [
        ["Sporting Goods", "Climbing Equipment", "Climbing", "Climbing Carabiners"],
        ["Sale", "Climbing"]
      ],
     "estimatedShipmentDate": "2021-03-01"
    },
    {
      "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": "AUD"
      },
      "categories": [
        ["Camping & Outdoor", "Lighting", "Lanterns"]
      ],
     "estimatedShipmentDate": "2021-03-04"
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "10.00",
        "currency": "AUD"
      }
    }
  ],
  "taxAmount": {  
    "amount": "11.00",
    "currency": "AUD"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "AUD"
  }
}
{
  "consumer": {  
    "phoneNumber": "0200 000 000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "75 Queen St",
    "area1": "Auckland",
    "area2": "Auckland Central",
    "region": "Auckland",
    "postcode": "1010",
    "countryCode": "NZ",
    "phoneNumber": "0200 000 000"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "75 Queen St",
    "area1": "Auckland",
    "area2": "Auckland Central",
    "region": "Auckland",
    "postcode": "1010",
    "countryCode": "NZ",
    "phoneNumber": "0200 000 000"
  },
  "courier" : {
    "shippedAt" : "2019-01-01T00:00:00+13:00",
    "name" : "CourierPost",
    "tracking" : "AA999999999AA",
    "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": "NZD"
      },
      "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": "NZD"
      },
      "categories": [
        ["Camping & Outdoor", "Lighting", "Lanterns"]
      ]
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "10.00",
        "currency": "NZD"
      }
    }
  ],
  "taxAmount": {  
    "amount": "16.50",
    "currency": "NZD"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "NZD"
  }
}
{
  "consumer": {  
    "phoneNumber": "(415) 200-0000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "3655 Lawton St",
    "area1": "San Francisco",
    "region": "CA",
    "postcode": "94122",
    "countryCode": "US",
    "phoneNumber": "(415) 200-0000"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "3655 Lawton St",
    "area1": "San Francisco",
    "region": "CA",
    "postcode": "94122",
    "countryCode": "US",
    "phoneNumber": "(415) 200-0000"
  },
  "courier" : {
    "shippedAt" : "2019-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"
  }
}