Air, LCL, and LTL#

This body

Air OceanLCL TruckLTL

One schema for all three. Send SKUs in shipment_skus; ALPHA palletizes them during optimization.

FCL / FTL instead?

OceanFCL TruckFTL

ALPHA can palletize SKUs and also accept pre-built pallets and loose boxes. See FCL and FTL.

FCL and FTL

Request body#

                                            {
  "shipper_name": "Supplier",
  "consignee_name": "Consignee",
  "transportation_mode": "Air",
  "origin": "Dubai Airport",
  "destination": "Amsterdam Airport",
  "reference": "REF-001",
  "shipment_skus": [
    { "item": "PRD-001", "quantity": 10 }
  ]
}

                                        

Parameters#

Parameter	Also accepted as	Type	Description
`shipper_name`	`supplier_name`	string	Required. Case-insensitive. Company name aliases accepted.
`consignee_name`	—	string	Required. Case-insensitive. Company name aliases accepted.
`origin`	—	string	Optional. Free-text origin (city, port, airport, or address). Maximum length: 255.
`destination`	—	string	Optional. Free-text destination (city, port, airport, or address). Maximum length: 255.
`transportation_mode`	—	string	Required. `Air`, `OceanLCL`, or `TruckLTL`.
`reference`	—	string	Optional. Your order reference. Maximum length: 1000. Not unique; lookups use the newest match.
`load_plan_reference`	—	string	Optional. Maximum length: 64.
`shipment_type`	—	string	Optional. Default: `normal`. See Shipment type.
`shipment_skus`	`order_items`	array of objects	Optional. Empty list accepted. See Shipment SKUs.
`customer_notes`	—	string	Optional. Free-text notes.
`send_email`	—	boolean	Optional. Default: `false`. Customer packing-instructions email on submit is currently disabled.
`skip_missing_lane`	—	boolean	Optional. Default: `false`. If no matching lane is found, `false` returns `400`. When `true`, the order is accepted (`200`) while the lane gets set up.
`extra_recipients`	—	array of strings	Optional. Extra To addresses for missing-lane notifications.
`extra_cc_recipients`	—	array of strings	Optional. Extra CC addresses.

Shipment type#

Value	Description
`normal`	Default. May consolidate with other shipments.
`dangerous_goods`	Must not consolidate with other shipments.
`dedicated_container`	Consolidates only with other dedicated-container shipments.

Shipment SKUs#

Objects in shipment_skus.

Parameter	Type	Description
`item`	string	Required. Item / stock-keeping unit (SKU) code.
`quantity`	number	Required. Minimum: `0.01`. Decimals allowed; normalized on save.
`purchase_order`	string	Optional. Purchase order reference.
`line_item_number`	string	Optional. Line item number.
`notes`	string	Optional. Notes or comments.