curl --request POST \
--url https://api.vooma.ai/v0/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"shipment": {
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"declaredValue": {
"uom": "USD",
"value": 123
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"totalWeight": {
"units": "LB",
"value": 123
}
},
"equipmentOptions": [
{
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"type": "ALJEX",
"value": "<string>"
}
],
"contacts": [
{
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
}
],
"id": "<string>"
},
"route": {
"stops": [
{
"location": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
},
"name": "<string>",
"id": "<string>"
},
"type": "PICKUP",
"stopReferences": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"weight": {
"units": "LB",
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>",
"type": "FACILITY_HOURS"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
],
"mileage": {
"uom": "MI",
"value": 123
}
},
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"equipment": [
{
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
}
],
"dotNumber": "<string>",
"mcNumber": "<string>",
"id": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedEquipment": {
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"paymentTerms": "PREPAID",
"costNegotiationGuidance": {
"maxPrice": {
"uom": "USD",
"value": 123
},
"startingPrice": {
"uom": "USD",
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"freightModeDetails": {
"mode": "TRUCKLOAD",
"drayageSubtype": "IMPORT"
},
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
},
"id": "<string>"
}
],
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
}
}
'{
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"declaredValue": {
"uom": "USD",
"value": 123
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"totalWeight": {
"units": "LB",
"value": 123
}
},
"equipmentOptions": [
{
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"type": "ALJEX",
"value": "<string>"
}
],
"contacts": [
{
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
}
],
"id": "<string>"
},
"route": {
"stops": [
{
"location": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
},
"name": "<string>",
"id": "<string>"
},
"type": "PICKUP",
"stopReferences": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"weight": {
"units": "LB",
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>",
"type": "FACILITY_HOURS"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
],
"mileage": {
"uom": "MI",
"value": 123
}
},
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"equipment": [
{
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
}
],
"dotNumber": "<string>",
"mcNumber": "<string>",
"id": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedEquipment": {
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"paymentTerms": "PREPAID",
"costNegotiationGuidance": {
"maxPrice": {
"uom": "USD",
"value": 123
},
"startingPrice": {
"uom": "USD",
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"freightModeDetails": {
"mode": "TRUCKLOAD",
"drayageSubtype": "IMPORT"
},
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
},
"id": "<string>"
}
],
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
}curl --request POST \
--url https://api.vooma.ai/v0/shipments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"shipment": {
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"declaredValue": {
"uom": "USD",
"value": 123
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"totalWeight": {
"units": "LB",
"value": 123
}
},
"equipmentOptions": [
{
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"type": "ALJEX",
"value": "<string>"
}
],
"contacts": [
{
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
}
],
"id": "<string>"
},
"route": {
"stops": [
{
"location": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
},
"name": "<string>",
"id": "<string>"
},
"type": "PICKUP",
"stopReferences": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"weight": {
"units": "LB",
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>",
"type": "FACILITY_HOURS"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
],
"mileage": {
"uom": "MI",
"value": 123
}
},
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"equipment": [
{
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
}
],
"dotNumber": "<string>",
"mcNumber": "<string>",
"id": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedEquipment": {
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"paymentTerms": "PREPAID",
"costNegotiationGuidance": {
"maxPrice": {
"uom": "USD",
"value": 123
},
"startingPrice": {
"uom": "USD",
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"freightModeDetails": {
"mode": "TRUCKLOAD",
"drayageSubtype": "IMPORT"
},
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
},
"id": "<string>"
}
],
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
}
}
'{
"movements": [
{
"cargo": {
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"declaredValue": {
"uom": "USD",
"value": 123
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"totalWeight": {
"units": "LB",
"value": 123
}
},
"equipmentOptions": [
{
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
}
],
"customer": {
"name": "<string>",
"externalIds": [
{
"type": "ALJEX",
"value": "<string>"
}
],
"contacts": [
{
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
}
],
"id": "<string>"
},
"route": {
"stops": [
{
"location": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"address": {
"country": "<string>",
"postalCode": "<string>",
"city": "<string>",
"state": "<string>",
"addressTwo": "<string>",
"addressOne": "<string>"
},
"geoCoordinates": {
"longitude": 123,
"latitude": 123
},
"name": "<string>",
"id": "<string>"
},
"type": "PICKUP",
"stopReferences": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"commodities": [
{
"description": "<string>",
"isStackable": true,
"itemReference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
},
"dimensions": {
"height": {
"value": 123,
"units": "IN"
},
"width": {
"value": 123,
"units": "IN"
},
"length": {
"value": 123,
"units": "IN"
}
},
"weight": {
"units": "LB",
"value": 123
},
"hazmat": {
"classifications": [
{
"qualifier": "P",
"hazardClass": "1"
}
],
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>",
"reference": {
"type": "ORDER_REFERENCE",
"value": "<string>"
}
},
"packingGroup": "<string>",
"unNumber": "<string>",
"weight": {
"units": "LB",
"value": 123
}
},
"nmfcCode": "<string>",
"freightClass": "<string>",
"pieceUnits": "BAGS",
"pieceQuantity": 123,
"handlingUnits": "BAGS",
"handlingQuantity": 123
}
],
"weight": {
"units": "LB",
"value": 123
},
"notes": "<string>",
"dateTimeRanges": [
{
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>",
"type": "FACILITY_HOURS"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
],
"mileage": {
"uom": "MI",
"value": 123
}
},
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"attributes": {},
"tags": [
"<string>"
],
"externalNotes": "<string>",
"internalNotes": "<string>",
"carrier": {
"carrier": {
"name": "<string>",
"equipment": [
{
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
],
"contacts": [
{
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
}
],
"dotNumber": "<string>",
"mcNumber": "<string>",
"id": "<string>"
},
"assignedDispatch": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedDriver": {
"contact": {
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<string>",
"id": "<string>"
},
"type": "DRIVER"
},
"assignedEquipment": {
"equipment": {
"type": "BOX_TRUCK",
"equipmentLength": {
"value": 123,
"units": "IN"
},
"temperature": {
"units": "F",
"max": 123,
"min": 123
},
"description": "<string>"
},
"trailerNumber": "<string>",
"truckNumber": "<string>"
}
},
"financials": {
"costs": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"chargesToCustomer": {
"lineItems": [
{
"description": "<string>",
"amount": {
"uom": "USD",
"value": 123
},
"type": "FREIGHT_FLAT"
}
]
},
"paymentTerms": "PREPAID",
"costNegotiationGuidance": {
"maxPrice": {
"uom": "USD",
"value": 123
},
"startingPrice": {
"uom": "USD",
"value": 123
}
}
},
"accessorials": [
{
"size": {
"value": 123,
"units": "IN"
},
"type": "TARPING"
}
],
"freightModeDetails": {
"mode": "TRUCKLOAD",
"drayageSubtype": "IMPORT"
},
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
},
"id": "<string>"
}
],
"references": [
{
"type": "ORDER_REFERENCE",
"value": "<string>"
}
],
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>",
"responsibleUser": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
Show child attributes
Show child attributes
P, S 1, 2, 3, 4, 5, 6, 7, 8, 9, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.1, 2.2, 2.3, 4.1, 4.2, 4.3, 5.1, 5.2, 6.1, 6.2 Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES Show child attributes
Show child attributes
Typically one of the EquipmentType enum values but subject to change
BOX_TRUCK, CARGO_VAN, CONESTOGA, CONTAINER, DOUBLE_DROP, DRY_VAN, FLATBED, HOT_SHOT, LOW_BOY, POWER_ONLY, REEFER, REMOVABLE_GOOSENECK, SPRINTER_VAN, STEP_DECK, STRAIGHT_TRUCK, AUTO_CARRIER, VAN_OR_REEFER, FLATBED_OR_STEP_DECK, OTHER Show child attributes
Show child attributes
Typically one of the CustomerExternalIdentifierType enum values but subject to change
ALJEX, AVRL, BITFREIGHTER_RATING, CUSTOM, DAT, GENLOGS, GREENSCREENS, HIGHWAY, HOSTED_MCLEOD, LEGACY_MERCURYGATE, MCLEOD, MCLEOD_HOSTED, MERCURYGATE, ORDERFUL, SONAR, STEDI, STRATEGY_LIVE, TABI, TAI, TEST, THREE_PL, TRANSFIX_RATING, TURVO, TRUCKSTOP, VOOMA_PUBLIC_API, MICROSOFT, MICROSOFT_TEAMS, SLACK Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
PICKUP, DELIVERY Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
TARPING Show child attributes
Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
Show child attributes
Show child attributes
P, S 1, 2, 3, 4, 5, 6, 7, 8, 9, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.1, 2.2, 2.3, 4.1, 4.2, 4.3, 5.1, 5.2, 6.1, 6.2 Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES Show child attributes
Start date in YYYY-MM-DD format
Optional end date in YYYY-MM-DD format
Optional start time in HH:mm:ss format.
If timezone is provided the time must be in that timezone.
If timezone is not provided the time is assumed to be in UTC.
Optional end time in HH:mm:ss format
If timezone is provided the time must be in that timezone.
If timezone is not provided the time is assumed to be in UTC.
Optional timezone in tz database format e.g. "America/New_York" or "UTC".
FACILITY_HOURS, APPOINTMENT Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Construct a type with a set of properties K of type T
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typically one of the EquipmentType enum values but subject to change
BOX_TRUCK, CARGO_VAN, CONESTOGA, CONTAINER, DOUBLE_DROP, DRY_VAN, FLATBED, HOT_SHOT, LOW_BOY, POWER_ONLY, REEFER, REMOVABLE_GOOSENECK, SPRINTER_VAN, STEP_DECK, STRAIGHT_TRUCK, AUTO_CARRIER, VAN_OR_REEFER, FLATBED_OR_STEP_DECK, OTHER Show child attributes
Show child attributes
Show child attributes
Show child attributes
DRIVER, DISPATCH Show child attributes
Show child attributes
DRIVER, DISPATCH Show child attributes
Show child attributes
DRIVER, DISPATCH Show child attributes
Show child attributes
Typically one of the EquipmentType enum values but subject to change
BOX_TRUCK, CARGO_VAN, CONESTOGA, CONTAINER, DOUBLE_DROP, DRY_VAN, FLATBED, HOT_SHOT, LOW_BOY, POWER_ONLY, REEFER, REMOVABLE_GOOSENECK, SPRINTER_VAN, STEP_DECK, STRAIGHT_TRUCK, AUTO_CARRIER, VAN_OR_REEFER, FLATBED_OR_STEP_DECK, OTHER Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typically one of the LineItemType enum values but subject to change
FREIGHT_FLAT, FUEL_FLAT, OTHER Show child attributes
Show child attributes
Typically one of the LineItemType enum values but subject to change
FREIGHT_FLAT, FUEL_FLAT, OTHER PREPAID, COLLECT, THIRD_PARTY Show child attributes
Show child attributes
TARPING Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
Ok
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES Show child attributes
Show child attributes
Typically one of the EquipmentType enum values but subject to change
BOX_TRUCK, CARGO_VAN, CONESTOGA, CONTAINER, DOUBLE_DROP, DRY_VAN, FLATBED, HOT_SHOT, LOW_BOY, POWER_ONLY, REEFER, REMOVABLE_GOOSENECK, SPRINTER_VAN, STEP_DECK, STRAIGHT_TRUCK, AUTO_CARRIER, VAN_OR_REEFER, FLATBED_OR_STEP_DECK, OTHER Show child attributes
Show child attributes
Typically one of the CustomerExternalIdentifierType enum values but subject to change
ALJEX, AVRL, BITFREIGHTER_RATING, CUSTOM, DAT, GENLOGS, GREENSCREENS, HIGHWAY, HOSTED_MCLEOD, LEGACY_MERCURYGATE, MCLEOD, MCLEOD_HOSTED, MERCURYGATE, ORDERFUL, SONAR, STEDI, STRATEGY_LIVE, TABI, TAI, TEST, THREE_PL, TRANSFIX_RATING, TURVO, TRUCKSTOP, VOOMA_PUBLIC_API, MICROSOFT, MICROSOFT_TEAMS, SLACK Show child attributes
Show child attributes
Show child attributes
Show child attributes
PICKUP, DELIVERY Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
TARPING Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes
Show child attributes
Show child attributes
P, S 1, 2, 3, 4, 5, 6, 7, 8, 9, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.1, 2.2, 2.3, 4.1, 4.2, 4.3, 5.1, 5.2, 6.1, 6.2 Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES Show child attributes
Start date in YYYY-MM-DD format
Optional end date in YYYY-MM-DD format
Optional start time in HH:mm:ss format.
If timezone is provided the time must be in that timezone.
If timezone is not provided the time is assumed to be in UTC.
Optional end time in HH:mm:ss format
If timezone is provided the time must be in that timezone.
If timezone is not provided the time is assumed to be in UTC.
Optional timezone in tz database format e.g. "America/New_York" or "UTC".
FACILITY_HOURS, APPOINTMENT Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Construct a type with a set of properties K of type T
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typically one of the EquipmentType enum values but subject to change
BOX_TRUCK, CARGO_VAN, CONESTOGA, CONTAINER, DOUBLE_DROP, DRY_VAN, FLATBED, HOT_SHOT, LOW_BOY, POWER_ONLY, REEFER, REMOVABLE_GOOSENECK, SPRINTER_VAN, STEP_DECK, STRAIGHT_TRUCK, AUTO_CARRIER, VAN_OR_REEFER, FLATBED_OR_STEP_DECK, OTHER Show child attributes
Show child attributes
DRIVER, DISPATCH Show child attributes
Show child attributes
DRIVER, DISPATCH Show child attributes
Show child attributes
DRIVER, DISPATCH Show child attributes
Show child attributes
Typically one of the EquipmentType enum values but subject to change
BOX_TRUCK, CARGO_VAN, CONESTOGA, CONTAINER, DOUBLE_DROP, DRY_VAN, FLATBED, HOT_SHOT, LOW_BOY, POWER_ONLY, REEFER, REMOVABLE_GOOSENECK, SPRINTER_VAN, STEP_DECK, STRAIGHT_TRUCK, AUTO_CARRIER, VAN_OR_REEFER, FLATBED_OR_STEP_DECK, OTHER Show child attributes
Show child attributes
Show child attributes
Typically one of the LineItemType enum values but subject to change
FREIGHT_FLAT, FUEL_FLAT, OTHER Show child attributes
Show child attributes
Typically one of the LineItemType enum values but subject to change
FREIGHT_FLAT, FUEL_FLAT, OTHER PREPAID, COLLECT, THIRD_PARTY Show child attributes
Show child attributes
TARPING Show child attributes
Show child attributes
Typically one of the ReferenceType enum values but subject to change
ORDER_REFERENCE, PURCHASE_ORDER, BILL_OF_LADING, INVOICE, SHIPMENT, SALES_ORDER, TRACKING, DELIVERY, CUSTOMER_REFERENCE, LOAD, CONTAINER, MASTER_BILL_OF_LADING, BOOKING, SEAL, PICKUP, APPOINTMENT, OTHER Show child attributes