[GET] Retrieve pallet contents#

Returns a JSON array describing ALPHA-built pallets after optimization. Each pallet lists SKUs with purchase order, line item number, and quantity on that pallet.

GET https://BASE_URL/api/v1/orders/pallet-contents/

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#

Use this endpoint

After optimization completes and the shipment includes SKU line items that ALPHA palletized (order_items on Air / LCL / LTL or FCL / FTL orders).

Do not expect pallet JSON

Shipments with only pre-built pallets and/or loose boxes (no ALPHA-built pallets from SKUs). Those units are loaded as submitted; see FCL and FTL.

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
`order`	string	Required. Your `reference` or `alpha_ref`.

Request#

                                            curl "https://BASE_URL/api/v1/orders/pallet-contents/?order=YOUR_REF" \
  -H "Authorization: Api-Key YOUR_API_KEY"

Response#

200 OK with Content-Type: application/json. The body is a JSON array of pallet objects (one entry per ALPHA-built pallet), in the order produced by the optimizer.

Shape:

                                            [
  {
    "pallet_index": "<optimizer label, e.g. AP1>",
    "pallet_code": "<lane pallet type, e.g. EUR>",
    "contents": [
      {
        "sku": "<product code>",
        "purchase_order": "<PO reference>",
        "line_item_number": "<line item>",
        "quantity": <integer>
      }
    ]
  }
]

                                        

Example:

200 OK

                                                    [
  {
    "pallet_index": "AP1",
    "pallet_code": "EUR",
    "contents": [
      {
        "sku": "PRD-001",
        "purchase_order": "PO-1001",
        "line_item_number": "10",
        "quantity": 150
      },
      {
        "sku": "PRD-002",
        "purchase_order": "PO-1001",
        "line_item_number": "20",
        "quantity": 40
      }
    ]
  },
  {
    "pallet_index": "AP2",
    "pallet_code": "EUR",
    "contents": [
      {
        "sku": "PRD-001",
        "purchase_order": "PO-1002",
        "line_item_number": "10",
        "quantity": 80
      }
    ]
  }
]

                                                

Response fields#

Top-level array item (pallet):

Field	Type	Description
`pallet_index`	string	Optimizer label for this pallet (for example `AP1`, `AP2`).
`pallet_code`	string	Lane pallet type code (for example `EUR`).
`contents`	array	SKUs on this pallet, grouped by SKU / PO / line item (quantities summed).

Each object in contents:

Field	Type	Description
`sku`	string	Product / SKU code.
`purchase_order`	string	Purchase order reference (empty string when not set).
`line_item_number`	string	Line item number (empty string when not set).
`quantity`	integer	Total quantity of that SKU / PO / line on this pallet.

Errors#

HTTP status	Description
`400 Bad Request`	Unknown order, results not ready, or no ALPHA pallets
`401 Unauthorized`	Missing or invalid API key

400 Not found

                                                    {
  "order": [
    "No order found matching the provided reference."
  ]
}

                                                

400 Not ready

                                                    {
  "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"
  ]
}

                                                

400 No pallets

Shipments with no ALPHA-built pallets (for example FCL / FTL orders with only pre-built pallets and/or loose boxes):

                                                    {
  "order": [
    "No ALPHA pallets are available in this shipment"
  ]
}

                                                

401

                                                    { "detail": "Invalid API key." }

                                                

See Troubleshooting if requests fail unexpectedly.