FCL and FTL

This body

OceanFCL TruckFTL

One schema for both. Requires containers to be defined. Accepts SKUs, pre-built pallets, and/or loose boxes.

Air / LCL / LTL instead?

Air OceanLCL TruckLTL

SKUs only, ALPHA palletizes them. See Air, LCL, and LTL.

Air, LCL, and LTL

Request body

{
  "shipper_name": "Supplier",
  "consignee_name": "Consignee",
  "transportation_mode": "OceanFCL",
  "reference": "REF-001",
  "containers": [{ "code": "40ft" }],
  "shipment_skus": [{ "item": "PRD-001", "quantity": 10 }]
}

Use TruckFTL instead of OceanFCL for full truck. Container code values are lane-specific.

Additional examples

Mixed cargo

{
  "reference": "REF-999",
  "shipper_name": "Supplier",
  "consignee_name": "Consignee",
  "transportation_mode": "OceanFCL",
  "shipment_type": "dangerous_goods",
  "bonded_cargo": true,
  "origin": "Port of Rotterdam",
  "destination": "Amsterdam",
  "containers": [
    { "code": "20ft", "count": 5 }
  ],
  "shipment_skus": [
    {
      "item": "PRD-001",
      "quantity": 2,

      "purchase_order": "PO-001",
      "line_item_number": "1"
    }
  ],
  "pallets": [
    {
      "name": "PreBuilt Box A",
      "length": "120.0",
      "width": "80.0",
      "height": "100.0",
      "weight": "35.5",
      "count": 2,
      "huid": "HUID-0001",
      "un_number": ["UN1263", "UN3081"],
      "dg_class": ["3", "9"],
      "pi_number": ["353", "965"],
      "limited_quantity": ["5"],
      "pallet_contents": [
        {
          "purchase_order": "PO-001",
          "line_item_number": "L1",
          "quantity": 20,
          "packages": 5
        }
      ]
    }
  ],
  "boxes": [
    {
      "name": "Loose Box 1",
      "length": "60.0",
      "width": "40.0",
      "height": "30.0",
      "weight": "8.5",
      "count": 5,
      "huid": "HUID-0002",
      "un_number": ["UN3081"],
      "dg_class": ["9"],
      "pi_number": ["965"]
    }
  ]
}

Pallets only

{
  "reference": "REF-FCL-PB-LB-001",
  "shipper_name": "Supplier",
  "consignee_name": "Consignee",
  "transportation_mode": "OceanFCL",
  "containers": [
    { "code": "40ft", "count": 2 }
  ],
  "pallets": [
    {
      "name": "Floor slot A",
      "length": "120.0",
      "width": "80.0",
      "height": "100.0",
      "weight": "35.5",
      "count": 2,
      "pallet_contents": []
    }
  ],
  "boxes": [
    {
      "name": "Loose carton B",
      "length": "60.0",
      "width": "40.0",
      "height": "30.0",
      "weight": "8.5",
      "count": 4
    }
  ]
}

---

Parameters

Top-level fields for the request body.

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. OceanFCL or TruckFTL.
containers	order_containers	array of objects	Required. Non-empty list. See Containers.
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.
bonded_cargo	—	boolean	Optional. Default: false. Marks the shipment as bonded cargo.
shipment_skus	order_items	array of objects	Optional. See Shipment SKUs.
pallets	pre_builts	array of objects	Optional. See Pallets.
boxes	loose_boxes	array of objects	Optional. See Boxes.
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

Set shipment_type on the top-level payload only (not inside pallets or boxes).

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.

Containers

Objects in containers. Each code may appear only once.

Parameter	Type	Description
code	string	Required. Must be enabled for the lane. See Container codes.
count	integer	Optional. Number of containers of this code. Omit the field unless you need a specific count; the default is one per code.

Container codes

Known codes. The code must also be enabled for your lane.

Standard / High Cube	Specialized
20ft, 40ft, 40ft-HC, 45ft-HC	20ft-RF, 40ft-HC RF, 20ft-OT, 40ft-OT

Shipment SKUs

Objects in shipment_skus. Requires item master data for submitted 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. Maximum length: 64. Do not use & or commas.
line_item_number	string	Optional. Maximum length: 64. Do not use & or commas.
notes	string	Optional. Notes or comments.

Pallets

Objects in pallets. Pallets assembled by the supplier and loaded exactly as provided.

Parameter	Also accepted as	Type	Description
name	—	string	Required. Maximum length: 64.
length, width, height	—	string	Required. Must be > 0. Maximum: 12 digits, 6 decimals. Units follow your lane (Units of measure).
weight	—	string	Required. Must be > 0. Maximum: 15 digits, 6 decimals. Units follow your lane (Units of measure).
count	—	integer	Optional. Default: 1.
pallet_contents	prebuiltitem_set	array of objects	Required. May be empty []. See Pallet content.
double_stacked_bottom	—	boolean	Optional. Whether this pallet can be stacked below.
double_stacked_top	—	boolean	Optional. Whether this pallet can be stacked above.
rotation_x	—	boolean	Optional. Default: true. Allows rotating the footprint (length/width may swap).
tag	—	string	Optional. Maximum length: 64.
warehouse_location	—	string	Optional. Maximum length: 64. Shown on container packing instructions when set.
huid	—	string	Optional. Maximum length: 64. Handling unit ID.
un_number	—	string or array of strings	Optional. One or more UN numbers (e.g. "UN3081" or ["UN3081", "UN1263"]). Max 16 chars each.
dg_class	—	string or array of strings	Optional. One or more hazard classes (e.g. "3" or ["3", "9"]). Max 16 chars each.
pi_number	—	string or array of strings	Optional. One or more packing instructions (e.g. "353" or ["353", "965"]). Max 16 chars each.
limited_quantity	—	string or array of strings	Optional. One or more maximum quantities (e.g. "5" or ["5", "10"]). Max 64 chars each.

Note

Dangerous goods values are trimmed, empty ones are dropped, and any value (including a comma-separated string) is accepted. They appear in the Dangerous Good Details columns of the packing instructions, one per line.

Pallet content

Objects in pallet_contents. The item breakdown on a pre-built pallet.

Parameter	Type	Description
purchase_order	string	Optional. Maximum length: 64.
line_item_number	string	Optional. Maximum length: 64.
quantity	integer	Optional. Default: 1.
packages	integer	Optional. Minimum: 1 when set.

Boxes

Objects in boxes. Standalone cartons placed during optimization.

Parameter	Type	Description
name	string	Required. Maximum length: 64.
length, width, height	string	Required. Must be > 0. Maximum: 12 digits, 6 decimals. Units follow your lane (Units of measure).
weight	string	Required. Must be > 0. Maximum: 15 digits, 6 decimals. Units follow your lane (Units of measure).
count	integer	Optional. Default: 1.
purchase_order	string	Optional. Maximum length: 64.
line_item_number	string	Optional. Maximum length: 64.
product_quantity	integer	Optional. Minimum: 1 when set.
product_packages	integer	Optional. Minimum: 1 when set.
double_stacked_bottom	boolean	Optional. Whether this box can be stacked below.
double_stacked_top	boolean	Optional. Whether this box can be stacked above.
rotation_x, rotation_y, rotation_z	boolean	Optional. Default: true for all three. Send all three together.
tag	string	Optional. Maximum length: 64.
warehouse_location	string	Optional. Maximum length: 64. Shown on container packing instructions when set.
huid	string	Optional. Maximum length: 64. Handling unit ID.
un_number	string or array of strings	Optional. One or more UN numbers (e.g. "UN3081" or ["UN3081", "UN1263"]). Max 16 chars each.
dg_class	string or array of strings	Optional. One or more hazard classes (e.g. "3" or ["3", "9"]). Max 16 chars each.
pi_number	string or array of strings	Optional. One or more packing instructions (e.g. "353" or ["353", "965"]). Max 16 chars each.
limited_quantity	string or array of strings	Optional. One or more maximum quantities (e.g. "5" or ["5", "10"]). Max 64 chars each.

Note

Dangerous goods values are trimmed, empty ones are dropped, and any value (including a comma-separated string) is accepted. They appear in the Dangerous Good Details columns of the packing instructions, one per line.