Get Available Loads

GET https://api.freightvana.io/loadboard/availableLoads

This GET endpoint returns FreightVana's available loads.

Basic Auth is required to access this endpoint. Client will need to user their registered phone number as their username, and their valid MC number as their password. A registered phone number would be any phone number that has an existing relationship with FreightVana (added as a contact in our CRM).

Accepts parameters for pagination, and filtering.

The endpoint returns an object with totalDocuments, count, and documents. The totalDocuments key refers to the total number of active loads. The count key refers to the number of results returned by the clients query. The documents array will contain objects for all of the available loads matching the client's query.

Request Params

KeyDatatypeRequiredDescription
limitstringRequired
pagestringRequired
sortstringOptional
directionstringOptional
stopCountstringOptional
powerOnlystringOptional
originEarlyPickDatestringOptional
originLatePickDatestringOptional
destEarlyDeliveryDatestringOptional
destLateDeliveryDatestringOptional
originCitySTstringOptional
destCitySTstringOptional
maxDiststringOptional
originCoords[]stringOptional
originCoords[]string^ see above definition for explanation. The reason for 2 "originCoords[]" keys is strictly because that is how one can pass an array in params.
destCoords[]stringOptional
destCoords[]string^ see above definition for explanation. The reason for 2 "destCoords[]" keys is strictly because that is how one can pass an array in params.

HEADERS

KeyDatatypeRequiredDescription
``null

RESPONSES

status: OK

{"totalDocuments":144,"count":1,"documents":[{"_id":"642741ca74ecf9aa9494c6b3","orderID":"59726","commodity":"BUILDING MATERIAL","destCity":"PLANT CITY","destCityST":"PLANT CITY, FL","destEarlyDeliveryDate":"2023-04-09T09:00:00.000Z","destEventType":"Live","destKMA":"FL_LAK","destLateDeliveryDate":"2023-04-09T09:00:00.000Z","destLocation":{"type":"Point","coordinates":[-82.14,28.01]},"destRegion":"RSE2","destST":"FL","destZIP":"33566","destZone":"ZSE","destination":"PLANT CITY, FL 33566","emptyReturn":false,"equipment":"V","lengthOfHaul":704,"loadRequirements":null,"origin":"FRANKLIN, TN 37064","originCity":"FRANKLIN","originCityST":"FRANKLIN, TN","originEarlyPickDate":"2023-04-07T07:00:00.000Z","originEventType":"Live","originKMA":"TN_NAS","originLatePickDate":"2023-04-07T07:00:00.000Z","originLocation":{"type":"Point","coordinates":[-86.84,35.92]},"originRegion":"RSE3","originST":"TN","originZIP":"37064","originZone":"ZSE","poEquipment":null,"powerOnly":false,"shortDestEarlyDeliveryDate":"04/09 16:00","shortDestLateDeliveryDate":"04/09 16:00","shortOriginEarlyPickDate":"04/07 14:00","shortOriginLatePickDate":"04/07 14:00","stopCount":2}]}