API documentation
Method list
Test your request
Changelog


getOrderPackages
The method allows you to download shipments previously created for the selected order.


Input parameters
order_idintOrder identifier



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
packagesarrayList of shipments
| - package_idintShipment ID
| - courier_package_nrvarchar(40)Shipping number (consignment number)
| - courier_inner_numbervarchar(40)Courier internal number
| - courier_codevarchar(20)Courier code
| - courier_other_namevarchar(20)Additional courier name, applicable to brokers.
| - tracking_status_dateintLast shipment tracking status date
| - tracking_delivery_daysintNumber of days for a shipment to be delivered from status Shipped to status Delivered, excluding weekends
| - tracking_statusintTracking status code:
0 - Unknown
1 - Courier label created
2 - Shipped
3 - Not delivered
4 - Out for delivery
5 - Delivered
6 - Return
7 - Aviso
8 - Waiting at point
9 - Lost
10 - Canceled
11 - On the way
| - package_typeintPackage type code:
0 - Standard shipment
1 - Return shipment
2 - Sent at point
3 - Return shipment, sent at point
| - tracking_urlvarchar(255)Shipment tracking url
| - is_returnboolIs shipment return



Sample
Input data:
Output data:
A sample request in PHP: