Order Details object
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
1 { 2 "consumer": { 3 "phoneNumber": "07000000000", 4 "givenNames": "Joe", 5 "surname": "Consumer", 6 "email": "test@example.com" 7 }, 8 "billing": { 9 "name": "Joe Consumer", 10 "line1": "Apartment 9", 11 "line2": "1 Market Street", 12 "area1": "Ancoats", 13 "area2": "Manchester", 14 "region": "Greater Manchester", 15 "postcode": "M4 3AT", 16 "countryCode": "GB", 17 "phoneNumber": "07000000000" 18 }, 19 "shipping": { 20 "name": "Joe Consumer", 21 "line1": "Apartment 9", 22 "line2": "1 Market Street", 23 "area1": "Ancoats", 24 "area2": "Manchester", 25 "region": "Greater Manchester", 26 "postcode": "M4 3AT", 27 "countryCode": "GB", 28 "phoneNumber": "07000000000" 29 }, 30 "courier" : { 31 "shippedAt" : "2019-01-01T00:00:00+01:00", 32 "name" : "Parcelforce Worldwide", 33 "tracking" : "AAAA1234567890", 34 "priority" : "STANDARD" 35 }, 36 "items": [ 37 { 38 "name": "Blue Carabiner", 39 "sku": "12341234", 40 "quantity": 1, 41 "pageUrl": "https://merchant.example.com/carabiner-354193.html", 42 "imageUrl": "https://merchant.example.com/carabiner-7378-391453-1.jpg", 43 "price": { 44 "amount": "40.00", 45 "currency": "GBP" 46 }, 47 "categories": [ 48 ["Sporting Goods", "Climbing Equipment", "Climbing", "Climbing Carabiners"], 49 ["Sale", "Climbing"] 50 ] 51 }, 52 { 53 "name": "LED Lantern", 54 "sku": "12346789", 55 "quantity": 1, 56 "pageUrl": "https://merchant.example.com/lantern-836599.html", 57 "imageUrl": "https://merchant.example.com/lantern-3417-983451-1.jpg", 58 "price": { 59 "amount": "60.00", 60 "currency": "GBP" 61 }, 62 "categories": [ 63 ["Camping & Outdoor", "Lighting", "Lanterns"] 64 ] 65 } 66 ], 67 "discounts": [ 68 { 69 "displayName": "10% Off Subtotal", 70 "amount": { 71 "amount": "10.00", 72 "currency": "GBP" 73 } 74 } 75 ], 76 "taxAmount": { 77 "amount": "22.00", 78 "currency": "GBP" 79 }, 80 "shippingAmount": { 81 "amount": "20.00", 82 "currency": "GBP" 83 } 84 }