New Purchase OrderUpdated a month ago
This message is responsible for providing you with the details on new orders to be fulfilled.
Folder Location
This file will be generated in real-time as orders are created and saved to “outbox”. Once successfully processed, you should move the file to the “outbox_archive” folder.
Version
This version is “1_3”. Released on 31st July 2019.
Filename Format
new_order-{version}-{yyyymmddhhmmssnnnnn}.csv
File Sections
- Header Record (1 per order)
- Detail Record (1 per order line, unlimited number per order)
- Checksum Record (1 per file)
File Contents
| Column Header | Section | Required | Type | Max Length | Notes |
1 | section | Header | Y | Text | 255 | Will always be “header” |
2 | supplier_code | Header | Y | Text | 8 | Our unique identifier for your supplier account |
3 | order_number | Header | Y | Text | 100 | Our unique identifier for the order |
4 | order_date | Header | Y | Date | N/A | Format: yyyy-MM-ddTHH:mm:ss |
5 | currency_iso_code | Header | Y | Text | 3 | Three-letter ISO currency code |
6 | brand | Header | Y | Text | 20 | The retail brand the customer ordered from. Should be used for branding purposes such as delivery note |
7 | delivery_contact | Header | Y | Text | 100 |
|
8 | delivery_company | Header | N | Text | 100 |
|
9 | delivery_address_1 | Header | Y | Text | 100 |
|
10 | delivery_address_2 | Header | N | Text | 100 |
|
11 | delivery_address_3 | Header | N | Text | 100 |
|
12 | delivery_address_4 | Header | N | Text | 100 |
|
13 | delivery_postcode | Header | Y | Text | 100 |
|
14 | delivery_country_code | Header | Y | Text | 3 | Three-letter ISO country code |
15 | delivery_phone_number | Header | N | Text | 100 |
|
16 | delivery_email | Header | N | Text | 100 |
|
17 | delivery_notes | Header | N | Text | 255 | Notes for the carrier made by the retailer or customer |
18 | delivery_cost | Header | N | Decimal | N/A | Delivery charge for this order |
19 | carrier | Header | N | Text | 255 | Nominated carrier to be used for delivery |
20 | carrier_service | Header | N | Text | 255 | Nominated carrier service to be used for delivery. For expected values, see Carriers |
21 | supplier_notes | Header | N | Text | 255 | Notes for the supplier made by the retailer |
22 | spare_field_1 | Header | N | Text | 255 |
|
23 | spare_field_2 | Header | N | Text | 255 |
|
| Column Header | Section | Required | Type | Max Length | Notes |
1 | section | Detail | Y | Text | 255 | Will always be “detail” |
2 | line_ref | Detail | Y | Text | 20 | Our unique identifier for the line within the order |
3 | supplier_sku | Detail | Y | Text | 255 | Your unique identifier for the product/service |
4 | retailer_sku | Detail | Y | Text | 255 | Our unique identifier for the product/service |
5 | warehouse | Detail | Y | Text | N/A | The warehouse postcode (without spaces) where the stock is held. |
6 | grade | Detail | Y | Text | 3 | Grading scale 100 - New |
7 | quantity | Detail | Y | Numeric | N/A | Number of products ordered |
8 | unit_price | Detail | Y | Decimal | N/A | Cost price for a single unit excluding tax |
9 | net | Detail | Y | Decimal | N/A | Quantity x Net |
10 | tax_rate | Detail | Y | Numeric | N/A | The applicable tax rate for this line as a percentage |
11 | tax | Detail | Y | Decimal | N/A | The total amount of tax payable for this line |
12 | gross | Detail | Y | Decimal | N/A | Net + Tax |
13 | expected_despatch_date | Detail | N | Date | N/A | Format: yyyy-MM-dd |
14 | expected_delivery_date | Detail | N | Date | N/A | Format: yyyy-MM-dd |
15 | spare_field_1 | Detail | N | Text | 255 |
|
16 | spare_field_2 | Detail | N | Text | 255 |
|