Notes:

  • Column names must follow the exact same naming scheme as provided or the import upload will fail.  
  • Each row in the .csv will represent a shipping parcel with allocations.
  • When creating a shipment automatically set the Origin Location - follow same logic as today (Site Owner's Default Billing Address Name and Location).
  • Region and Country are case sensitive and must be an exact match to those entered in your Location Settings (See Locations).
  • Multiple Tax Rates can be applied (Tax Rates need to be separated in a semi-colon array).



FieldIs Field Required?Additional DetailsMax Characters/Values
Shipment NameYes
  • Used to locate existing shipments
    • If no match is found using Shipment Name, a new shipment will be created for that row.
100
Shipment DateYes
  • If the Shipment Date is set to a value in the past, import will FAIL
  • Must match the format that is set in the configuration options
  • Can be any valid date
Shipping NoteYes
  • No size limit

Shipping Is Taxable

Yes
  • Must be TRUE or FALSE

Tax RateYes
  • Must match an already existing tax type or the importer will FAIL
  • Multiple Tax Rates can be applied. Must be separated by ; with no spaces

Example: PST;HST

50
Billing Use As CustomerYes
  • Must be Customer Location or Address Location
  • If field value not correct, import will FAIL

Billing Contact NameYes

  • Refers to the Billing Contact Name


Billing Location Name

Yes
255

Billing Location Address

Yes
500

Billing Location City

Yes
50

Billing Location Region

Yes
  • Must match abbreviated Prov/State in the system of import will FAIL
  • If region is not in the Settings > Customers > Locations, you will need to add the Name and Abbreviation prior to importing

255

Billing Location Country

Yes
  • Must be a valid country name or import will FAIL

255

Billing Location Zip/Postal Code

Yes
20
Destination Use As CustomerYes
  • Must be Customer Location or Address Location
  • If field value not correct, import will FAIL

Destination Contact NameYes
  • Refers to the Destination Contact Name

Destination Location Name

Yes
  • Refers to the name of the Location object being created containing the location information about the destination address
255

Destination Location Address

Yes
500

Destination Location City

Yes
50

Destination Location Region

Yes
  • Must match abbreviated Prov/State in the system of import will FAIL
  • If region is not in the Settings > Customers > Locations, you will need to add the Name and Abbreviation prior to importing

255

Destination Location Country

Yes
  • Must be a valid country name or import will FAIL
255

Destination Location Zip/Postal Code

Yes
  • No limit on size / format
20
Parcel NameYes
150

Parcel Dimension Units

Yes
  • Max value is 2147483647
Parcel LengthYes
  • Only four decimal places are allowed
  • Max value is 9,999.9999
Parcel WidthYes
  • Only four decimal places are allowed
  • Max value is 9,999.9999
Parcel HeightYes
  • Only four decimal places are allowed
  • Max value is 9,999.9999

Parcel Mass Units

Yes
  • Max value is 2147483647
Parcel WeightYes
  • Only four decimal places are allowed
  • Max value is 9,999.9999
OrderItem1No
  • Must match an existing order item number or import will FAIL
  • A least 1 order item must be included in the parcel

Quantity1No
  • refers to the quantity of the order item allocated to the parcel
  • value required or import will FAIL

OrderItem2-10No
  • Used for adding additional order items to the parcel

Quantity2-10
No
  • Used for allocating additional order item quantities to the parcel