Skip to content

Importing Locations

To import locations, you must provide a CSV file containing the required location information.

The available columns for this table are:

ColumnDescription
codeRequired. Between 1 and 256 characters.
nameRequired. Between 1 and 30 characters.
street_addressRequired. Between 1 and 256 characters.
street_address2Optional. Maximum 256 characters.
townRequired. Between 1 and 256 characters.
countyOptional. Maximum 256 characters.
postcodeOptional. Maximum 256 characters.
countryRequired. A valid two-letter ISO 3166 country code.
moqOptional. Minimum order quantity. Numeric. Defaults to 0.
delivery_feeOptional. Numeric. Defaults to 0.
activeOptional. Boolean. Defaults to true.
customer_idOptional. The database ID (UUID) of an existing customer.
customer_codeOptional. The code of an existing customer. Bridge Column.
account_manager_idOptional. The database ID (UUID) of an existing user.
account_manager_emailOptional. The email address of an existing user. Bridge Column.

Customer

A customer is required for every location.

You can specify the customer using either:

  • customer_id
  • customer_code

If both columns are provided, customer_id takes precedence.

The customer_code column acts as a bridge column, allowing you to import data without needing to know the database IDs generated by Quick Docket in advance.

Account Manager

An optional account manager can be provided for locations but is not required.

You can specify the account manager using either:

  • account_manager_id
  • account_manager_email

If both columns are provided, account_manager_id takes precedence.

The account_manager_email column acts as a bridge column, allowing you to import data without needing to know the database IDs generated by Quick Docket in advance.

Example CSV

All columns

csv
code,name,street_address,street_address2,town,county,postcode,country,moq,delivery_fee,active,customer_id,customer_code,account_manager_id,account_manager_email
LOC001,Head Office,1 High Street,Unit 2,London,Greater London,SW1A 1AA,GB,100,15.00,true,6550e8400-e29b-41d4-a716-446655440000,CUST001,60e8400-e29b-41d4-a716-446655440000,sales@example.com

Required columns and customer_id

csv
code,name,street_address,town,country,customer_id
LOC001,Head Office,1 High Street,London,GB,6550e8400-e29b-41d4-a716-446655440000

Required columns and customer_code

csv
code,name,street_address,town,country,customer_code
LOC001,Head Office,1 High Street,London,GB,CUST001