Method list

Test your request

Changelog

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.

package_id

int

Shipment ID

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	text	Unit of package weight ("kg", "g", "lb", "oz", "")
| - length	float	Package length
| - width	float	Package width
| - height	float	Package height
| - size_unit	text	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	varchar(3)	Currency of COD value
| - insurance_value	float	Insurance value of the package
| - insurance_currency	varchar(3)	Currency of insurance value
| - cost_value	float	Shipping cost declared for the package
| - cost_currency	varchar(3)	Currency of shipping cost
| - type	text	Type of packaging used ("package", "dox", "pallet", "")
| - pickup_date	int	Date of dispatch (unix time format)
| - service	varchar(255)	Courier service used for the package
| - additional_services	array	Courier additional services used for the package
| - courier_packaging_type	varchar(256)	Courier-specific packaging type code
additional_fields	array	Courier-specific shipment information, where the key is the field identifier and the value is the field content. Empty when the courier does not expose additional information or no value is available. shipment_notice indicates products that were not fully shipped and uses the "SKU shipped/ordered" format.

Input data:
{ "package_id": 7323859 } Output data:
{ "status": "SUCCESS", "package_details": [ { "weight": 30.52, "weight_unit": "kg", "length": 10.12, "width": 12, "height": 15.4, "size_unit": "cm", "size_template": "", "is_custom": false, "cod_value": 500.54, "cod_currency": "PLN", "insurance_value": 116.41, "insurance_currency": "EUR", "cost_value": 5.12, "cost_currency": "USD", "type": "package", "pickup_date": 0, "service": "INTERNATIONAL", "additional_services": [ "DRY_ICE" ], "courier_packaging_type": "BOX" } ], "additional_fields": { "shipment_notice": "SKU-123 1/2" } } A sample request in PHP:
<?php $methodParams = '{ "package_id": 7323859 }'; $apiParams = [ "method" => "getPackageDetails", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);