Add shipment parcels with items for async processing | LeanMile cross-border gatway API

Parameter	Type	Description	Mandatory? Yes/ No	Constraints
containerId	String	Package/Bag number	Yes	Different shipments cannot include same package number
clientRefID	String	Client’s parcel number (client-side identifier)	Yes	Unique Client reference ID
mailType	String	Service that is selected for parcel delivery	Yes	Allowed values: REGISTERED, NOT_REGISTERED, EMS, PRIME, PARCEL_EPG, PARCEL_UPU, TRACKABLE, NONPOSTAL, Use NONPOSTAL for Customs Clearance shipments.
tpServiceCode	String	Third-party service code	No	Channel code with “\|OPS-CC” suffix for customs clearance flows. 1. SameDay-> “SD RO\|OPS-CC”/“UNIS LV\|OPS-CC” 2. DPD-> “DPD RO\|OPS-CC” etc. Ask for more codes that should be used if needed.
customClearanceType	String	Customs clearance type	Yes	Allowed values: DDP, DDU, CLEARED Use DDP for IOSS customs clearance EU flows.
parcelID	String	Parcel number	Yes, when parcel ID is generated by client	1. Must be unique
weight	Number	Parcel total weight in kilograms	Yes	Must be a positive number
price	Number	Total Price of the parcel, currently expected in USD	No	1. TotalPrice > 0 2. Max 2 decimals 3. If not filled, the system will calculate based on quantity & item price
currency	String	Currency of the price	Yes
consignorVatRep	String	Consignor VAT representative. In EU IOSS Broker is expected	Yes	Field is mandatory when non-EU sender sends DDP EU non-cleared goods
originator	Party Object	Information about the originator	Yes	Must include “address” object with country code to indicate origin of goods “CN”
consignor	Party Object	Information about the consignor	Yes	Must include “name”, “address” and represents sender.
recipient	Party Object	Information about the recipient	Yes	Must include “name”, “phoneNumber”, “address” object for importer
items	Array of Items Object	List of items in the parcel	Yes	Each item must include “commodity”, “hsCode”, “quantity”, “weight”, “price”

Party Object

Parameter	Type	Description	Mandatory? Yes/ No	Constraints
name	String	Sender/Recipient name	Yes
phoneNumber	String	Sender/Recipient contact phone number	No
email	String	Sender/Recipient contact email address	No
address	Address Object	Address of the Sender/Recipient	Yes	Must include “country”

Address Object

Parameter	Type	Description	Mandatory? Yes/ No	Constraints
street	String	Street address of the consignor/recipient	Yes, if address is not stated
house	String	House number of the consignor/recipient	No
building	String	Building number of the consignor/recipient	No
flat	String	Flat number of the consignor/recipient	No
city	String	City of the consignor/recipient	Yes
county	String	County of the consignor/recipient	No
zip	String	ZIP code of the consignor/recipient	Yes
country	String	Destination country of the consignor/recipient	Yes	2-letter country code
address	String	Consignor/Recipient address	Yes, if Street+House+Building is not stated

Item Object

Parameter	Type	Description	Mandatory? Yes/ No	Constraints
commodity	String	Commodity description, minimum 5 letter requirement	Yes	Min. letters in description = 5
hsCode	String	6 digit HS code	Yes	Must be a valid HS code
quantity	Number	Quantity of items inside parcel	Yes	Quantity > 0
weight	Number	Weight of the item inside parcel, in kilograms	Yes	itemWeight > 0
price	Number	Price of the item inside the parcel in target currency	Yes	itemPrice > 0, Max 2 decimals
sku	String	Stock keeping unit, merchant product code	Yes/No	Mandatory ex AMS shipments
url	String	Link to advertisement	No	Must be a valid URL format

<table><tbody><tr><td><div><p><b>Parameter</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Type</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Description</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Mandatory? Yes/ No</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Constraints</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>containerId</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Package/Bag number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Different shipments cannot include same package number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>clientRefID</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Client’s parcel number (client-side identifier)</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Unique Client reference ID</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>mailType</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Service that is selected for parcel delivery</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Allowed values: REGISTERED, NOT_REGISTERED, EMS, PRIME, PARCEL_EPG, PARCEL_UPU, TRACKABLE, <b>NONPOSTAL, Use NONPOSTAL for Customs Clearance shipments.</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>tpServiceCode</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Third-party service code</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Channel code with "|OPS-CC" suffix for customs clearance flows.<br>1. SameDay-> "SD RO|OPS-CC"/"UNIS LV|OPS-CC"<br>2. DPD-> "DPD RO|OPS-CC" etc. Ask for more codes that should be used if needed.</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>customClearanceType</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Customs clearance type</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Allowed values: DDP, DDU, CLEARED<br><br><b>Use DDP for IOSS customs clearance EU flows.</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>parcelID</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Parcel number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes, when parcel ID is generated by client</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>1. Must be unique</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>weight</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Parcel total weight in kilograms</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must be a positive number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>price</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Total Price of the parcel, currently expected in USD</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>1. TotalPrice > 0 2. Max 2 decimals</p><p>3. If not filled, the system will calculate based on quantity & item price</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>currency</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Currency of the price</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>consignorVatRep</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Consignor VAT representative. In EU IOSS Broker is expected</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Field is mandatory when non-EU sender sends DDP EU non-cleared goods</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>originator</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Party Object</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Information about the originator</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must include "address" object with country code to indicate origin of goods "CN"</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>consignor</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Party Object</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Information about the consignor</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must include "name", "address" and represents sender.</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Party Object</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Information about the recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must include "name", "phoneNumber", "address" object for importer</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>items</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Array of Items Object</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>List of items in the parcel</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Each item must include "commodity", "hsCode", "quantity", "weight", "price"</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table> #### Party Object <table><tbody><tr><td><div><p><b>Parameter</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Type</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Description</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Mandatory? Yes/ No</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Constraints</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>name</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Sender/Recipient name</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>phoneNumber</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Sender/Recipient contact phone number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>email</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Sender/Recipient contact email address</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>address</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Address Object</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Address of the Sender/Recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must include "country"</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table> #### Address Object <table><tbody><tr><td><div><p><b>Parameter</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Type</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Description</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Mandatory? Yes/ No</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Constraints</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>street</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Street address of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes, if address is not stated</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>house</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>House number of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>building</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Building number of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>flat</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Flat number of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>city</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>City of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>county</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>County of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>zip</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>ZIP code of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>country</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Destination country of the consignor/recipient</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>2-letter country code</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>address</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Consignor/Recipient address</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes, if Street+House+Building is not stated</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table> #### Item Object <table><tbody><tr><td><div><p><b>Parameter</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Type</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Description</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Mandatory? Yes/ No</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p><b>Constraints</b></p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>commodity</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Commodity description, minimum 5 letter requirement</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Min. letters in description = 5</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>hsCode</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>6 digit HS code</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must be a valid HS code</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>quantity</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Quantity of items inside parcel</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Quantity > 0</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>weight</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Weight of the item inside parcel, in kilograms</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>itemWeight > 0</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>price</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Number</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Price of the item inside the parcel in target currency</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>itemPrice > 0, Max 2 decimals</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>sku</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Stock keeping unit, merchant product code</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Yes/No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Mandatory ex AMS shipments</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div><p>url</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>String</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Link to advertisement</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>No</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td><td><div><p>Must be a valid URL format</p></div><div contenteditable="false"><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

reqIdstringOptional

Unique request ID for troubleshooting potential issues

Request

This endpoint expects a list of objects.

itemslist of objectsRequired

priceintegerRequired

weightdoubleRequired

mailTypestringRequired

parcelIDstringRequired

consignorobjectRequired

recipientobjectRequired

originatorobjectRequired

clientRefIDstringRequired

containerIdstringRequired

tpServiceCodestringRequired

consignorVatRepstringRequired

customClearanceTypestringRequired

Response

dataobject

statusstring

messagestring

statusCodeinteger

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

1	curl -X POST "https://https//https/v1/shipment/123-00000000/parcelsAsync?reqId=%7B%7B%24guid%7D%7D" \
2	-H "Content-Type: application/json" \
3	-u "<username>:<password>" \
4	-d '[
5	{
6	"items": [
7	{
8	"price": 2.8,
9	"hsCode": "3304991000",
10	"weight": 0.01,
11	"quantity": 10,
12	"commodity": "Smartphone cover"
13	}
14	],
15	"price": 28,
16	"weight": 0.18,
17	"mailType": "NONPOSTAL",
18	"parcelID": "{{$guid}}",
19	"consignor": {
20	"name": "Test sender",
21	"address": {
22	"zip": "0000",
23	"city": "Shenzhen",
24	"country": "CN",
25	"streetAddress": "Test sender address"
26	}
27	},
28	"recipient": {
29	"name": "Test Recipient",
30	"email": "test@test.com",
31	"address": {
32	"zip": "20000",
33	"city": "Test Rec City",
34	"county": "Rec county",
35	"country": "RO",
36	"streetAddress": "Test delivery address"
37	},
38	"phoneNumber": "1234567678"
39	},
40	"originator": {
41	"address": {
42	"country": "CN"
43	}
44	},
45	"clientRefID": "{{$guid}}",
46	"containerId": "ContainerTest1",
47	"tpServiceCode": "SD RO\|OPS-CC",
48	"consignorVatRep": "IM1234567890",
49	"customClearanceType": "DDP"
50	}
51	]'

1	{
2	"data": {
3	"inserted": 1
4	},
5	"status": "OK",
6	"message": "OK",
7	"statusCode": 200
8	}