API Documentation
Movements
Customers
Carriers
Locations
Appointments
cURL
Copy
Ask AI
curl --request GET \
--url https://api.vooma.ai/v0/quotes/{quoteId} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"quote": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "NEW",
"freightOrder": {
"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
}
],
"equipment": {
"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>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<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",
"notes": "<string>",
"dateTimeRange": {
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>",
"type": "FACILITY_HOURS"
}
}
],
"mileage": {
"uom": "MI",
"value": 123
}
},
"freightModeDetails": {
"mode": "TRUCKLOAD",
"drayageSubtype": "IMPORT"
},
"totalWeight": {
"units": "LB",
"value": 123
}
},
"additionalUsers": [
{
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
],
"tags": {
"isAuction": true
},
"automation": {
"requestedByUser": true,
"identifiedByVooma": true
},
"carrierRate": {
"id": "<string>",
"method": "CUSTOM",
"amount": {
"uom": "USD",
"value": 123
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"components": [
{
"amount": {
"uom": "USD",
"value": 123
},
"type": "LINE_HAUL",
"description": "<string>"
}
]
},
"customerRate": {
"id": "<string>",
"method": "CUSTOM",
"amount": {
"uom": "USD",
"value": 123
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"components": [
{
"amount": {
"uom": "USD",
"value": 123
},
"type": "LINE_HAUL",
"description": "<string>"
}
]
},
"user": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
},
"requestedByEmail": "<string>",
"customFreightTags": [
"<string>"
],
"responseTimeSeconds": 123
}
}Quotes
Get Quote
GET
/
quotes
/
{quoteId}
cURL
Copy
Ask AI
curl --request GET \
--url https://api.vooma.ai/v0/quotes/{quoteId} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"quote": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "NEW",
"freightOrder": {
"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
}
],
"equipment": {
"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>"
}
],
"id": "<string>",
"contacts": [
{
"carrierId": "<string>",
"customerId": "<string>",
"email": "<string>",
"phone": "<string>",
"name": "<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",
"notes": "<string>",
"dateTimeRange": {
"startDate": "<string>",
"endDate": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"timezone": "<string>",
"type": "FACILITY_HOURS"
}
}
],
"mileage": {
"uom": "MI",
"value": 123
}
},
"freightModeDetails": {
"mode": "TRUCKLOAD",
"drayageSubtype": "IMPORT"
},
"totalWeight": {
"units": "LB",
"value": 123
}
},
"additionalUsers": [
{
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
}
],
"tags": {
"isAuction": true
},
"automation": {
"requestedByUser": true,
"identifiedByVooma": true
},
"carrierRate": {
"id": "<string>",
"method": "CUSTOM",
"amount": {
"uom": "USD",
"value": 123
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"components": [
{
"amount": {
"uom": "USD",
"value": 123
},
"type": "LINE_HAUL",
"description": "<string>"
}
]
},
"customerRate": {
"id": "<string>",
"method": "CUSTOM",
"amount": {
"uom": "USD",
"value": 123
},
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"components": [
{
"amount": {
"uom": "USD",
"value": 123
},
"type": "LINE_HAUL",
"description": "<string>"
}
]
},
"user": {
"externalIds": [
{
"type": "CUSTOM",
"value": "<string>"
}
],
"id": "<string>"
},
"requestedByEmail": "<string>",
"customFreightTags": [
"<string>"
],
"responseTimeSeconds": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
200 - application/json
Ok
Show child attributes
Show child attributes
Available options:
NEW, QUOTED, WON, LOST Show child attributes
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
Available options:
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
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
Available options:
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 Available options:
BAGS, BALES, BOTTLES, BOXES, BUNDLES, CARTONS, CASES, CRATES, DRUMS, PACKAGES, PAILS, PALLETS, PIECES, ROLLS, SKIDS, TRUCKLOADS, TUBES, UNITS, VEHICLES Available options:
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
Available options:
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
Typically one of the CustomerExternalIdentifierType enum values but subject to change
Available options:
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
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
PICKUP, DELIVERY Show child attributes
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".
Available options:
FACILITY_HOURS, APPOINTMENT Includes users who may have been cc'd or who owned matching quotes deduplicated by Vooma
Show child attributes
Show child attributes
Show child attributes
Show child attributes
True if the quote was requested by a user; it may have been requested after being identified by Vooma
True if Vooma's AI identified the opportunity, whether it was identified prior to user request or after
Show child attributes
Show child attributes
Typically one of the RatingMethod enum values but subject to change
Available options:
CUSTOM, DAT, GREENSCREENS, BITFREIGHTER, TRANSFIX, MANUAL, DIRECT_OFFER Show child attributes
Show child attributes
Available options:
LINE_HAUL, FUEL_SURCHARGE, MANUAL_ADJUSTMENT, MARGIN, TMS_ADJUSTMENT, MESSAGE_ADJUSTMENT, TOTAL, OTHER Show child attributes
Show child attributes
Typically one of the RatingMethod enum values but subject to change
Available options:
CUSTOM, DAT, GREENSCREENS, BITFREIGHTER, TRANSFIX, MANUAL, DIRECT_OFFER Show child attributes
Show child attributes
Available options:
LINE_HAUL, FUEL_SURCHARGE, MANUAL_ADJUSTMENT, MARGIN, TMS_ADJUSTMENT, MESSAGE_ADJUSTMENT, TOTAL, OTHER Show child attributes
Show child attributes
Time in seconds between when the quote request was received and when first email response was sent from the user
⌘I