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.
itemsItemAn array of order items.
discountsDiscountAn array of discounts.
taxAmountMoneyThe included tax amount, after applying all discounts.
shippingAmountMoneyThe shipping price charged to the consumer.

Example Order Details object

{
  "consumer": {
    "phoneNumber": "600555777",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line2": "1 Faker Street",
    "line1": "Floor 2 - Apartment 2",
    "area1": "Barcelona",
    "area2": "Barcelona Municipality",
    "region": "Catalonia",
    "postcode": "08001",
    "countryCode": "ES",
    "phoneNumber": "600555777"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line2": "1 Faker Street",
    "line1": "Floor 2 - Apartment 2",
    "area1": "Barcelona",
    "area2": "Barcelona Municipality",
    "region": "Catalonia",
    "postcode": "08001",
    "countryCode": "ES",
    "phoneNumber": "600555777"
  },
  "courier": {
    "shippedAt": "2021-01-01T00:00:00.000Z",
    "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": "EUR"
      },
      "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": "EUR"
      },
      "categories": [["Camping & Outdoor", "Lighting", "Lanterns"]]
    }
  ],
  "discounts": [
    {
      "displayName": "10% Off Subtotal",
      "amount": {
        "amount": "10.00",
        "currency": "EUR"
      }
    }
  ],
  "taxAmount": {
    "amount": "22.00",
    "currency": "EUR"
  },
  "shippingAmount": {
    "amount": "20.00",
    "currency": "EUR"
  }
}