Shipment Assembly (0.4.11)

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.
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": [{"external_id": "string",
"id": "string",
"resource_type": "order",
"order_number": "string",
"order_name": "string",
"purchase_order_number": "string",
"customer_name": "string",
"supplier_name": "string",
"shipment_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"pickup_start_time": "2019-08-24T14:15:22Z",
"pickup_end_time": "2019-08-24T14:15:22Z",
"drop_off_start_time": "2019-08-24T14:15:22Z",
"drop_off_end_time": "2019-08-24T14:15:22Z",
"pickup_index": 0,
"drop_off_index": 0,
"pallets": 0,
"ftl_price": 0,
"ltl_price": 0,
"trip_miles": 0,
"origin_dock_external_id": "string",
"destination_dock_external_id": "string",
"origin_address_book_entry": "string",
"destination_address_book_entry": "string",
"origin_address": {"external_id": "string",
"resource_type": "address",
"address_1": "string",
"address_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string",
"timezone": "string",
"lat": 0,
"long": 0
},
"destination_address": {"external_id": "string",
"resource_type": "address",
"address_1": "string",
"address_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string",
"timezone": "string",
"lat": 0,
"long": 0
},
"line_items": [{"resource_type": "line_item",
"external_id": "string",
"description": "string",
"product_ref": "string",
"total_line_item_weight": 0,
"weight_unit": "LB",
"height": 0,
"length": 40,
"width": 48,
"length_unit": "string",
"freight_class": "string",
"stackable": true,
"refrigeration_required": true,
"total_pieces": 0,
"total_packages": 0,
"package_type": "string",
"piece_type": "string",
"nmfc_item_code": "string",
"nmfc_sub_code": "string",
"value_per_piece": 0,
"value_per_piece_currency": "USD",
"refrigeration_min_temp": 0,
"refrigeration_max_temp": 0,
"temp_unit": "C",
"provider_specific_packaging": "string",
"package_weight": "string",
"country_of_manufacture": "string",
"custom_data": { },
"hazmat_hazard_class": "string",
"hazmat_identification_number": "string",
"hazmat_packing_group": "string",
"hazmat_proper_shipping_name": "string",
"handling_unit_id": "string",
"combined_handling_unit_info": {"quantity": 0,
"packaging_type": "string",
"freight_class": "string",
"dimensions": {"unit": "string",
"length": "string",
"height": "string",
"width": "string"
},
"weight": {"unit": "string",
"value": "string"
}
}
}
],
"total_volume_feet": "string",
"total_weight_lbs": "string",
"updated_events": [ ],
"custom_data": { },
"bill_to": {"account_number": "string",
"billing_id": "string",
"payment_term": "PREPAID",
"billing_company_name": "string",
"billing_address": {"country": "string",
"line_1": "string",
"line_2": "string",
"line_3": "string",
"locality": "string",
"postal_code": "string",
"region": "string",
"geolocation": {"latitude": 0,
"longitude": 0
}
},
"contact": {"contact_email": "string",
"contact_phone": "string"
}
},
"tags": [{"id": "string",
"name": "string",
"slug": "string",
"color": "string"
}
]
}
],
"orders_simple": [{"id": "string",
"resource_type": "order"
}
],
"mode": "LTL",
"movement_type": "DOOR_TO_DOOR",
"equipment_type": "DRY_VAN",
"service_level": "string",
"distribution_mode": false,
"shared_origin": {"address": {"external_id": "string",
"resource_type": "address",
"address_1": "string",
"address_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string",
"timezone": "string",
"lat": 0,
"long": 0
},
"address_book_entry": "string",
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
},
"shared_destination": {"address": {"external_id": "string",
"resource_type": "address",
"address_1": "string",
"address_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string",
"timezone": "string",
"lat": 0,
"long": 0
},
"address_book_entry": "string",
"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z"
},
"status": "quoting"
}

Response samples

application/json

{ }

Shipment Assembly (0.4.11)

Create Shipment

Request Body schema: application/jsonrequired

Response Schema: application/json

Request Body schema: application/json
required