[GET] List orders#

Lists the orders your API key can access, newest first.

Note

Consolidated child orders are omitted.

GET https://BASE_URL/api/v1/orders/detailed-orders/

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.

Parameters#

Parameter	Type	Description
`page`	integer	Optional. Page number. Default: `1`.
`page_size`	integer	Optional. Results per page. Default: `10`.
`paginate`	string	Optional. Set to `false` for a bare JSON array instead of the paginated envelope.
`search`	string	Optional. Filters by `alpha_ref`, related shipment refs, or transportation mode name.

Request#

                                            curl https://BASE_URL/api/v1/orders/detailed-orders/ \
  -H "Authorization: Api-Key YOUR_API_KEY"

Response#

200 OK. Each entry in results has the fields below.

With paginate=false, the body is a JSON array of the same objects. Orders outside your API key scope are omitted (empty results), not 403.

Field	Type	Description
`id`	integer	Order ID. Use with [GET] Retrieve an order (`GET /detailed-orders/{id}/`).
`alpha_ref`	string	Unique ALPHA identifier (for example `ALPHA-ABC123`). Appears in webhook `data.order_id`. Also used for [GET] Download packing instructions and [GET] Retrieve pallet contents lookups.
`reference`	string	Your shipment reference from create. May be blank. Not guaranteed unique. Download and pallet lookups use the newest match when several orders share a reference.
`customer_notes`	string	Optional notes supplied when the order was created.
`shipment_type`	string	One of `normal`, `dangerous_goods`, or `dedicated_container`.
`lane`	integer	Lane ID.
`transport_name`	string	Transportation mode (for example `Air` or `OceanFCL`).
`packing_instructions_downloaded`	boolean	Whether the packing instructions file was downloaded through this API.
`order_items`	array	Submitted SKUs (ALPHA palletizes these when present).
`pre_builts`	array	Submitted pre-built pallets.
`loose_boxes`	array	Submitted loose boxes.
`created_at`	string	Creation time in ISO 8601 format.
`updated_at`	string	Last update time in ISO 8601 format.

order_items, pre_builts, and loose_boxes reflect what you submitted at create time. For ALPHA-built pallets after optimization, use [GET] Retrieve pallet contents.

Note

Responses use these names whichever form the request used — shipment_skus, pallets and boxes are accepted on input only. Nothing you already parse changes.

200 OK

                                                    {
  "count": 42,
  "next": "https://BASE_URL/api/v1/orders/detailed-orders/?page=2",
  "previous": null,
  "results": [
    {
      "id": 35,
      "order_items": [],
      "pre_builts": [],
      "loose_boxes": [],
      "alpha_ref": "ALPHA-ABC123",
      "reference": "REF-999",
      "customer_notes": null,
      "shipment_type": "normal",
      "lane": 7,
      "transport_name": "Air",
      "packing_instructions_downloaded": false,
      "created_at": "2025-08-04T13:25:29.901127",
      "updated_at": "2025-08-04T13:25:57.838396"
    }
  ]
}

                                                

Errors#

HTTP status	Description
`401 Unauthorized`	Missing or invalid API key

401

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

                                                

See Troubleshooting if requests fail unexpectedly.