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 | A 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 | A Shiptheory carrier enhancement ID. This will only be applied if a delivery_service is also provided. |
| enhancements | [24,135] | If multiple Shiptheory carrier enhancement IDs are required, they should be declared as comma-separated values between square brackets as shown. These will only be applied if a delivery_service is also provided. |
| format_id | 60 | A Shiptheory carrier format ID. This will only be applied if a delivery_service is also provided. |
| 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. |
| shipping_price | 4.99 | The price the end customer paid for shipping |
| reference3 | An alternative third reference | |
| gift_message | Gift message | |
| shipping_date | 2025-03-03 | Date the shipment is shipped Format: YYYY-MM-DD |
| delivery_date | 2025-03-06 | Date the shipment is to be delivered Format: YYYY-MM-DD |
| duty_tax_number | IM0123456789 | Duty Tax number |
| duty_tax_number_type | IOSS | Duty Tax number type, one of (ABN, ARN, IOSS, EORI, IRD, OSS, VOEC) |
| 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. |
| recipient_tax_number | GB123456789000 | The recipients's tax number |
| 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 |
| product_stock_location | A1 | Stock location of the product |
| product_un_number | 1234 | Product UN number. Valid range is 0000 to 9999. Do not include the 'UN' prefix |
| shipment_tags | 4321 | IDs of shipment tags To include multiple tags, separate each ID with "|". E.g. 1234|5678 |
| sender_company | Shiptheory | The sender's company name |
| sender_first_name | John | The sender's first name. This field is required if the sender's address is being imported. |
| sender_last_name | Smith | The sender's last name. This field is required if the sender's address is being imported. |
| sender_address_line_1 | 123 Windsor Way | Sender address line 1. This field is required if the sender's address is being imported. |
| sender_address_line_2 | Sender address line 2 | |
| sender_address_line_3 | Sender address line 3 | |
| sender_city | Bristol | Sender city. This field is required if the sender's address is being imported. |
| sender_county | Sender county | |
| sender_country | GB |
Sender country. 2-character delivery country ISO code e.g. "GB" for United Kingdom
A list of country codes can be found on Wikipedia here This field is required if the sender's address is being imported. |
| sender_postcode | BS1 2LZ | Sender postcode. This field is required if the sender's address is being imported. |
| sender_telephone | 01235 456789 | The sender's telephone number |
| sender_mobile | 07777 777777 | The sender's mobile number |
| sender_email | sender@example.com | The sender's email address |
| sender_tax_number | GB123456789000 | The sender's tax number |
** 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