Skip to main content
POST
/
quotes
/
search
cURL
curl --request POST \
  --url https://api.vooma.ai/v0/quotes/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFreightTags": [
    "<string>"
  ],
  "opportunityType": "CONFIRMED",
  "pagination": {
    "limit": 123,
    "after": "<string>",
    "before": "<string>",
    "last": 123,
    "first": 123
  },
  "auctionTypes": [
    "AUCTION"
  ],
  "freightModes": [
    "TRUCKLOAD"
  ],
  "equipmentTypes": [
    "BOX_TRUCK"
  ],
  "laneFilter": {
    "destination": {
      "radiusMiles": 123,
      "longitude": 123,
      "latitude": 123
    },
    "origin": {
      "radiusMiles": 123,
      "longitude": 123,
      "latitude": 123
    }
  },
  "dateFilter": {
    "end": "2023-11-07T05:31:56Z",
    "start": "2023-11-07T05:31:56Z"
  },
  "searchTerm": "<string>",
  "statuses": [
    "NEW"
  ],
  "customerIds": [
    "<string>"
  ]
}
'
{
  "quotes": [
    {
      "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
    }
  ],
  "pageInfo": {
    "endCursor": "<string>",
    "startCursor": "<string>",
    "hasPreviousPage": true,
    "hasNextPage": true
  },
  "totalCount": 123,
  "count": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
customFreightTags
string[]
opportunityType
enum<string>
Available options:
CONFIRMED,
UNCONFIRMED,
ALL
pagination
object
auctionTypes
enum<string>[]
Available options:
AUCTION,
NON_AUCTION
freightModes
enum<string>[]
Available options:
TRUCKLOAD,
LTL,
PARTIAL_TRUCKLOAD,
INTERMODAL,
DRAYAGE,
PARCEL
equipmentTypes
enum<string>[]
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
laneFilter
object
dateFilter
object
searchTerm
string
statuses
enum<string>[]
Available options:
NEW,
QUOTED,
WON,
LOST
customerIds
string[]

Response

200 - application/json

Ok

quotes
object[]
required
pageInfo
object
totalCount
number<double>
count
number<double>