Package Sizing Audit
Overview
The Package Sizing Audit API is designed to help validate the packaging decisions that were made either by your associates or by your 3PL partner. The call is made with information about a package that was selected and its set of contents (a set of items and their dimensions). Optionally, a set of potential packaging options can also be passed, though by default the packaging that has been configured for the fulfillmentCenterId that is passed will be used.
The API response shows:
- Whether or not the Shipium-calculated smallest packaging size is what was passed in the request.
- If the above is negative:
- What the Shipium-calculated smallest packaging would have been.
- A pack efficiency calculation to help determine how closely the Shipium calculated value was to a maximum package-fill. This value can be used to help determine whether the Shipium-calculated value is too close to "completely full" and is unreasonable compared to expectations for associates or the 3PL.
Authentication for API calls
In the cURL examples on this page, the environment variable
AUTHSTRINGis used to handle authorization. The recipe below shows how to set it correctly for both OAuth and API Key users.
Package Sizing Audit requests
This example shows a Package Sizing Audit cURL request:
curl --request POST \
--url <<api_url>>/api/v1/deliveryexperience/packageselection/audit \
--header 'accept: application/json' \
--header $AUTHSTRING \
--header 'content-type: application/json'
--data '(See Contents Examples Below)'
Request options
In the following areas of the request, you can optionally use passed or already-configured values:
-
Fulfillment Center ID - this is the
fulfillmentCenterIdthat has already been configured. If passed, this allows pre-configured packaging for that Fulfillment Center (FC) to be used. If omitted, you must specify sets of packaging to be considered using thepackagingOptionsfield described below. -
Packaging Options - the set of packaging to consider using. If you pass nothing, the system uses the packaging options configured for the passed
fulfillmentCenterId. Alternately, you can specify an array of packaging options using thepackagingOptionsparameter. Note: this option only works if you have specified afulfillmentCenterIdinstead of using theshipFromAddressoption. -
Original Packaging - you can pass the packaging that was originally selected by the FC or 3PL. You have two choices:
- pass full packaging details to the API.
- pass the ID of one of the packaging options that has already been configured for the selected
fulfillmentCenterId. Note: this second option is only available if you have specified afulfillmentCenterId.
This example shows use of fulfillmentCenterId and originalPackagingId:
{
"fulfillmentCenterId": "49796e21-5160-40dc-8028-38b7a2014a38",
"originalPackagingId": "459d644c-3973-4756-9342-1d9e8732e2c0",
"items": [
{
"productId": "9781999194864",
"productLinearDimensions": {
"linearUnit": "in",
"length": 8.0,
"width": 5.0,
"height": 0.3
},
"productWeight": {
"weightUnit": "lb",
"weight": 0.8
},
"quantity": 2,
},
{
"productId": "9781932078428",
"productLinearDimensions": {
"linearUnit": "in",
"length": 9.2,
"width": 6.5,
"height": 0.8
},
"productWeight": {
"weightUnit": "lb",
"weight": 1.8
},
"productDetails": [
"ormd"
],
"quantity": 1
}
]
}
This example shows use of selectedPackaging and packagingOptions:
{
"originalPackaging": {
"linearDimensions": {
"height": 9,
"length": 6,
"width": 3,
"linearUnit": "in"
},
"maxContentWeight": {
"weight": 65,
"weightUnit": "lb"
},
"packagingMaterial": "BOX",
"packagingSizeName": "9x6x3",
"packagingWeight": {
"weight": 0.2,
"weightUnit": "lb"
}
},
"packagingOptions": [
{
"linearDimensions": {
"height": 9,
"length": 6,
"width": 3,
"linearUnit": "in"
},
"maxContentWeight": {
"weight": 65,
"weightUnit": "lb"
},
"packagingMaterial": "BOX",
"packagingSizeName": "9x6x3",
"packagingWeight": {
"weight": 0.2,
"weightUnit": "lb"
}
},
{
"linearDimensions": {
"height": 10,
"length": 10,
"width": 10,
"linearUnit": "in"
},
"maxContentWeight": {
"weight": 65,
"weightUnit": "lb"
},
"packagingMaterial": "BOX",
"packagingSizeName": "10x10x10",
"packagingWeight": {
"weight": 0.4,
"weightUnit": "lb"
}
},
{
"linearDimensions": {
"height": 12,
"length": 8,
"width": 6,
"linearUnit": "in"
},
"maxContentWeight": {
"weight": 65,
"weightUnit": "lb"
},
"packagingMaterial": "BOX",
"packagingSizeName": "12x8x6",
"packagingWeight": {
"weight": 0.2,
"weightUnit": "lb"
}
}
],
"items": [
{
"productId": "9781999194864",
"productLinearDimensions": {
"linearUnit": "in",
"length": 8.0,
"width": 5.0,
"height": 0.3
},
"productWeight": {
"weightUnit": "lb",
"weight": 0.8
},
"quantity": 2,
},
{
"productId": "9781932078428",
"productLinearDimensions": {
"linearUnit": "in",
"length": 9.2,
"width": 6.5,
"height": 0.8
},
"productWeight": {
"weightUnit": "lb",
"weight": 1.8
},
"productDetails": [
"ormd"
],
"quantity": 1
}
]
}
Package Sizing Audit responses
This example shows a case in which a better packaging selection was found by the API:
{
"packageSizingRequestId": "45157566-4f99-4c6a-9ca5-7296c9794ba7",
"bestPackageSizeSelected": false,
"originalPackEfficiency": ".81",
"shipiumCalculatedPackagingId": "459d644c-3973-4756-9342-1d9e8732e2c0",
"shipiumCalculatedPackaging": {
"linearDimensions": {
"height": 9,
"length": 6,
"width": 3,
"linearUnit": "in"
},
"maxContentWeight": {
"weight": 65,
"weightUnit": "lb"
},
"packagingMaterial": "BOX",
"packagingSizeName": "9x6x3",
"packagingWeight": {
"weight": 0.2,
"weightUnit": "lb"
}
},
"shipiumCalculatedPackEfficiency": ".93"
}
This example shows a case in which the selected packaging matched the best packaging option:
{
"packageSizingRequestId": "45157566-4f99-4c6a-9ca5-7296c9794ba7",
"bestPackageSizeSelected": true,
"originalPackEfficiency": ".91",
"shipiumCalculatedPackagingId": "459d644c-3973-4756-9342-1d9e8732e2c0",
"shipiumCalculatedPackaging": {
"linearDimensions": {
"height": 9,
"length": 6,
"width": 3,
"linearUnit": "in"
},
"maxContentWeight": {
"weight": 65,
"weightUnit": "lb"
},
"packagingMaterial": "BOX",
"packagingSizeName": "9x6x3",
"packagingWeight": {
"weight": 0.2,
"weightUnit": "lb"
}
},
"shipiumCalculatedPackEfficiency": ".91"
}
More information on the API responses
As with all Shipium API responses, this API follows the API Response Codes standards unless otherwise specified.
Updated about 1 year ago