API Reference

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

{
  "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"
  }
}

{
  "consumer": {  
    "phoneNumber": "250-200-0000",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "2234 Scotts Lane",
    "area1": "Chemainus",
    "region": "British Columbia",
    "postcode": "V0R 1K0",
    "countryCode": "CA",
    "phoneNumber": "250-200-0000"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "2234 Scotts Lane",
    "area1": "Chemainus",
    "region": "British Columbia",
    "postcode": "V0R 1K0",
    "countryCode": "CA",
    "phoneNumber": "250-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": "CAD"
      }
    }
  ],
  "taxAmount": {  
    "amount": "0.00",
    "currency": "CAD"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "CAD"
  }
}

{
  "consumer": {  
    "phoneNumber": "079 7495 1928",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "112 Neville Street",
    "area1": "IFTON HEATH",
    "region": "Shrewsbury",
    "postcode": "SY11 4NX",
    "countryCode": "GB",
    "phoneNumber": "079 7495 1928"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "112 Neville Street",
    "area1": "IFTON HEATH",
    "region": "Shrewsbury",
    "postcode": "SY11 4NX",
    "countryCode": "GB",
    "phoneNumber": "079 7495 1928"
  },
  "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": "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": "0.00",
    "currency": "GBP"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "GBP"
  }
}

{
  "consumer": {  
    "phoneNumber": "01 12 82 50114",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "103 Avenue De Marlioz",
    "area1": "ARLES",
    "region": "Provence-Alpes-Côte d'Azur",
    "postcode": "13200",
    "countryCode": "FR",
    "phoneNumber": "01 12 82 50114"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "103 Avenue De Marlioz",
    "area1": "ARLES",
    "region": "Provence-Alpes-Côte d'Azur",
    "postcode": "13200",
    "countryCode": "FR",
    "phoneNumber": "01 12 82 50114"
  },
  "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": "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": "0.00",
    "currency": "EUR"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "EUR"
  }
}

{
  "consumer": {  
    "phoneNumber": "0388 0666853",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "Via San Domenico Soriano 127",
    "area1": "Sant'Egidio",
    "region": "Forli",
    "postcode": "47023",
    "countryCode": "IT",
    "phoneNumber": "0388 0666853"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "Via San Domenico Soriano 127",
    "area1": "Sant'Egidio",
    "region": "Forli",
    "postcode": "47023",
    "countryCode": "IT",
    "phoneNumber": "0388 0666853"
  },
  "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": "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": "0.00",
    "currency": "EUR"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "EUR"
  }
}

{
  "consumer": {  
    "phoneNumber": "712 910 890",
    "givenNames": "Joe",
    "surname": "Consumer",
    "email": "[email protected]"
  },
  "billing": {
    "name": "Joe Consumer",
    "line1": "Extramuros 52",
    "area1": "Valdilecha",
    "region": "Madrid",
    "postcode": "28511",
    "countryCode": "ES",
    "phoneNumber": "712 910 890"
  },
  "shipping": {
    "name": "Joe Consumer",
    "line1": "Extramuros 52",
    "area1": "Valdilecha",
    "region": "Madrid",
    "postcode": "28511",
    "countryCode": "ES",
    "phoneNumber": "712 910 890"
  },
  "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": "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": "0.00",
    "currency": "EUR"
  },
  "shippingAmount": {  
    "amount": "20.00",
    "currency": "EUR"
  }
}