API documentation
Method list
Test your request
Changelog


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
package_idintShipment ID



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
package_detailsarrayList of shipments details
| - weightfloatPackage weight
| - weight_unitenumUnit of package weight ("kg", "g", "lb", "oz", "")
| - lengthfloatPackage length
| - widthfloatPackage width
| - heightfloatPackage height
| - size_unitenumUnit of package size ("cm", "in", "")
| - size_templatevarchar(255)Size template identifier if used, otherwise empty
| - is_customboolTrue if package dimensions are custom, false otherwise
| - cod_valuefloatCash on delivery (COD) value
| - cod_currencychar(3)Currency of COD value
| - insurance_valuefloatInsurance value of the package
| - insurance_currencychar(3)Currency of insurance value
| - cost_valuefloatShipping cost declared for the package
| - cost_currencychar(3)Currency of shipping cost
| - typeenumType of packaging used ("package", "dox", "pallet", "")
| - pickup_dateintDate of dispatch (unix time format)



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