cURL
curl --request GET \
--url https://api.vooma.ai/v0/shipments/{shipmentId} \
--header 'Authorization: Bearer <token>'{
"shipment": {
"id": "<string>",
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"declaredValue": {
"value": 123
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"totalWeight": {
"value": 123
}
},
"equipmentOptions": [
{
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": {
"stops": [
{
"stopReferences": [
{
"value": "<string>"
}
],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {
"sunday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"saturday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"friday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"thursday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"wednesday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"tuesday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"monday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
}
},
"scheduling": {
"methods": [
{
"contact": {
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
}
],
"maxDaysAhead": 123,
"notes": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
}
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"weight": {
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"value": "<string>"
}
]
}
],
"mileage": {
"value": 123
}
},
"references": [
{
"value": "<string>"
}
],
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"id": "<string>",
"equipment": [
{
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
}
],
"dotNumber": "<string>",
"mcNumber": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedEquipment": {
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"costNegotiationGuidance": {
"maxPrice": {
"value": 123
},
"startingPrice": {
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123
}
}
],
"freightModeDetails": {},
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}
],
"references": [
{
"value": "<string>"
}
],
"freightModeDetails": {},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"externalIds": [
{
"value": "<string>"
}
],
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}
}Shipments
Get Shipment
GET
/
shipments
/
{shipmentId}
cURL
curl --request GET \
--url https://api.vooma.ai/v0/shipments/{shipmentId} \
--header 'Authorization: Bearer <token>'{
"shipment": {
"id": "<string>",
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"declaredValue": {
"value": 123
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"totalWeight": {
"value": 123
}
},
"equipmentOptions": [
{
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
]
},
"route": {
"stops": [
{
"stopReferences": [
{
"value": "<string>"
}
],
"location": {
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"contacts": [
{
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
],
"hours": {
"sunday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"saturday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"friday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"thursday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"wednesday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"tuesday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
},
"monday": {
"timezone": "<string>",
"endTime": "<string>",
"startTime": "<string>"
}
},
"scheduling": {
"methods": [
{
"contact": {
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
}
],
"maxDaysAhead": 123,
"notes": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
}
},
"id": "<string>",
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123
}
}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123
},
"width": {
"value": 123
},
"length": {
"value": 123
}
},
"weight": {
"value": 123
},
"hazmat": {
"classifications": [
{}
],
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>",
"reference": {
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceQuantity": 123,
"handlingQuantity": 123
}
],
"weight": {
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>"
}
],
"externalIds": [
{
"value": "<string>"
}
]
}
],
"mileage": {
"value": 123
}
},
"references": [
{
"value": "<string>"
}
],
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>",
"tmsStatus": "<string>",
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"id": "<string>",
"equipment": [
{
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
}
],
"dotNumber": "<string>",
"mcNumber": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"id": "<string>",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"role": "<string>"
}
},
"assignedEquipment": {
"equipment": {
"equipmentLength": {
"value": 123
},
"temperature": {
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"costNegotiationGuidance": {
"maxPrice": {
"value": 123
},
"startingPrice": {
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123
}
}
],
"freightModeDetails": {},
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}
],
"references": [
{
"value": "<string>"
}
],
"freightModeDetails": {},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"value": 123
}
}
]
},
"externalIds": [
{
"value": "<string>"
}
],
"responsibleUser": {
"externalIds": [
{
"value": "<string>"
}
],
"id": "<string>"
}
}
}Beta Feature: This functionality is currently in beta. You
may experience changes or limited support as we continue to improve it.
⌘I

