Shipment Assembly (0.4.15)

Download OpenAPI specification:Download

Create Shipment

Create a shipment for one or more orders

SecurityAPIKeyHeader
Request
Request Body schema: application/json
required
customer_id
string <uuid> (Customer Id)
Array of objects (Orders)
Array of objects (Orders Simple)

Simple list of order id and the order type to allow creating shipments from orders. Only orders_simple or orders should be specified. If orders_simple is specified, then the full list of order objects does not need to be specified or set as the orders property.

Array of objects (Groups)

Optional list of groups to associate with the shipment. When using 'orders', groups from this field are always used. When using 'orders_simple', if this field is provided it overrides groups from the orders; if not provided, groups from the orders are used.

mode
string (Mode)
Enum: "LTL" "FTL" "VLTL" "DRAYAGE" "PARCEL" "INTERMODAL" "RAIL_CAR" "AIR" "FCL" "LCL"
movement_type
string (MovementType)

Enum for Movement Type

Enum: "DOOR_TO_DOOR" "PORT_TO_PORT" "DOOR_TO_PORT" "PORT_TO_DOOR"
equipment_type
string (Equipment Type)
Default: "DRY_VAN"

Equipment type machine readable code of the shipment. Defaults to 'DRY_VAN'. Reference the list of available equipment types from the Shipwell Reference Data Standard for Equipment Type here.

service_level
string (Service Level)

Service level code of the shipment (e.g. EXPEDITE). Reference the list of available service levels from the Shipwell Reference Data Standard for Service Level here.

distribution_mode
boolean (Distribution Mode)
Default: false
object (Location)
object (Location)
status
string (ShipmentStatusType)
Default: "quoting"

Enum for Status of Shipment

Enum: "draft" "quoting"
Responses
200

Successful Response

Response Schema: application/json
object (Response Create Shipment Post)
400

Validation Error

post/shipment-assembly/load/create_shipment
Request samples
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "orders": [
    ],
  • "orders_simple": [
    ],
  • "groups": [
    ],
  • "mode": "LTL",
  • "movement_type": "DOOR_TO_DOOR",
  • "equipment_type": "DRY_VAN",
  • "service_level": "string",
  • "distribution_mode": false,
  • "shared_origin": {
    },
  • "shared_destination": {
    },
  • "status": "quoting"
}
Response samples
application/json
{ }
Copyright © Shipwell 2025. All right reserved.