Back

Shipments can be used to create partial shipments or distributions. For each shipment, some or all of an item's quantity can be allocated to it. Shipping labels, invoices and packing slips can be printed for each shipment and will calculate quantities and prices appropriately.


Shipments can be used to create actual shipments and retrieve rates with live carriers via the Shippo integration.


Shipments - Importing Shipments


Step     Action
  1.       Hover mouse over the downward arrow icon on right-hand side of Shipments and click Import.


  A Shipment Import modal window will open.



2.        Select {Choose File}. A File Upload modal window will open. 


           Note: For more information on creating your shipments file for import, refer 

           to the Shipments .CSV section below.

  3.       Locate file on computer to be imported and select {Open}. The name of the 

            file to be imported will appear next to the {Choose File} button.


  4.       Select {Import}. A results window will pop-up to confirm records imported 

            successfully.


Tips for Formatting Shipments .CSV for Import


The following guidelines should be noted when creating your Shipments .CSV file for import:

  • 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, the Origin Location will default to your company's billing address name and location as set on Settings > Admin > Account. Only the Billing and Destination Location are entered on the Shipments .CSV for import.
  • 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).


Validation of the import file will fail if any of the following information is not correctly provided:

  • Parcel dimension (L, H, W)
  • Parcel mass units (not provided or unable to find a match)
  • Parcel dimension units (not provided or unable to find a match)
  • Parcel Order Item allocation is not provided (t least 1 Order Item must be allocated)



FieldIs Field RequiredAdditional DetailsField Value FormatMax 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
  • DateTime object
  • Accepted formats:

    • MM-DD-YYYY

    • MM.DD.YYYY

    • MM/DD/YYYY

    • DD-MM-YYYY

    • DD.MM.YYYY

    • DD/MM/YYYY

  • 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




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
  • Integer
  • Max value is 2147483647
Parcel LengthYes
  • Only four decimal places are allowed
  • Decimal
  • Max value is 9,999.9999
Parcel WidthYes
  • Only four decimal places are allowed
  • Decimal
  • Max value is 9,999.9999
Parcel HeightYes
  • Only four decimal places are allowed
  • Decimal
  • Max value is 9,999.9999

Parcel Mass Units

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


Quantity1Yes
  • 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-10Yes (If there is an OrderItem 2-10)
  • Used for allocating additional order item quantities to the parcel