Air/LCL/LTL Shipments

Payload Format

Use this payload structure for Air, OceanLCL, and TruckLTL shipments.

Endpoint

POST {base url}/api/v1/orders/submit-order/

Requirements

  • At least one order_items entry

Shipment Content Types

Select the content type that matches how your goods are supplied.

Order Items (order_items)

Order items represent raw, unpacked product units with no packaging. The optimizer groups these units into pallets and containers automatically.

Use when: You want automatic pallet building; products ship as loose units; the supplier does not pre-pack.

Includes: item (product/SKU), quantity, and optional metadata (PO, line number, notes). See Order Item Fields below.

Summary: Raw units requiring automatic packing.

Request Body Fields

Field

Type

Is Required

Notes

supplier_name

String

Yes

Supplier name. Must match exactly as configured in the ALPHA Portal (case-sensitive).

consignee_name

String

Yes

Consignee name. Must match exactly as configured in the ALPHA Portal (case-sensitive).

reference

String

Yes

Your order reference (e.g. PO number). Must be unique per order.

transportation_mode

String

Yes

Transport type. Use Air, OceanLCL, or TruckLTL.

order_items

Array of Objects

Yes

List of items being ordered. See Order Item Fields below.

customer_notes

String

No

Customer-related metadata.

send_email

Boolean

No

Whether to send the packing instructions by email. Defaults to true.

extra_recipients

Array of Strings (Email addresses)

No

A list of email addresses to send the packing instructions (To).

extra_cc_recipients

Array of Strings (Email addresses)

No

A list of email addresses to send the packing instructions (CC).

Order Item Fields

See Order Item Explanation above for usage.

Field

Type

Is Required

Notes

item

String

Yes

The item code that will be ordered.

quantity

Integer

Yes

Number of units ordered.

purchase_order

String

No

Purchase order reference.

line_item_number

String

No

Line item number.

notes

String

No

Notes or comments.

Accepted Transportation Modes

Air, OceanLCL, TruckLTL

Example Request

{
   "order_items": [
     {
       "item": "PRD-001",
       "quantity": 2,
       "purchase_order": "string",
       "line_item_number": "string",
       "notes": "string"
     }
   ],
   "reference": "REF-999",
   "customer_notes": "Urgent, deliver by end of week",
   "supplier_name": "Supplier",
   "consignee_name": "Consignee",
   "transportation_mode": "Air",
   "send_email": false,
   "extra_recipients": ["email1@example.com", "email2@example.com"],
   "extra_cc_recipients": ["email3@example.com", "email4@example.com"]
}

Notes: order_items are required. PI is generated after creation and emailed when send_email is true (default).