API reference#

The ALPHA API lets you submit shipment orders and download packing instructions after optimization. It also sends webhooks to notify your server when events happen, for example when packing instructions are ready to download.

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.

Every request must include a valid API key (Authentication).

Endpoints#

Shipment Orders

Create orders, list or retrieve them, download packing instructions, read pallet contents.

Shipment Orders
Create an order

Submit a shipment order for packing optimization.

[POST] Create an order
Air, LCL, and LTL

Request body and parameters when ALPHA palletizes SKUs.

Air, LCL, and LTL
FCL and FTL

Request body and parameters for SKUs, pre-built pallets, and loose boxes.

FCL and FTL
Webhooks

Configure endpoints, event types, signature verification, and delivery behavior.

Webhooks

Guides#

New to the API? Start with Quickstart, then Integration lifecycle. If a call fails, see Troubleshooting.