Get your Order Packages information by an order number.
- URL: {API root URL}/orders/{OrderNumber}/packages
- Method: GET
Request
URL Parameters
| Parameter Name | Required | Data Type | Description |
|---|
| OrderNumber | Y | String | The order number you want to search for getting the package information |
Response
Attribute List
| Element Name | Data Type | Description |
|---|
| packageList | Array<Object> | List of package. |
| packageList/id | String | Best system internal ID of current package. |
| packageList/packageNumber | String | Package number of current package. |
| packageList/customerCode | String | A unique customer code assigned by Best system. |
| packageList/orderNumber | String | Your order number associated with current package. |
| packageList/warehouseCode | String | Indicate the fulfillment center that processed current package. |
| packageList/optionSignature | String | Indicate if your package shipped with the option of Signature Required. Available value is None or Required. |
| packageList/carrier | String | Name of the carrier who will deliver current package. |
| packageList/carrierService | String | Service code of the shipping service used for current package. |
| packageList/carrierServiceText | String | Description of the carrier shipping service used for current package. |
| packageList/trackingNumber | String | Tracking number assigned by carrier to fulfill current order. |
| packageList/boxCode | String | Packing material spcified for this order. |
| packageList/length | String | Package dimension: Length |
| packageList/width | String | Package dimension: Width |
| packageList/height | String | Package dimension: Height |
| packageList/lengthUnit | String | The Unit Of Measure for package dimension. |
| packageList/weight | String | Package total weight |
| packageList/weightUnit | String | The Unit Of Measure for item weight. |
| packageList/shipTime | String | The date and time when the order is shipped by Best fulfillment center. Fomrat: UTC time zone. |
| packageList/details | Array<Object> | The list of item under the current package |
| packageList/details/id | String | Best system internal ID of current item. |
| packageList/details/packageId | String | Package number of current package. All items shipped in same package will share the same ID. |
| packageList/details/itemId | String | The SKU number of current item. |
| packageList/details/sku | String | The SKU number assigned to current item. |
| packageList/details/condition | String | The condition of shipped item. Available values: Good or Damaged |
| packageList/details/quantity | Integer | shipped quantity for current item. |
| packageList/details/batchNumber | String | The Batch Number of current item. |
| packageList/details/expDate | String | The Expiration Date of the shipped item when applicable. |
| packageList/details/mfgDate | String | The Manufacture Date of the shipped item when applicable. |
| packageList/details/countryOfOrigin | String | The Country of Origin of the shipped item when applicable. |
Response Example
{
"packageList": [
{
"id": 68367,
"packageNumber": "S002982695-01",
"customerCode": "USQA",
"orderNumber": "E-202109231520",
"warehouseCode": "USCA01",
"optionSignature": "None",
"carrier": "UPS",
"carrierService": "03",
"carrierServiceText": "Ground",
"trackingNumber": "1ZR198590396386796",
"boxCode": "PK04023",
"length": 8,
"width": 6.5,
"height": 3,
"lengthUnit": "Inch",
"weight": 0.9,
"weightUnit": "Pound",
"shipTime": "2021-09-23T14:34:02+00:00",
"details": [
{
"id": 95175,
"packageId": 68367,
"itemId": 49471,
"sku": "SKUCARSELW1",
"condition": "Good",
"quantity": 3,
"batchNumber": "B1",
"expDate": "2024-08-04",
"mfgDate": "2021-09-20",
"countryOfOrigin": "CN"
},
{
"id": 95178,
"packageId": 68367,
"itemId": 46824,
"sku": "Sku1",
"condition": "Good",
"quantity": 2,
"batchNumber": "B2",
"expDate": "2024-09-04",
"mfgDate": "2021-09-04",
"countryOfOrigin": "CN"
},
{
"id": 95179,
"packageId": 68367,
"itemId": 46824,
"sku": "Sku1",
"condition": "Good",
"quantity": 3,
"batchNumber": "B1",
"expDate": "2024-08-04",
"mfgDate": "2021-08-04",
"countryOfOrigin": "US"
}
]
},
{
"id": 68368,
"packageNumber": "S002982695-02",
"customerCode": "USQA",
"orderNumber": "E-202109231520",
"warehouseCode": "USCA01",
"optionSignature": "None",
"carrier": "UPS",
"carrierService": "03",
"carrierServiceText": "Ground",
"trackingNumber": "1ZR198590396386796-2",
"boxCode": "PK04023",
"length": 8,
"width": 6.5,
"height": 3,
"lengthUnit": "Inch",
"weight": 0.9,
"weightUnit": "Pound",
"shipTime": "2021-09-23T14:34:02+00:00",
"details": [
{
"id": 95176,
"packageId": 68368,
"itemId": 46824,
"sku": "Sku1",
"condition": "Good",
"quantity": 3,
"batchNumber": "B1",
"expDate": "2024-08-04",
"mfgDate": "2021-08-04",
"countryOfOrigin": "US"
},
{
"id": 95177,
"packageId": 68368,
"itemId": 49471,
"sku": "SKUCARSELW1",
"condition": "Good",
"quantity": 1,
"batchNumber": "B1",
"expDate": "2024-08-04",
"mfgDate": "2021-09-20",
"countryOfOrigin": "CN"
}
]
}
]
}