| A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | Header | Format | Mandatory | Maximum length | Notes | Example | ||||||||||||||||||||
2 | client_number | String | Yes | 3 | Your client number, this number will be provided to you by our team | 019 | ||||||||||||||||||||
3 | service_name | String | Yes | 16 | One of [delivery_sameday, delivery_nextday, collect, swap] | delivery_nextday | ||||||||||||||||||||
4 | order_id | String | No | 25 | The end-customer friendly order id | 12345 | ||||||||||||||||||||
5 | package_id | String | Yes | 25 | Your unique package identifier UNIQUE per client account. | ITEM-600119525 | ||||||||||||||||||||
6 | transport_id | String | Yes | 45 | Barcode value Should be UNIQUE globally (if you don't have the barcode value yet, please specify the value {client_number}-{package_id} instead) | BN7000Z | ||||||||||||||||||||
7 | sender_name | String | Yes | 40 | Name of package's sender | Retailer Name | ||||||||||||||||||||
8 | weight | Integer | Yes | 10 | Weight of the package in kilogramme (kg), using dot as a decimal separator | 4.2 | ||||||||||||||||||||
9 | length | Integer | No* | 10 | Length of the package in centimeter (cm), using dot as a decimal separator | 100 | ||||||||||||||||||||
10 | width | Integer | No* | 10 | Width of the package in centimeter (cm), using dot as a decimal separator | 100 | ||||||||||||||||||||
11 | height | Integer | No* | 10 | Height of the package in centimeter (cm), using dot as a decimal separator | 100 | ||||||||||||||||||||
12 | package_type | String | No* | 10 | One of [ XXS, XS, S, MS, M, ML, L, XL, XXL, XXXL ] *Required if one of [length, width, height] is missing. | M | ||||||||||||||||||||
13 | delivery_date | String | No* | 10 | A datetime (ISO 8601) indicating when you want the package to be delivered. *Mandatory if you want to use several `service_name` or if you want this information to be displayed in end-customer notifications | 2019-12-20 | ||||||||||||||||||||
14 | delivery_slot_start | String | No* | 11 | Chosen delivery time slot in ISO 8601 format, in local time. Note that our system ignores any UTC offset provided. *Mandatory if you want to use several `service_name` or if you want this information to be displayed in end-customer notifications | 19:00 | ||||||||||||||||||||
15 | delivery_slot_end | String | No* | 11 | Chosen delivery time slot in ISO 8601 format in local time. Note that our system ignores any UTC offset provided. *Mandatory if you want to use several `service_name` or if you want this information to be displayed in end-customer notifications | 20:00 | ||||||||||||||||||||
16 | recipient_lastname | String | Yes | 50 | End-customer lastname (if you do not have the ability to split the name into first name and last name please duplicate the information in both fields) | smart | ||||||||||||||||||||
17 | recipient_firstname | String | Yes | 50 | End-customer firstname | oliver | ||||||||||||||||||||
18 | recipient_email | String | Yes | 50 | Without the special Google character "+" in the address string | o.smart@stuart.com | ||||||||||||||||||||
19 | recipient_mobile_phone | Integer | Yes | 15 | Mobile phone number following E.164 recommendation | +447447693141 | ||||||||||||||||||||
20 | recipient_address | String | Yes | 50 | House / building number and street | 239 Elmhurst Street | ||||||||||||||||||||
21 | recipient_address_floor | String | No | 50 | Floor number or apartment number | 3 | ||||||||||||||||||||
22 | recipient_address_digicode | String | No | 50 | Main entrance access code | 123A | ||||||||||||||||||||
23 | recipient_address_comment | String | No | 50 | Other additional details | Left door | ||||||||||||||||||||
24 | recipient_postcode | String | Yes | 8 | Postcode | SW4 6HH | ||||||||||||||||||||
25 | recipient_city | String | Yes | 40 | City | London | ||||||||||||||||||||
26 | recipient_country_code | String | Yes | 2 | One of [GB, FR, ES] | GB | ||||||||||||||||||||
27 | options | String | No | 100 | List of specific options applied to the package Separator: | Allowed value: - C25: age restricted items | C25 | ||||||||||||||||||||
28 | ||||||||||||||||||||||||||
29 | ||||||||||||||||||||||||||
30 | Additional rules (all documented here also) | |||||||||||||||||||||||||
31 | In addition to the above format, your file should follow some additional rules to be 100% compliant with our system. Your file should: | |||||||||||||||||||||||||
32 | 1) follows our naming convention below | |||||||||||||||||||||||||
33 | 2) uses ";" as fields separators | |||||||||||||||||||||||||
34 | 3) be UTF-8 encoded | |||||||||||||||||||||||||
35 | 4) uses CR/LF end of line | |||||||||||||||||||||||||
36 | Naming convention | |||||||||||||||||||||||||
37 | {client_number}_{date_of_the_day}_{file_number}_whateverextra.csv | |||||||||||||||||||||||||
38 | Your file name should: | |||||||||||||||||||||||||
39 | 1) have a unique name (unique in your whole server) | |||||||||||||||||||||||||
40 | 2) not use any space | |||||||||||||||||||||||||
41 | Examples: 017_2020-02-12_1.csv for the first file of the day uploaded by client 017 on the 12th of February 2020 | |||||||||||||||||||||||||
42 | ||||||||||||||||||||||||||
43 | ||||||||||||||||||||||||||
44 | ||||||||||||||||||||||||||
45 | ||||||||||||||||||||||||||
46 | ||||||||||||||||||||||||||
47 | ||||||||||||||||||||||||||
48 | ||||||||||||||||||||||||||
49 | ||||||||||||||||||||||||||
50 | ||||||||||||||||||||||||||
51 | ||||||||||||||||||||||||||
52 | ||||||||||||||||||||||||||
53 | ||||||||||||||||||||||||||
54 | ||||||||||||||||||||||||||
55 | ||||||||||||||||||||||||||
56 | ||||||||||||||||||||||||||
57 | ||||||||||||||||||||||||||
58 | ||||||||||||||||||||||||||
59 | ||||||||||||||||||||||||||
60 | ||||||||||||||||||||||||||
61 | ||||||||||||||||||||||||||
62 | ||||||||||||||||||||||||||
63 | ||||||||||||||||||||||||||
64 | ||||||||||||||||||||||||||
65 | ||||||||||||||||||||||||||
66 | ||||||||||||||||||||||||||
67 | ||||||||||||||||||||||||||
68 | ||||||||||||||||||||||||||
69 | ||||||||||||||||||||||||||
70 | ||||||||||||||||||||||||||
71 | ||||||||||||||||||||||||||
72 | ||||||||||||||||||||||||||
73 | ||||||||||||||||||||||||||
74 | ||||||||||||||||||||||||||
75 | ||||||||||||||||||||||||||
76 | ||||||||||||||||||||||||||
77 | ||||||||||||||||||||||||||
78 | ||||||||||||||||||||||||||
79 | ||||||||||||||||||||||||||
80 | ||||||||||||||||||||||||||
81 | ||||||||||||||||||||||||||
82 | ||||||||||||||||||||||||||
83 | ||||||||||||||||||||||||||
84 | ||||||||||||||||||||||||||
85 | ||||||||||||||||||||||||||
86 | ||||||||||||||||||||||||||
87 | ||||||||||||||||||||||||||
88 | ||||||||||||||||||||||||||
89 | ||||||||||||||||||||||||||
90 | ||||||||||||||||||||||||||
91 | ||||||||||||||||||||||||||
92 | ||||||||||||||||||||||||||
93 | ||||||||||||||||||||||||||
94 | ||||||||||||||||||||||||||
95 | ||||||||||||||||||||||||||
96 | ||||||||||||||||||||||||||
97 | ||||||||||||||||||||||||||
98 | ||||||||||||||||||||||||||
99 | ||||||||||||||||||||||||||
100 | ||||||||||||||||||||||||||