getPackageDetails
This method allows to get detailed information about a package. If the package contains multiple subpackages, information about all of them is included in the response.
Input parameters
Output data:
A sample request in PHP:
package_id | int | Shipment ID |
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 |
package_details | array | List of shipments details |
| - weight | float | Package weight |
| - weight_unit | enum | Unit of package weight ("kg", "g", "lb", "oz", "") |
| - length | float | Package length |
| - width | float | Package width |
| - height | float | Package height |
| - size_unit | enum | Unit of package size ("cm", "in", "") |
| - size_template | varchar(255) | Size template identifier if used, otherwise empty |
| - is_custom | bool | True if package dimensions are custom, false otherwise |
| - cod_value | float | Cash on delivery (COD) value |
| - cod_currency | char(3) | Currency of COD value |
| - insurance_value | float | Insurance value of the package |
| - insurance_currency | char(3) | Currency of insurance value |
| - cost_value | float | Shipping cost declared for the package |
| - cost_currency | char(3) | Currency of shipping cost |
| - type | enum | Type of packaging used ("package", "dox", "pallet", "") |
| - pickup_date | int | Date of dispatch (unix time format) |
Sample
Input data:Output data:
A sample request in PHP: