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": "07000000000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "Apartment 9",
    "line2": "1 Market Street",
    "area1": "Ancoats",
    "area2": "Manchester",
    "region": "Greater Manchester",
    "postcode": "M4 3AT",
    "countryCode": "GB",
    "phoneNumber": "07000000000"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "Apartment 9",
    "line2": "1 Market Street",
    "area1": "Ancoats",
    "area2": "Manchester",
    "region": "Greater Manchester",
    "postcode": "M4 3AT",
    "countryCode": "GB",
    "phoneNumber": "07000000000"
  },
  "courier" : {
    "shippedAt" : "2019-01-01T00:00:00+01:00",
    "name" : "Parcelforce Worldwide",
    "tracking" : "AAAA1234567890",
    "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": "GBP"
      },
      "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": "GBP"
      },
      "categories": [
        ["Camping & Outdoor", "Lighting", "Lanterns"]
      ]
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "10.00",
        "currency": "GBP"
      }
    }
  ],
  "taxAmount": {  
    "amount": "22.00",
    "currency": "GBP"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "GBP"
  }
}