Service: Delivery π¦
User Rights: Read π
Section: Account βοΈ
This article walks you through the fields available for the order import file. It's divided into:
As the headings suggest, we recommends you to include the fields specified in the Recommended section π
Note: Not sure where to start? You can download our order import template here. We have three different to choose from π
Required fields
The most basic order file is required to contain the following information.
Required field | Example | Description |
external_ref |
| Unique order reference number |
customer-name |
| Name of the customer |
address |
| Customer address |
zip |
| Zipcode |
city |
| City |
deliverydate |
| Order delivery date |
time-window |
| Time window the customer has requested |
deliverygroup |
| Name of the Delivery Group in Last Mile the order belongs to |
inventory[0].name |
| Name of the item (at least one item is required) |
inventory[0].quantity |
| Number of items in the order |
Other fields
The following fields are available to include in your order import.
Available field | Example | Description |
external_id |
| External ID from your internal system |
| Customer email | |
mobile |
| Customer phone number |
address2 |
| Second address line |
country_code |
| Country code (ISO) |
entrycode |
| Entry code to the customer's building |
latitude |
| Latitude cordinates of the address |
longitude |
| Longitude cordinates of the address |
description |
| Description of the order |
notes |
| Notes to the driver |
delivery-requirements.delivery-in-person |
| If the order is not allowed to be left outside at the end customer, set this field to |
delivery-requirements.id-check | | If you want the end customer to show their ID upon delivery, set this field to |
baseServiceTime |
| Will add extra service time (minutes) to the order if it requires extra time for the driver. |
inventory.[0].weight |
| Weight of the inventory (kilograms) |
inventory.[0].width |
| Width of the inventory (cm) |
inventory.[0].height |
| Height of the inventory (cm) |
inventory.[0].length |
| Length of the inventory (cm) |
inventory.[0].type |
| Use this field if the order is for frozen goods. If not, leave the field blank. |
inventory.[0].serviceType |
| Specify if it's a delivery or pickup item. |
inventory.[0].articles.[0].name |
| Name of articles tied the item. |
inventory.[0].articles.[0].quantity |
| Number of articles with the name tied to the item. |
Recommended
We recommend importing the order with the following fields.
Field | Example | Description |
external_ref |
| Unique order reference number |
customer-name |
| Name of the customer |
mobile |
| Customer phone number |
| Customer email | |
address |
| Customer address |
zip |
| Zipcode |
city |
| City |
deliverydate |
| Order delivery date |
time-window |
| Time window the customer has requested |
deliverygroup |
| Name of the Delivery Group in Last Mile the order belongs to |
inventory.[0].name |
| Name of the product |
inventory.[0].quantity |
| Number of items in the order |
inventory.[0].type |
| Use this field if the order is for frozen goods. If not, leave the field blank. |
inventory.[0].weight |
| Weight of the inventory (kilograms) |