When filling out your data sheet, use the column names from this table to make your import file compatible with MaxOptra.
Standard Import File Columns
Column Name | Specification | Description | Required | Length | Data Type | Example |
Standard Import File | ||||||
orderReference | Order reference | Other integrated system reference Note Order reference should not include the «*» symbol if it is intended to use getOrderStatuses method (REST API) in future | Optional | 64 | String | 123Abc |
date | Planning date | The date when a delivery or collection should be done | Optional | dd/mm/yyyy | 30/01/2014 | |
distributionCentreName | Name of a distribution centre | A distribution centre where routes should start. If Territories are set in MaxOptra, when importing orders, it is enough to specify a location address and MaxOptra, using territories, will refer an order to an appropriate DC. | Mandatory (if there are several distribution centres configured for a selected account and the territories are not set in MaxOptra) | 255 | String | MaxOptra DC |
customerLocationName | Name of a customer location | As a rule, the name is selected to specify this place and usually includes the short name of a company. | Mandatory | 255 | <Client Name><Building Number><Street> <House>, <City> | Big City Ltd, 68, Lombard Street, City of London |
customerLocationAddress | Location address | A customer location address. Note Maxoptra supports the What3Words geocoding format. If you would like to use this, contact the MaxOptra Support Team. After that you can enter the three-word code as location address. | Mandatory | 255 | <Postcode> or w3wstring.w3wstring.w3wstring | EC3V 9LJ |
w3wAddress | Location address | Maxoptra supports the What3Words geocoding format. If you would like to use this, contact the MaxOptra Support Team. After that you can enter the three-word code as location address. For more details, see What3Words address. | Optional | 255 | w3wstring.w3wstring.w3wstring | final.magma.tests |
customerLocationGlobalId | Global identifier of a customer location | A customer location unique identifier. It can be used to update the customer location parameters. For more information, see Customer Location ID. | Optional | 64 | String | 2807d00452364ba6a |
latitude | Location latitude | A customer location latitude. Used to specify the location when the customer location address is not exact. | Optional | 20 | [-90;90] | 55.755831 |
longitude | Location longitude | A customer location longitude. Used to specify the location when the customer location address is not exact. | Optional | 20 | [-180;180] | 37.617673 |
clientName | Name of the client | Customary, it's the name of a company to identify a customer among the other customers. | Optional | 255 | String | Big City Ltd |
contactPerson | Contact person at the client | The name of a person at the client to contact with. | Optional | 255 | String | Paul Carter |
contactNumber | Contact telephone number at the client | The telephone number of a person at the client to contact with. We recommend you to use the international number format: +, country code, city code, customer number. | Optional | 255 | Number | 07926 297 600 |
contactEmail | Email of a contact person | Email of a contact person at the customer. Restrictions: this column supports only Latin characters, numerical symbols, hyphen, low line, @, and dot. It is possible to specify several e-mail addresses to receive notifications. When specifying e-mail addresses in your import file you should separate them using a semicolon - ; | Optional | 64 | ||
capacity | Order weight | One of two possible order parameters: order weight (specified in kg) or any other capacity unit (boxes, pallets, items). | Optional | Number | 1000 or 24.7 | |
volume | Order volume | Second order parameter: order volume specified in m3. | Optional | Number | 99 or 2.5 | |
vehicleRequirements | Vehicle requirements | This column substitutes types and attributes and is compatible with them. Using vehicle requirements it is possible to assign a driver for delivery point, but you cannot do it through the orders import file. It is possible to set several requirements separated by commas. | Optional | 255 | String | Chilled, Side-loading |
dropWindowStart | Order window start | The earliest delivery time. This parameter does not require to specify the date. Used with dropWindowEnd parameter they specify the time window for an order delivery/pickup. If not specified,dropWindowStart will be taken from customer location settings by default | Optional | hh:mm | 07:15 | |
dropWindowEnd | Order window end | The latest time when an order delivery should be completed. This parameter does not require to specify the date. If not specified,dropWindowEnd will be set from customer location settings by default. This column is also used for overnight routes (see Overnight section) | Optional | hh:mm | 21:30 | |
additionalInstructions | Additional Instructions | Any additional details or remarks to be considered while delivering or collecting orders. | Optional | 255 | String | call 30 min before delivery |
dropDuration | Order estimated duration | The loading / unloading operation duration in minutes. If not specified this time will be selected from the account default values. Only nonzero whole values are acceptable. | Optional | 10 | 00 | 15 |
task | Order type | It can be a delivery order or a collection order. If not specified or specified as "Delivery" then an order is considered to be delivered. If an order specified as "Collection" then it is considered to be pickuped. | Optional | Collection | ||
cost | Order price | Order price that should be paid by a customer for the order delivery and so on (in the currency of the account). Spaces in sum are not acceptable. Broken values should be entered comma-separated | Optional | 255 | Number | 25 |
priority | The order delivery priority | The order priority, denoted by numbers or can be blank: 
 | Optional | 1 or 2 or 3 | 1 or 2 or 3 | 2 |
stopSequence | Stop sequence | An order allocation within the route. | Optional | String | First/Any/Last | |
schedulingZoneName | Name of territory | The name of the planning territory. In MaxOptra, you can draw territories on the map in the form of polygons and apply them to the orders. The orders can belong to the pre-existing regions as well. The regions may overlap, so, when importing orders, all orders should be tied to correct regions. When drawing the territories, a user sets their names. These names should be specified in this column in an import file. If the name is not specified and an order corresponds to several territories, then an order will be assigned to a territory that was created the first. | Optional | 255 | String | North |
enableSMSNotification | Allow notifications (SMS) | Shows that the customers should be notified/not notified about order delivery process by SMS. | Optional | Boolean | true / false | |
enableEMAILNotification | Allow notifications (E-mail) | Shows that the customers should be notified/not notified about order delivery process by E-mail. | Optional | Boolean | true / false |
Column Names for Order Items
Column Name | Specification | Description | Required | Length | Data Type | Example |
orderItems | Specifying goods within one order | Order items are used to specify goods within an order. This may include barcode, cost, total amount, description, delivery status etc. This column can have the same values for identical goods. Possible format:
Record format: [Name]barcode|externalID|price per unit|planned quantity|description | Optional | [Hennesy OX 1958 Part 1 Box 2 of 2] 1008105964500552|GD4561321|320|12|It's fragile;[Kraken for Ilona box 1 of 1] 2521250862053500|||50|Leave the box at the door; |
Column Names for Pickup & Delivery Orders
Column Name | Specification | Description | Required | Length | Data Type | Example |
consignmentReference | Consignment reference | Displays the reference number of a pair of Pickup&Delivery orders (linked orders). This number should be provided from the client's CRM. Only two orders can be linked under one consignment reference. Consignment reference should be unique for the whole account. For more details, see Pickup & Delivery . | Optional | number | 111 | |
consignmentLinkType | Displays the type of link, which is “PickupAndDelivery”. | Optional | string | PickupAndDelivery |
Column Names for Multi-day Planning
Column Name | Specification | Description | Required | Length | Data Type | Example |
orderDateFrom  | Order window start | The start date, when the customer is available to receive the order. Starting from this day you can perform plans to deliver the order to this customer. This parameter is used in conjunction with the_o_rderDateTo_column. It involves the use of the _orderTimeFrom1 and orderTimeFrom2 _columns (single- and multi-drop windows for Multi-day Optimisation). | Optional | dd/mm/yyyy | 12/12/2019 | |
orderDateTo  | Order window end | The end date, when the customer is available to receive the order. It indicates the deadline date, when you can deliver this order to the customer. It involves the use of the _orderTimeFrom1 and orderTimeFrom2 _columns (single- and multi-drop windows for Multi-day Optimisation). | Optional | dd/mm/yyyy | 12/12/2019 | |
orderTimeFrom1  | Order window start | This column is used in two cases:1) For one-day planning to specify the first multi-drop time window (the first acceptable timeframe for the order delivery or pickup). If used, it will require the second multi-drop window to be indicated (orderTimeFrom2);2) For multi-day optimisation. It may be used alone or with oderTimeFrom2 column to indicate the single- or multi-drop windows for multi-day orders | Optional | hh:mm | 06:00 | |
orderTimeTo1  | Order window end | This column is used in two cases: | Optional | hh:mm | 23:59 | |
orderTimeFrom2  | Order window start | The start of the second Multi drop time window. The window specifies the additional time when the order delivery or pickup can be started during the same day. It is also used to set the multi-drop windows for Multi-day Optimisation. | Optional | hh:mm | 06:00 | |
orderTimeTo2  | Order window end | The end of the second Multi drop time window. This parameter specifies the deadline when order can be completed within the second time window during the same day. It is also used to set the multi-drop windows for Multi-day Optimisation. | Optional | hh:mm | 23:59 |
Column Names for Overnight Shifts
Column Name | Specification | Description | Required | Length | Data type | Example |
dropWindowStart  _ | Order window start | The start of an order time window Example: You have an order to be delivered from 21:00 of 21/11/2017 till 04:00 0f 22/11/2017. For such order, specify the order date as 21/11/2017 and the order start time as 21:00. Specify the order end time as 04:00 of the same date. | Optional | hh:mm | 21:00 | |
dropWindowEnd  _ | Order window end | The end of an order time window. Time ranges for overnight runs are indicated in the dropWindowEnd column. | Optional | hh:mm | 21:00 |
Column Names for Import of Pre-allocated Orders
If you want toimport a ready schedule to MaxOptra, you need to fill out the following columns. See example in Import of Pre-allocated Orders from CSV-file.
Column Name | Specification | Description | Required | Length | Data Type | Example |
runNumber | Run number | Run number in the externally built schedule in case of importing scheduled routes. | Optional | 1 | Numbers | 1 |
sequenceInRun | Order sequence | Order sequence in the run in case of importing scheduled routes. | Optional | 255 | Numbers | 10 |
allocationDate | Planning date | The date of the run in externally built schedule. Delivery or pickup date. This column is mandatory in case_runNumber_or/and_sequenceInRun_columns are specified. | Mandatory | Date | dd/mm/yyyy | 23/10/2014 |
vehicleName | Vehicle name | Vehicle name or registration number. This column is mandatory if runNumber or/and sequenceInRun columns are specified, and if _vehicleExternalID is not specified. | Mandatory | 255 | String | FGZ 5875 |
vehicleExternalID | External identifier of a vehicle | Vehicle external ID is mandatory only if the vehicleName is not specified, otherwise it is optional. | 255 | String | FGZ 5875 |