Import File Example:
Customer Location Import File
Import FileRequirements
Import file should contain data on the customer locations to be loaded into the system.
Import file is a set of data divided by a comma: CSV (Eng. Comma separated values). If the system is properly configured for the CSV file, it can be opened and edited in Excel as a regular table, while in fact, the file is not a table.
Import File Headings
To create a new import file or use a ready-made template, when filling in the data sheet, use the column headers from the following Import file fields headings table:
Fields Headings | Specification | Description | Required | Length | Data Type | Example |
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. If several customer locations are associated with the same customer, it is recommended to include the customer name as prefix to the location name. The usual way of naming customer locations when importing them into the System is "customer name_postcode". | Mandatory | 255 | String | Big City (South) |
customerLocationAddress | Location address | A customer location address. | Mandatory | 255 | <Building Number><Street> <House>, <City>, <Postcode> | 68, Lombard Street, City of London, 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 | string.string.string | final.magma.tests |
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 |
startTime | Start of customer location availability time | "From…" time for each day when the location is ready to deal with orders drop off. | Optional | hh:mm | 07:15 | |
endTime | End of customer location availability time | "To..."time for each day when the location is ready to deal with orders drop off. | Optional | hh:mm | 21:30 | |
preferredDrivers | List of preferred drivers | One or several drivers preferred or only accepted when delivering to the location. | Optional | 255 | Array of (string) | Andy Smith |
contactNumber | Contact phone number at the client | The primary phone 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. If you have only one contact number for a customer location, you can use this field. If you need to import two contact numbers for a customer location, use the primaryNumber and secondaryNumber fields. | Optional | 255 | Number | 07926 297 600 |
contactEmail | Email of a contact person | Email of a contact person at the customer. Restrictions: this field 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 | ||
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 |
additionalTimePerVisit | Additional time per visit | The additional time (in minutes) to get to a customer location. | Optional | 10 | 00 | 15 |
fixedOperationDuration | Fixed operation duration | Time to be added to each order and considered while delivering orders. Drop off duration = Fixed operation duration+Drop duration per capacity unit.The same parameters are defined for the entire account. If specified both for account and for the particular customer location, the customer location values are preferred. | Optional | 10 | 00 | 15 |
dropDurationPerUnit | Drop duration per one capacity unit | The time for drop of one capacity unit at a customer location. | Optional | 10 | 00 | 15 |
pickupDurationPerUnit | Pickup duration per one capacity unit | The time for pickup of one capacity unit at a customer location. | Optional | 10 | 00 | 15 |
id | Customer reference number | The customer record reference number. Note: this field is equal to customerLocationGlobalId at the Order Import File. Column Names and Requirements. To avoid duplication and to ensure accuracy of geocoding, it is recommended to indicate the customer location id in the import file. For details, see Customer Location ID. | Optional | 64 | String | 2807d00452364ba6a |
webSite | Website address | Customer location public website. | Optional | String | ||
primaryNumber | Phone number of a contact person | The primary phone 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.If you have only one contact number for a customer location, you can use the contactNumber field. | Optional | 255 | Number | 07926 297 600 |
secondaryNumber | Phone number of a contact person | The secondary phone 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 |
isVerified | Location is verified | This field is responsible for the "Location is verified" check box in the "Locations". It shows if the location is verified or not. | Optional | Boolean | true / false | |
enableSMSNotification | Allow notification (SMS) | Shows that the customers should be notified/not notified by SMS about order delivery process. | Optional | Boolean | true / false | |
enableEMAILNotification | Allow notification (E-mail) | Shows that the customers should be notified/not notified by E-mail about order delivery process. | Optional | Boolean | true / false |