Skip to navigation
Models

Order Details object

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

{
  "consumer": {  
    "phoneNumber": "0400 000 000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "test@example.com"
  },
  "billing": {  
    "name": "Joe Consumer",
    "line1": "Level 5",
    "line2": "406 Collins Street",
    "suburb": "Melbourne",
    "state": "VIC",
    "postcode": "3000",
    "countryCode": "AU",
    "phoneNumber": "0400 000 000"
  },
  "shipping": {  
    "name": "Joe Consumer",
    "line1": "Level 5",
    "line2": "406 Collins Street",
    "suburb": "Melbourne",
    "state": "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": "T-Shirt",
      "sku": "12341234",
      "quantity": 1,
      "price": {
        "amount": "10.00",
        "currency": "AUD"
      }
    },
    {
      "name": "Jeans",
      "sku": "12341235",
      "quantity": 1,
      "price": {
        "amount": "20.00",
        "currency": "AUD"
      }
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "3.00",
        "currency": "AUD"
      }
    }
  ],
  "taxAmount": {  
    "amount": "3.70",
    "currency": "AUD"
  },
  "shippingAmount": {  
    "amount": "10.00",
    "currency": "AUD"
  }
}

New Zealand

{
  "consumer": {  
    "phoneNumber": "0200 000 000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "test@example.com"
  },
  "billing": {  
    "name": "Joe Consumer",
    "line1": "75 Queen St",
    "state": "Auckland",
    "postcode": "1010",
    "countryCode": "NZ",
    "phoneNumber": "0200 000 000"
  },
  "shipping": {  
    "name": "Joe Consumer",
    "line1": "75 Queen St",
    "state": "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": "T-Shirt",
      "sku": "12341234",
      "quantity": 1,
      "price": {
        "amount": "10.00",
        "currency": "NZD"
      }
    },
    {
      "name": "Jeans",
      "sku": "12341235",
      "quantity": 1,
      "price": {
        "amount": "20.00",
        "currency": "NZD"
      }
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "3.00",
        "currency": "NZD"
      }
    }
  ],
  "taxAmount": {  
    "amount": "5.55",
    "currency": "NZD"
  },
  "shippingAmount": {  
    "amount": "10.00",
    "currency": "NZD"
  }
}

United States of America

{
  "consumer": {  
    "phoneNumber": "(415) 200-0000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "test@example.com"
  },
  "billing": {  
    "name": "Joe Consumer",
    "line1": "3655 Lawton St",
    "suburb": "San Francisco",
    "state": "CA",
    "postcode": "94122",
    "countryCode": "US",
    "phoneNumber": "(415) 200-0000"
  },
  "shipping": {  
    "name": "Joe Consumer",
    "line1": "3655 Lawton St",
    "suburb": "San Francisco",
    "state": "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": "T-Shirt",
      "sku": "12341234",
      "quantity": 1,
      "price": {
        "amount": "10.00",
        "currency": "USD"
      }
    },
    {
      "name": "Jeans",
      "sku": "12341235",
      "quantity": 1,
      "price": {
        "amount": "20.00",
        "currency": "USD"
      }
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "3.00",
        "currency": "USD"
      }
    }
  ],
  "taxAmount": {  
    "amount": "0.00",
    "currency": "USD"
  },
  "shippingAmount": {  
    "amount": "10.00",
    "currency": "USD"
  }
}