Skip to content

Importing Orders

To import orders, you must provide a CSV file containing the required order information.

The available columns for this table are:

ColumnDescription
order_numberRequired. Between 1 and 10 characters.
purchase_order_numberOptional. Maximum 256 characters.
statusRequired. Must be a valid order status.
delivery_feeOptional. Numeric. Defaults to 0.
ordered_atRequired. Date.
scheduled_delivery_dateOptional. Date.
delivered_atOptional. Timestamp.
notesOptional. Maximum 65,535 characters.
delivery_instructionsOptional.
location_idOptional. The database ID (UUID) of an existing location.
location_codeOptional. The code of an existing location. 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.

Location

A location is required for every order.

You can specify the location using either:

  • location_id
  • location_code

If both columns are provided, location_id takes precedence.

The location_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 account manager is required for every order.

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.

Order Statuses

The following order statuses are valid:

Status
pending
processing
ready_for_delivery
in_transit
delivered
cancelled

Timestamp Format

Timestamps must be provided using the ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

Example:

text
2026-01-01T09:00:00Z

The T separates the date and time, and the Z indicates that the time is provided in UTC.


Date Format

Dates must be provided using the ISO 8601 date format:

YYYY-MM-DD

Example:

text
2026-01-08

Example CSV

All columns

csv
order_number,purchase_order_number,status,delivery_fee,ordered_at,scheduled_delivery_date,delivered_at,notes,delivery_instructions,location_id,location_code,account_manager_id,account_manager_email
ORD001,PO12345,processing,15.00,2026-07-28T10:30:00Z,2026-07-29,2026-07-29T14:15:00Z,Customer requested early delivery,Leave at rear entrance,550e8400-e29b-41d4-a716-446655440000,LOC001,660e8400-e29b-41d4-a716-446655440000,sales@example.com

Required columns and bridge columns

csv
order_number,status,delivery_fee,ordered_at,location_code,account_manager_email
ORD001,processing,15.00,2026-07-28T10:30:00Z,LOC001,sales@example.com