Import shipments into
Shiptheory
from a CSV file using the
Shipping API.
This is an unofficial tool and is offered on an as-is basis.
Line 1 of your CSV must contain the field names listed below (The order
of fields is not important).
Where your shipment contains more than one product, duplicate all
rows of the shipment for each product line.
You can download a CSV template file here: template.csv
You can download an example CSV file here: example.csv
Column Name | Example | Description |
---|---|---|
reference ** | A123 | required - Your unique reference for this shipment. This cannot be blank or 0. |
reference2 ** | B789 | required - A second reference (doesn't need to be unique). This cannot be blank or 0. |
shipment_weight ** | 2.32 | required - The weight of the total shipment in kilograms. This cannot be 0. |
shipment_parcels ** | 1 | required - The number of boxes or labels required as a full number. This cannot be 0. |
shipment_value ** | 123.45 | required - The shipment monetary value. This cannot be 0. |
shipment_currency | EUR | 3-character currency ISO code, e.g. "GBP" for Pound Sterling.
A list of currency codes can be found on Wikipedia here. |
delivery_service | 186 | The Shiptheory delivery service ID. If this is not provided or you pass a delivery service that does not exist, the shipment will be processed through any shipping rules set on your Shiptheory account. |
enhancement_id | 46 | Carrier Enhancement. Only required when passing a delivery_service. |
format_id | 60 | Carrier format. Only required when passing a delivery_service. |
instructions | Gate code is C8649 | Any delivery instructions to pass to the courier. |
channel_shipservice_name | Standard delivery | A description of the shipping option chosen by the customer when placing the order. |
recipient_company | First Choice Ties | The recipient's company name. |
recipient_first_name | Brandon | required - The recipient's first name. |
recipient_last_name | Bradshaw | required - The recipient's last name. |
recipient_address_line_1 | 79 Park Row | required - Delivery address line 1. |
recipient_address_line_2 | Delivery address line 2. | |
recipient_address_line_3 | Delivery address line 3. | |
recipient_city | Edgbaston | required - Delivery city. |
recipient_county | Warwickshire | Delivery county or state. |
recipient_country | GB | required - 2-character delivery country ISO code,
e.g. "GB" for United Kingdom. A list of country codes can be found on Wikipedia here. |
recipient_postcode | B15 4PA | required - The delivery postal or zip code. |
recipient_telephone | 01632 960542 | The recipient's telephone number. |
recipient_mobile | 07776 808238 | The recipient's mobile number. |
recipient_email | brandon@firstchoiceties.com | The recipient's email address. |
product_name | Copy Paper A4 80gsm 500 Sheets Pack | Name of the product being sent. This cannot be blank. |
product_sku | A4REAM500 | required - SKU of the product being sent. This cannot be blank or 0. |
product_barcode | 8723255485 | Barcode (UPC, EAN, ISBN, ...) of the product being sent. |
product_value | 4.82 | required - The price of the product to the customer. This cannot be blank or 0. |
product_weight | 2.1 | required - The weight of the individual product in kilograms. This cannot be blank or 0. |
product_quantity | 1 | required - The quantity of the product in the shipment. This cannot be blank or 0. |
product_commodity_code | 4821101000 | UN commodity code - required for shipping internationally |
product_commodity_description | Ream of paper | Commodity description - required for shipping internationally |
product_commodity_manucountry | GB | Country of manufacture - required for shipping internationally |
product_commodity_composition | Paper | Composition and/or materials of the item being sent - required for shipping internationally |
** These fields are can be auto-generated if by the import tool by selecting "Auto-fill missing information" when uploading your CSV file.
If checked, this will auto-complete the following fields, where empty:
• reference
• reference2
• shipment_weight
• shipment_parcels
• shipment_value