Field | Type | Required | Description |
sender_country_iso | string (2) | Yes | Sender country iso code |
service_code | string (9) | Yes | This is code of the Service that we are using |
order_reference | string (40) | Yes | This is order reference number |
reference | string (40) | No | This is reference for your shipment |
sender_contact | string (40) | Yes | Name of the Sender |
sender_email | string (45) | No | Email of the Sender |
sender_company | string (25) | No | Company Name of the Sender |
sender_name | string (25) | No | Name of the Sender |
sender_address_line_1 | string (30) | Yes | Address 1 of the sender |
sender_address_line_2 | string (30) | No | Address 2 of the sender |
sender_address_line_3 | string (30) | No | Address 3 of the sender |
sender_city | string (25) | Yes | City of the sender |
sender_postcode | string (10) | Yes | Postcode of the city of sender |
sender_state | string (25) | No | State of the sender |
sender_telephone | string (17) | No | Phone Number of the sender |
receiver_country_iso | string (2) | Yes | Receiver country iso code (2) |
receiver_email | string (45) | No | Email of the receiver |
receiver_company | string (25) | No | Company Name of the receiver |
receiver_contact | string (50) | Yes | Name of the receiver |
receiver_address_line_1 | string (40) | Yes | Address 1 of the receiver |
receiver_address_line_2 | string (40) | No | Address 2 of the receiver |
receiver_address_line_3 | string (40) | No | Address 3 of the receiver |
receiver_city | string (25) | Yes City of the receiver | |
receiver_state | string (25) | No | State of the receiver |
receiver_postcode | string (10) | Yes | Postcode of the city of receiver |
receiver_telephone | string (17) | No | Phone Number of the receiver |
value | Int (12) | No | Value of shipped goods |
shipment_type | string | No | Possible values are D and C D for dispatch type shipment C for collection type shipment Default value is D |
commercial_invoice | BASE64_ENCODED_PDF_STRING | No | PDF string |
collection_date | date | No | Only for collection type shipment Date format should be dd-mm-yyyy |
collection_start_time | time | No | Only for collection type shipment Time format should be in 24 hours format like 13:30 |
collection_end_time | time | No | Only for collection type shipment Time format should be in 24 hours format like 13:30 |
currency | string (3) | No | Currency iso code |
item_type | string (60) | No | Type of Consignment |
Notes | String (255) | No | Any Notes that sender adds for the Consignment |
description | string (30) | Yes | Any description that sender adds for the Consignment |
eori_number | string (20) | No | |
vat_number | string (20) | No | |
ioss_number | string (20) | No | |
seller_name | string | No | |
seller_company | string | No | |
seller_email | string | No | |
seller_phone | string | No | |
seller_address_line_1 | string | No | |
seller_address_line_2 | string | No | |
seller_address_line_3 | string | No | |
seller_city | string | No | |
seller_state | string | No | |
seller_postcode | string | No | |
seller_country_iso | string | No | |
full_pallet | int (Length 2) | No | |
half_pallet | int (Length 2) | No | |
quarter_pallet | int (Length 2) | No | |
seller_documents | Array | No | Array of KYC documents |
parcel[0][weight] | Array | Yes | Weight of the parcel. it will send in array Like parcel[0][weight] 5 |
parcel[0][height] | Array | Yes | Height of the parcel. it will send in array Like parcel[0][height] 10 |
parcel[0][width] | Array | Yes | Width of the parcel. it will send in array Like parcel[0][width] 10 |
parcel[0][length] | Array | Yes | Length of the parcel. it will send in array Like parcel[0][length] 10 |
parcel[0][itemvalue] | Array | No | Item value of the parcel. it will send in array Like parcel[0][itemvalue]: 10 |
parcel[0][items][0][item_description] | Array | No | Item description of the items inside a parcel. it will send in array Like parcel[0][items][0][item_description]: “jellyfish”, |
parcel[0][items][0][item_sku] | Array | No | SKU of items inside the parcel. it will send in array Like parcel[0][items][0][item_sku]: “SKU”, |
parcel[0][items][0][item_url] | Array | No | Product url of items inside the parcel. it will send in array Like parcel[0][items][0][item_url]: “http://www.abc.com”, |
parcel[0][items][0][no_of_items] | Array | No | No of items inside a parcel. it will send in array Like parcel[0][items][0][no_of_items]: 1, |
parcel[0][items][0][item_value] | Array | No | Value of items inside a parcel. it will send in array Like parcel[0][items][0][item_value]: 1, |
parcel[0][items][0][weight] | Array | No | Weight of items inside a parcel. it will send in array Like parcel[0][items][0][weight]: 0.750, |
parcel[0][items][0][tariff_no] | Array | No | Tariff of items inside a parcel. it will send in array Like parcel[0][items][0][tariff_no]: TARIFF1, |
parcel[0][items][0][hscode] | Array | No | Hscode of items inside a parcel. it will send in array Like parcel[0][items][0][hscode]: hscode, |
parcel[0][items][0][manufacture_country_iso] | Array | No | Manufacture country ISO of items inside a parcel. it will send in array Like parcel[0][items][0][manufacture_country_iso]: GB, |
label_type | String (5) | No | Possible values are pdf and zpl Default value is pdf |
label_size | String (15) | No | Size format is [width x height] e.g. 100×150 |
commercial_invoice | BASE64_ENCODED_PDF_STRING | No | PDF string |