ALPHA API
Quickstart#
This guide walks through a minimal integration: create an API key, submit an Air order, and download packing instructions.
Before you begin, confirm your lane is onboarded (supplier, consignee, SKUs). For other transportation modes, see Shipment Orders.
Create an API key#
Create a key in the Portal for your environment (see Base URLs) and store it in a secrets manager. The key is shown only once when created. See Authentication for the required header format.
Create an order#
This example uses Air (ALPHA palletizes SKUs). The same POST URL
applies to all modes; see [POST] Create an order and either
Air, LCL, and LTL (Air, LCL, LTL) or
FCL and FTL (FCL, FTL, SKUs, or prepacked cargo).
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.
curl https://BASE_URL/api/v1/orders/submit-order/ \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shipper_name": "Supplier",
"consignee_name": "Consignee",
"transportation_mode": "Air",
"reference": "QS-001",
"shipment_skus": [
{ "item": "PRD-001", "quantity": 10 }
]
}'
A successful call returns 201 Created:
{
"message": "Order has been created and will be processed shortly",
"order_id": 42
}
For a full field reference and HTTP details, see Air, LCL, and LTL and [POST] Create an order.
Download packing instructions#
Optimization usually completes within a few minutes. Production integrations should use Event types; you can poll for a first test:
curl "https://BASE_URL/api/v1/orders/download-packing-instructions/?order=QS-001" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-o packing_instructions.pdf
If the response is 400 Bad Request, optimization is still running. Retry
with backoff.
Next steps#
Webhooks, pallet contents, and production flow.
Full endpoint list.
Common errors and fixes.