Order Export Formats
The following section describes the order export formats available under the Print menu in the Order resource.
Excel and CSV Format
The properties used for both Excel and CSV are common and are described below. Each order is comprised of an order header (OH) row followed by order item (OI) rows.
Order Header (OH) Properties
Each order header is made up of 36 fields. The table below indentifies the property in each field by column number.
| Col | Example Data | Description |
|---|---|---|
| 1 | "OH" | Record type OH = Order Header |
| 2 | "6D6F55..." | The internal system order id |
| 3 | "161420" | The host order reference |
| 4 | "" | A brand order reference (where used) |
| 5 | "2020-08-27T08:35:04" | The date the order was placed |
| 6 | "Shipped" | The order status |
| 7 | "Main" | The warehouse code |
| 8 | "Mrs" | The billing contact title |
| 9 | "Jane" | The billing contact forename |
| 10 | "Smithers" | The billing contact surname |
| 11 | "" | The billing company name (if specified) |
| 12 | "38 Park Road South" | The billing address line 1 |
| 13 | "" | The billing address line 2 |
| 14 | "" | The billing address line 3 |
| 15 | "Bedford" | The billing address town |
| 16 | "Bedfordshire" | The billing address county |
| 17 | "MK41 8GH" | The billing address postcode |
| 18 | "GB" | The billing address country code |
| 19 | "Mrs" | The shipping contact title |
| 20 | "Jane" | The shipping contact forename |
| 21 | "Smithers" | The shipping contact surname |
| 22 | "" | The shipping company name (if specified) |
| 23 | "38 Park Road South" | The shipping address line 1 |
| 24 | "" | The shipping address line 2 |
| 25 | "" | The shipping address line 3 |
| 26 | "Bedford" | The shipping address town |
| 27 | "Bedfordshire" | The shipping address county |
| 28 | "MK41 8GH" | The shipping address postcode |
| 29 | "GB" | The shipping address country code |
| 30 | "" | The expected delivery date |
| 31 | "" | Date the order was sent to the warehouse (if applicable) |
| 32 | "2020-08-27T15:35:04" | The ship date |
| 33 | "DHL" | The Carrier name/service |
| 34 | "TRACKREF12343" | The tracking reference |
| 35 | 0.00 | Shipping gross cost |
| 36 | 0.00 | Shipping tax |
Order Item (OI) Properties
Each order item is made up of 16 fields. The table below indentifies the property in each field by column number.
| Col | Example Data | Description |
|---|---|---|
| 1 | "OI" | Record type OI = Order Item |
| 2 | "9F9D36..." | The internal system order item id |
| 3 | "635246" | The host order item reference |
| 4 | "ACC" | The status of the order item |
| 5 | "Big Red Dress" | The item product title |
| 6 | "BRDRESS001S" | The item product variant code |
| 7 | "9999999999999" | The item product variant barcode |
| 8 | "Red" | The item product variant colour |
| 9 | "S" | The item product variant size |
| 10 | "GBP" | The item sell currency |
| 11 | 1 | The item quantity |
| 12 | 24.00 | The item price |
| 13 | 20.00 | The item line net value |
| 14 | 4.00 | The item line tax value |
| 15 | 24.00 | The item line gross value |
| 16 | 0.00 | The line item discount (if any) |
JSON Format
The JSON export outputs all selected orders in a single file. An example JSON order file is shown below with single order:
{
"orders": [
{
"id": "6D6F559418F9E640B0BA01270FD546A6",
"hostOrderRef": "161420",
"brandOrderRef": "",
"orderDate": "0000-00-00T00:00:00",
"status": "Shipped",
"warehouseCode": "Main",
"billAddress": {
"forename": "Joan",
"surname": "Smithers",
"company": "",
"line1": "34 Glebe Cresent",
"line2": "",
"town": "Bedford",
"county": "Bedfordshire",
"postcode": "Mk41 8GH",
"country": "United Kingdom",
"countryCode": "GB",
"phone": "07973675356",
"email": "user@hotmail.com"
},
"shipAddress": {
"id": 161316,
"forename": "Joan",
"surname": "Smithers",
"company": "",
"line1": "82 Llwyn Castan",
"line2": "",
"town": "Bedford",
"county": "Bedfordshire",
"postcode": "Mk41 8GH",
"country": "United Kingdom",
"countryCode": "GB",
"phone": "07973675356",
"email": "user@hotmail.com"
},
"deliveryDate": "",
"sentToWHDate": "2020-08-27T08:35:04",
"shipDate": "",
"carrier": "DHL",
"trackingRef": "161420_Tracking",
"shippingGross": 0.00,
"shippingTax": 0.00,
"orderItems": [
{
"id": "5FC491E214424243AFEC784B5656EE31",
"hostItemRef": "",
"status": "ACC",
"article": "Fur Trim Duffle Coat",
"sku": "KL1538138__D",
"barcode": "5052011763523",
"colour": "Camel",
"size": "12",
"currency": "",
"orderQty": 1,
"itemPrice": 62.5,
"lineNet": 62.5,
"lineTax": 6.25,
"lineGross": 75
},
{
"id": "01FAE4BE74C17340824E5D89F2D1A881",
"hostItemRef": "",
"status": "ACC",
"article": "Longer Line Denim Skirt With Belt Detail",
"sku": "KL1649003__D",
"barcode": "5052011811880",
"colour": "Blue",
"size": "12",
"currency": "",
"orderQty": 1,
"itemPrice": 33.34,
"lineNet": 33.34,
"lineTax": 3.33,
"lineGross": 40
},
{
"id": "F182D81235226B469D1B2CF6DA46A095",
"hostItemRef": "",
"status": "ACC",
"article": "Flamingo Bardot Jumpsuit",
"sku": "KL1285027__C",
"barcode": "5052011684194",
"colour": "Navy",
"size": "10",
"currency": "",
"orderQty": 1,
"itemPrice": 37.5,
"lineNet": 37.5,
"lineTax": 3.75,
"lineGross": 45
}
]
}
]
}
Royal Mail Export Format
The following export format is designed for use with Royal Mail systems. It is designed with all required address elements with a few other fields for reference purposes.
| Col | Example Data | Description |
|---|---|---|
| reference | "166775" | This is the host order reference and can be used in conjunction with the carrire and tracking ref to update the tracking details via the order dispatch file import feature |
| carrier | "Royal Mail" | The internal system order id |
| trackingRef | "" | This field will be blank on export but can be fileld for re-importation |
| title | "Mrs" | The shipping contact title |
| firstname | "Jane" | The shipping contact forename |
| lastname | "Smithers" | The shipping contact surname |
| company | "" | The shipping company name (if specified) |
| address1 | "38 Park Road South" | The shipping address line 1 |
| address2 | "" | The shipping address line 2 |
| address3 | "" | The shipping address line 3 |
| town | "Bedford" | The shipping address town |
| county | "Bedfordshire" | The shipping address county |
| postcode | "MK41 8GH" | The shipping address postcode |
| countryCode | "GB" | The shipping address country code |
| telephone | "" | The shipping contacts telephone number |
| "" | The shipping contacts email address | |
| orderDate | "2020-08-27T15:35:04" | The order date |
| status | "Dispatched" | The current status of the order |