Sender
Field | Type | Required | Description |
shipments[1][sender_country_iso] | string (2) | Yes | Sender country iso code |
shipments[1][service_code] | string (9) | Yes | This is code of the Service that we are using |
shipments[1][order_reference] | string (40) | Yes | This is order reference number |
shipments[1][reference] | string (40) | No | This is reference for your shipment |
shipments[1][sender_contact] | string (40) | Yes | Name of the Sender |
shipments[1][sender_email] | string (45) | No | Email of the Sender |
shipments[1][sender_company] | string (25) | No | Company Name of the Sender |
shipments[1][sender_name] | string (25) | No | Name of the Sender |
shipments[1][sender_address_line_1] | string (30) | Yes | Address 1 of the sender |
shipments[1][sender_address_line_2] | string (30) | No | Address 2 of the sender |
shipments[1][sender_address_line_3] | string (30) | No | Address 3 of the sender |
shipments[1][sender_city] | string (25) | Yes | City of the sender |
shipments[1][sender_state] | string (25) | No | State of the sender |
shipments[1][sender_postcode] | string (10) | Yes | Postcode of the city of sender |
shipments[1][sender_telephone] | string (17) | No | Phone Number of the sender |
shipments[1][receiver_country_iso] | string (2) | Yes | Receiver country iso code (2) |
shipments[1][receiver_email] | string (45) | No | Email of the receiver |
shipments[1][receiver_company] | string (25) | No | Company Name of the receiver |
shipments[1][receiver_contact] | string (50) | Yes | Name of the receiver |
shipments[1][receiver_address_line_1] | string (40) | Yes | Address 1 of the receiver |
shipments[1][receiver_address_line_2] | string (40) | No | Address 2 of the receiver |
shipments[1][receiver_address_line_3] | string (40) | No | Address 3 of the receiver |
shipments[1][receiver_city] | string (25) | Yes | City of the receiver |
shipments[1][receiver_state] | string (25) | No | State of the receiver |
shipments[1][receiver_postcode] | string (10) | Yes | Postcode of the city of receiver |
shipments[1][receiver_telephone] | string (17) | No | Phone Number of the receiver |
shipments[1][value] | Int (12) | No | Value of shipped goods |
shipments[1][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 |
shipments[1][collection_date] | date | No | Only for collection type shipment Date format should be dd-mm-yyyy |
shipments[1][collection_start_time] | time | No | Only for collection type shipment Time format should be in 24 hours format like 13:30 |
shipments[1][collection_end_time] | time | No | Only for collection type shipment Time format should be in 24 hours format like 13:30 |
shipments[1][currency] | string (3) | No | Currency iso code |
shipments[1][item_type] | string (60) | No | Type of Consignment |
shipments[1][Notes] | string | No | Any Notes that sender adds for the Consignment |
shipments[1][description] | string (30) | Yes | Any description that sender adds for the Consignment |
shipments[1][eori_number] | string (20) | No | |
shipments[1][vat_number] | string (20) | No | |
shipments[1][ioss_number] | string (20) | No | |
shipments[1][seller_name] | string | No | |
shipments[1][seller_company] | string | No | |
shipments[1][seller_email] | string | No | |
shipments[1][seller_phone] | string | No | |
shipments[1][seller_address_line_1] | string | No | |
shipments[1][seller_address_line_2] | string | No | |
shipments[1][seller_address_line_3] | string | No | |
shipments[1][seller_city] | string | No | |
shipments[1][seller_state] | string | No | |
shipments[1][seller_postcode] | string | No | |
shipments[1][seller_country_iso] | string | No | |
shipments[1][full_pallet] | int (Length 2) | No | |
shipments[1][half_pallet] | int (Length 2) | No | |
shipments[1][quarter_pallet] | int (Length 2) | No | |
shipments[1][seller_documents] | Array | No | Array of KYC documents |
shipments[1][parcel][0][weight] | Array | Yes | Weight of the parcel. it will send in array Like parcel[0][weight] : 5 |
shipments[1][parcel][0][height] | Array | Yes | Height of the parcel. it will send in array Like parcel[0][height] : 10 |
shipments[1][parcel][0][width] | Array | Yes | Width of the parcel. it will send in array Like parcel[0][width] : 10 |
shipments[1][parcel][0][length] | Array | Yes | Length of the parcel. it will send in array Like parcel[0][length] 10 |
shipments[1][parcel][0][itemvalue] | Array | No | Item value of the parcel. it will send in array Like parcel[0][itemvalue]: 10 |
shipments[2][sender_country_iso] | string (2) | Yes | Sender country iso code |
shipments[2][service_code] | string (9) | Yes | This is code of the Service that we are using |
shipments[2][order_reference] | string (40) | Yes | This is order reference number |
shipments[2][reference] | string (40) | No | This is reference for your shipment |
shipments[2][sender_contact] | string (40) | Yes | Name of the Sender |
shipments[2][sender_email] | string (45) | No | Email of the Sender |
shipments[2][sender_company] | string (25) | No | Company Name of the Sender |
shipments[2][sender_name] | string (25) | No | Name of the Sender |
shipments[2][sender_address_line_1] | string (30) | Yes | Address 1 of the sender |
shipments[2][sender_address_line_2] | string (30) | No | Address 2 of the sender |
shipments[2][sender_address_line_3] | string (30) | No | Address 3 of the sender |
shipments[2][sender_city] | string (25) | Yes | City of the sender |
shipments[2][sender_state] | string (25) | No | State of the sender |
shipments[2][sender_postcode] | string (10) | Yes | Postcode of the city of |
shipments[2][sender_telephone] | string (17) | No | Phone Number of the sender |
shipments[2][receiver_country_iso] | string (2) | Yes | Receiver country iso code (2) |
shipments[2][receiver_email] | string (45) | No | Email of the receiver |
shipments[2][receiver_company] | string (25) | No | Company Name of the receiver |
shipments[2][receiver_contact] | string (50) | Yes | Name of the receiver |
shipments[2][receiver_address_line_1] | string (40) | Yes | Address 1 of the receiver |
shipments[2][receiver_address_line_2] | string (40) | No | Address 2 of the receiver |
shipments[2][receiver_address_line_3] | string (40) | No | Address 3 of the receiver |
shipments[2][receiver_city] | string (25) | Yes | City of the receiver |
shipments[2][receiver_state] | string (25) | No | State of the receiver |
shipments[2][receiver_postcode] | string (10) | Yes | Postcode of the city of receiver |
shipments[2][receiver_telephone] | string (17) | No | Phone Number of the receiver |
shipments[2][value] | Int (12) | No | Value of shipped goods |
shipments[2][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 |
shipments[2][collection_date] | date | No | Only for collection type shipment Date format should be dd-mm-yyyy |
shipments[2][collection_start_time] | time | No | Only for collection type shipment Time format should be in 24 hours format like 13:30 |
shipments[2][collection_end_time] | time | No | Only for collection type shipment Time format should be in 24 hours format like 13:30 |
shipments[2][currency] | string (3) | No | Currency iso code |
shipments[2][item_type] | string (60) | No | Type of Consignment |
shipments[2][Notes] | string | No | Any Notes that sender adds for the Consignment |
shipments[2][description] | string (30) | Yes | Any description that sender adds for the Consignment |
shipments[2][eori_number] | string (20) | No | |
shipments[2][vat_number] | string (20) | No | |
shipments[2][ioss_number] | string (20) | No | |
shipments[2][seller_name] | string | No | |
shipments[2][seller_company] | string | No | |
shipments[2][seller_email] | string | No | |
shipments[2][seller_phone] | string | No | |
shipments[2][seller_address_line_1] | string | No | |
shipments[2][seller_address_line_2] | string | No | |
shipments[2][seller_address_line_3] | string | No | |
shipments[2][seller_city] | string | No | |
shipments[2][seller_state] | string | No | |
shipments[2][seller_postcode] | string | No | |
shipments[2][seller_country_iso] | string | No | |
shipments[2][full_pallet] | int (Length 2) | No | |
shipments[2][half_pallet] | int (Length 2) | No | |
shipments[2][quarter_pallet] | int (Length 2) | No | |
shipments[2][seller_documents] | Array | No | Array of KYC documents |
shipments[2][parcel][0][weight] | Array | Yes | Weight of the parcel. it will send in array Like shipments[2][parcel][0][weight] 5 |
shipments[2][parcel][0][height] | Array | Yes | Height of the parcel. it will send in array Like shipments[2][parcel][0][height] 10 |
shipments[2][parcel][0][width] | Array | Yes | Width of the parcel. it will send in array Like shipments[2][parcel][0][width] 10 |
shipments[2][parcel][0][length] | Array | Yes | Length of the parcel. it will send in array Like shipments[2][parcel][0][length] 10 |
shipments[2][parcel][0][itemvalue] | Array | No | Item value of the parcel. it will send in array Like shipments[2][parcel][0][itemvalue]: 10 |
shipments[2][parcel][0][items][0][item_description] | Array | No | Item description of the items inside a parcel. it will send in array Like shipments[2][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”, |
shipments[2][parcel][0][items][0][no_of_items] | Array | No | SKU or product url of items inside the parcel. it will send in array Like shipments[2][parcel][0][items][0][no_of_items]: 1, |
shipments[2][parcel][0][items][0][item_value] | Array | No | Value of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][item_value]: 1, |
shipments[2][parcel][0][items][0][weight] | Array | No | Weight of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][weight]: 0.750, |
shipments[2][parcel][0][items][0][tariff_No] | Array | No | Tariff of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][tariff_No]: TARIFF1, |
shipments[2][parcel][0][items][0][hscode] | Array | No | Hscode of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][hscode]: hscode, |
shipments[2][parcel][0][items][0][manufacture_country_iso] | Array | No | Manufacture country ISO of items inside a parcel. it will send in array Like shipments[2][parcel][0][items][0][manufacture_country_iso]: GB, |