[GET] Retrieve palletization summary#
Returns a summary of the ALPHA-built pallets of a shipment after optimization: how many pallets are full (one SKU) or mixed (several SKUs), the shipment totals, and the units to load: single pallets and, on lanes that build sandwich pallets, stacks of pallets built on top of each other.
GET https://BASE_URL/api/v1/orders/palletization-summary/
Note
In the examples, BASE_URL is the base URL of your environment, for
example https://api.alphaaugmented.com. See Base URLs for the
complete list.
Requires Authentication.
When to call#
After optimization completes, to book or plan transport from pallet counts, totals and pallet sizes. Works for every shipment that has ALPHA-built pallets, the same ones as [GET] Retrieve pallet contents.
This endpoint does not list what is on each pallet. Use
[GET] Retrieve pallet contents for that, and match pallets on pallet_index.
Production flows should wait for packing_instructions.ready (
Event types) instead of polling. This endpoint is also useful for
retries and backfills once you know optimization finished.
Parameters#
Same lookup as [GET] Download packing instructions: your reference or
alpha_ref. If several orders share a reference, the API uses the newest
match.
|
Parameter |
Type |
Description |
|---|---|---|
|
|
string |
Required. Your |
Request#
curl "https://BASE_URL/api/v1/orders/palletization-summary/?order=YOUR_REF" \
-H "Authorization: Api-Key YOUR_API_KEY"
Response#
200 OK with Content-Type: application/json. Loading units are listed in
the order produced by the optimizer. Dimensions and weights are in the lane’s
units of measure, volumes in m³ (ft³ on lanes using
inches or feet).
Shape:
{
"reference": "<your reference>",
"alpha_ref": "<ALPHA reference>",
"pallet_count": <integer>,
"full_pallet_count": <integer>,
"mixed_pallet_count": <integer>,
"loading_unit_count": <integer>,
"total_weight": <number>,
"total_volume": <number>,
"load_meters": <number> | null,
"loading_units": [
{
"type": "pallet",
"pallet_index": "<optimizer label, e.g. AP 1>",
"pallet_code": "<lane pallet type, e.g. EUR>",
"pallet_type": "full" | "mixed",
"length": <number>,
"width": <number>,
"height": <number>,
"weight": <number>,
"volume": <number>
},
{
"type": "stack",
"stack_index": "<S1, S2, ...>",
"pallets": [
{
"pallet_index": "<optimizer label>",
"pallet_code": "<lane pallet type>",
"pallet_type": "full" | "mixed",
"length": <number>,
"width": <number>,
"height": <number>,
"weight": <number>,
"volume": <number>
}
]
}
]
}
Example:
{
"reference": "PO-4711",
"alpha_ref": "ALPHA-000123",
"pallet_count": 3,
"full_pallet_count": 2,
"mixed_pallet_count": 1,
"loading_unit_count": 2,
"total_weight": 845.3,
"total_volume": 2.977,
"load_meters": null,
"loading_units": [
{
"type": "pallet",
"pallet_index": "AP 1",
"pallet_code": "EUR",
"pallet_type": "full",
"length": 120.0,
"width": 80.0,
"height": 160.0,
"weight": 480.2,
"volume": 1.536
},
{
"type": "stack",
"stack_index": "S1",
"pallets": [
{
"pallet_index": "AP 2",
"pallet_code": "EUR",
"pallet_type": "mixed",
"length": 120.0,
"width": 80.0,
"height": 85.0,
"weight": 210.4,
"volume": 0.816
},
{
"pallet_index": "AP 3",
"pallet_code": "EUR",
"pallet_type": "full",
"length": 120.0,
"width": 80.0,
"height": 65.1,
"weight": 154.7,
"volume": 0.625
}
]
}
]
}
Response fields#
|
Field |
Type |
Description |
|---|---|---|
|
|
string |
Your shipment reference. |
|
|
string |
ALPHA reference of the order that matched. |
|
|
integer |
Number of ALPHA-built pallets, each pallet of a stack counted on its own. |
|
|
integer |
Pallets that carry a single SKU. |
|
|
integer |
Pallets that carry more than one SKU. |
|
|
integer |
Units to load: single pallets plus stacks. Equals |
|
|
number |
Gross weight of all pallets. |
|
|
number |
Volume of all pallets. |
|
|
number or null |
Loading meters (LDM), in meters (feet on imperial lanes). Only on
TruckFTL / TruckLTL lanes with load meter calculation enabled, once
the pallets have been loaded onto a truck; |
|
|
array |
One entry per unit to load, either a single pallet or a stack, described below. |
Each object in loading_units with "type": "pallet":
|
Field |
Type |
Description |
|---|---|---|
|
|
string |
|
|
|
string |
Optimizer label for this pallet (for example |
|
|
string |
Lane pallet type code (for example |
|
|
string |
|
|
|
number |
Packed dimensions of the loaded pallet. |
|
|
number |
Gross weight of the loaded pallet. |
|
|
number |
Volume of the loaded pallet. |
Each object in loading_units with "type": "stack", a sandwich pallet:
pallets built on top of each other and loaded as one unit.
|
Field |
Type |
Description |
|---|---|---|
|
|
string |
|
|
|
string |
Label of the stack within the shipment ( |
|
|
array |
The pallets of the stack, bottom first. Each has the same fields as
a single pallet, without |
Errors#
Same as [GET] Retrieve pallet contents.
|
HTTP status |
Description |
|---|---|
|
|
Unknown order, results not ready, or no ALPHA pallets |
|
|
Missing or invalid API key |
{
"order": [
"Optimization results not available yet, please try after a couple of minutes. If not ready within 10 minutes, reach out to our support team"
]
}
{ "detail": "Invalid API key." }
See Troubleshooting if requests fail unexpectedly.