Skip to navigation
Online APIData Models

Order Details object

Attributes

AttributeTypeDescription
consumer Consumer 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

{
  "consumer": {  
    "phoneNumber": "07000000000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "test@example.com"
  },
  "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"
  }
}