getOrderPackages
The method allows you to download shipments previously created for the selected order.
Input parameters
Output data:
A sample request in PHP:
order_id | int | Order identifier |
Output data
The method returns the data in JSON format.
status | varchar(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 |
packages | array | List of shipments |
| - package_id | int | Shipment ID |
| - courier_package_nr | varchar(40) | Shipping number (consignment number) |
| - courier_inner_number | varchar(40) | Courier internal number |
| - courier_code | varchar(20) | Courier code |
| - courier_other_name | varchar(20) | Additional courier name, applicable to brokers. |
| - tracking_status_date | int | Last shipment tracking status date |
| - tracking_delivery_days | int | Number of days for a shipment to be delivered from status Shipped to status Delivered, excluding weekends |
| - tracking_status | int | Tracking 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_type | int | Package type code:
0 - Standard shipment 1 - Return shipment 2 - Sent at point 3 - Return shipment, sent at point |
| - tracking_url | varchar(255) | Shipment tracking url |
| - is_return | bool | Is shipment return |
Sample
Input data:Output data:
A sample request in PHP: