API Portal
WMS Portal
Update Package Weight
This API is used to update the package dimensions and weight for specific channels after an order has been created. Please consult your account manager to confirm channel support.
Request URL
/shipment/updatePackage
Request Method
POST
Request Body Parameters
| Parameter Name | Example | Type | Required | Description |
|---|---|---|---|---|
| shipmentNo | shipment_vlkadfooadfdf | String | Yes | System-generated shipment number returned when the label was created |
| packages (Array) — Replaces the original package list. The number of packages must match the original shipment. | ||||
| length | 10 | Number | Yes | Package length |
| width | 10 | Number | Yes | Package width |
| height | 10 | Number | Yes | Package height |
| weight | 14 | Number | Yes | Package weight (per package) |
| quantity | 1 | Number | Yes | Package quantity |
| options (Object) — Shipment service options | ||||
| dimensionUnitCode | IN | String | Yes | Dimension unit (must be “IN”) |
| weightUnitCode | LBS | String | Yes | Weight unit (must be “LBS”) |
| packageType | customPackage | String | No | Package type (default: customPackage) |
Request Example
{
"shipmentNo": "shipment_vlkadfooadfdf",
"packages": [
{
"length": 10,
"width": 10,
"height": 10,
"weight": 14,
"quantity": 1
}
],
"options": {
"dimensionUnitCode": "IN",
"weightUnitCode": "LBS"
}
}Response Example
{
"code": 200,
"data": null,
"message": "Package information updated successfully"
}