ALPHA API#

Submit shipment orders and retrieve packing instructions over the REST API.


Base URLs#

Environment

API base URL

Portal

Production

https://api.alphaaugmented.com

portal.alphaaugmented.com

Sandbox

https://api-sandbox.alphaaugmented.com

sandbox.alphaaugmented.com

Authentication uses an API key on every request (Authentication).

How it works#

  1. Create an order for an onboarded lane, providing the correct supplier, consignee, and cargo.

  2. Wait for packing optimization (webhook or polling).

  3. Download packing instructions or read pallet contents.

Details: Integration lifecycle.

Documentation#

Get started

Quickstart, authentication, integration lifecycle.

Get started
API reference

Orders and Webhooks endpoints.

API reference
Domain model

Items, boxes, pallets, and packing concepts.

Domain model
Webhooks

Notify your server of events, such as when packing instructions are ready.

Webhooks