latestOpenAPI 3.0.02026-08-08163663.9 KB
4aa7f4326443
Shipper
Create a shipment/offer
Creates a shipment based on the factors provided in the request body. This API endpoint can only be accessed by Admins and Shippers! action - add, update, cancel
post/shipments
Request body
Example request
{
"action": "add",
"shipment": {
"reference_numbers": [
{
"name": "My Primary Reference",
"value": "cargomatic123"
}
],
"shipment_type": "shorthaul",
"shipper": "62879ea006bfa2d915861ba6",
"stops": [
{
"sequence": 1,
"location": {
"name": "Cargomatic HQ",
"address": "211 E. Ocean Blvd Long Beach CA 90802",
"suite_or_apt": "Suite 350"
},
"loads": [
{
"type": "pallets",
"quantity": 5,
"width": 40,
"height": 48,
"length": 40,
"weight": 2500
}
],
"contacts": [
{
"name": "support",
"email": "support@cargomatic.com",
"phone": "555-555-5555"
}
],
"action": "pickup",
"window_start": "2022-03-31T18:00:00.000Z",
"window_end": "2022-03-31T21:00:00.000Z",
"reference_numbers": [
{
"name": "My Stop Reference Number",
"value": "cargomatic123456"
}
]
}
],
"loads": [
{
"type": "pallets",
"quantity": 5,
"width": 40,
"height": 48,
"length": 40,
"weight": 2500
}
],
"accessorials": [
{
"type": "pallet_jack"
}
],
"weight": 2500,
"notes": "These are my notes!"
}
}Response
Status Code 200: Successful Response - the request was successful!
Example response
{
"action": "add",
"shipment": {
"shipment_type": "shorthaul",
"shipper": "shipper@cargomatic.com",
"reference_numbers": [
{
"name": "My Primary Reference",
"value": "cargomatic123"
}
],
"stops": [
{
"sequence": 1,
"location": {
"name": "Cargomatic HQ",
"address": "211 E. Ocean Blvd Long Beach CA 90802",
"suite_or_apt": "Suite 350"
},
"loads": [
{
"type": "pallets",
"quantity": 5,
"width": 40,
"height": 48,
"length": 40,
"weight": 2500
}
],
"contacts": [
{
"name": "support",
"email": "support@cargomatic.com",
"phone": "555-555-5555"
}
],
"action": "pickup",
"window_start": "2022-03-31T18:00:00.000Z",
"window_end": "2022-03-31T21:00:00.000Z",
"reference_numbers": [
{
"name": "My Stop Reference Number",
"value": "cargomatic123456"
}
]
}
],
"loads": [
{
"type": "pallets",
"quantity": 5,
"width": 40,
"height": 48,
"length": 40,
"weight": 2500
}
],
"accessorials": [
{
"type": "pallet_jack"
}
],
"weight": 2500,
"notes": "These are my notes!"
}
}