API Overview

Integrate shipment ordering and packing optimization into your systems. Submit orders, run optimization, and retrieve packing instructions through a single REST API.

API Base URLs

Use the base URL that matches your environment:

Environment	Base URL	Portal
Production	https://api.alphaaugmented.com	Portal
Sandbox	https://api-sandbox.alphaaugmented.com	Sandbox Portal

Important

Onboarding must be completed before creating orders. Supplier, consignee, items, boxes, pallets, and packing specifications must be configured in the ALPHA Portal. Contact your point of contact if anything is missing.

Note

Use Sandbox for testing. It mirrors Production but uses separate data. Switch to Production when ready to create live orders.

Quick Start Guide

1. Obtain an API key — Log in to the ALPHA Portal → API Keys → Generate Key

2. Add authentication — Include Authorization: Api-Key <your-key> in every request

3. Submit an order — POST to the submit-order endpoint with your payload

Typical Order Flow

1. Submit — POST your order payload to create the order

2. Processing — The optimizer runs. The PI is emailed to defined recipients, or fetch it via Download Packing Instructions.

3. Optional — Use Get Order by ID or List All Orders to check status

See API Authentication for full details.

API Reference

• API Authentication
• Guides
  • Concepts
  • Objects Overview
• Order Management
  • Submit Order
    • Air/LCL/LTL Shipments
    • FCL/FTL Shipments
  • List All Orders
  • Get Order by ID
  • Download Packing Instructions
• Units of Measure