Skip to main content

Documentation Portal

OrderDocumentsResponse

Parameter Name	Type	Description	Mandatory
`DeliveryAdviceInformation`	List of `DeliveryAdviceInformation`	List of `DeliveryAdviceInformation` objects that hold the information required for the “Delivery Advice” document.	No
`Documents`	List of `OrderDocument`	List of `OrderDocument` objects that hold the shipping documents. This property is included only in the `GetShippingDocuments` method response.	No
`ErrorText`	String	Description of the error to get documents	No
`IsSuccess`	Boolean	Indicates if API call was successful or not. TRUE- API call was successful FALSE – API call was not successful
`ParcelsTracking`	List of `Merchant.ParcelTracking`	List of the `Merchant.ParcelTracking` objects, each object holds the parcel tracking number and full tracking URL for the relevant shipper (with the parcel tracking number).	No
`ShipperManifests`	List of `OrderDocument`	List of `OrderDocument` objects that hold shipper manifest documents. This property is included only in the `DispatchOrders` method response.	No
`TrackingDetails`	Object `Merchant.TrackingDetails`	Order tracking information.	No

DeliveryAdviceInformation

Parameter Name	Type	Description	Mandatory
`CommercialInvoiceNumber`	String	Commercial invoice number of the parcel if it exists on the parcel level, otherwise order commercial invoice number. Can be null if a commercial invoice does not exist for the order.
`CurrencyCode`	String	3-char ISO currency code related to `TotalValue`
`ParcelCode`	String	Code used to identify the Parcel on the Merchant’s site
`TotalValue`	String	Value of all products in the parcel

Merchant.ParcelTracking

Parameter Name	Type	Description	Mandatory
`ParcelCode`	String	Parcel code.
`ParcelTrackingNumber`	String	The tracking number is used by the selected international shipping method for this parcel.
`ParcelTrackingUrl`	String	Full tracking URL including `ParcelTrackingNumber` used by the selected international shipping method for this parcel.

Merchant.TrackingDetails

Parameter Name	Type	Description	Mandatory
`ShipperName`	String	The shipping method name
`TrackingNumber`	String	The tracking number as the shipper has specified
`TrackingURL`	String	Full tracking URL including the `TrackingNumber` used by the selected international shipping method

OrderDocument

Parameter Name	Type	Description	Mandatory
`CreationDateTime`	DateTime	The date and time the document was created.	No
`DocumentData`	String	Base64 encoded byte array representing the document file content.
`DocumentExtension`	String	Document extension (PDF, ZPL, EPL).
`DocumentReference`	String	The reference provided by the government authorities to this document (such as MRN or ITN number).	No
`DocumentTypeCode`	String	Document type code, this value can be: CommercialInvoice = 1 PackingList = 2 ShipperManifest = 3 Label = 4 VATInvoice = 5 DangerousGoodDeclarationLink = 6 GELabel = 7 CustomerReceiptInvoice = 8 ArchibeLabel = 9 DeliveryAdvice = 10 EAD = 11
`DocumentTypeName`	String	Document type name, e.g. `AWB`, `CommercialInvoiceAndPackingList` or `Manifest`.
`ErrorMessage`	String	Description of the error for this entity (order/parcel) if it happened.	No
`ParcelCode`	String	The parcel code related to the document.	No
`ShippingServiceName`	String	The name of the shipping service for this document (relevant for `DispatchOrders` and `DispatchConsolidatedShipment`).	No
`TrackingNumber`	String	Shipping tracking number associated with the document.	No
`URL`	String	URL of the document.

Would you like to provide feedback? Just click here to suggest edits.