Capacity Search

SecurityAPIKeyHeader
Request
path Parameters
loadboard_name
required
string (LoadboardType)

An enumeration.

Enum: "dat" "truckstop" "invalid_loadboard" "internal"
Request Body schema: application/json
required
earliest
string <date-time> (Earliest)

The start datetime of when the capacity is required

latest
string <date-time> (Latest)

The end datetime of when the capacity is required

required
object (Origin)

Origin address

required
object (Destination)

Destination address

required
Array of objects (Equipment)

Acceptable equipment types for this capacity request

age_limit_minutes
required
integer (Age Limit Minutes)

Search for assets that are no older than this number of minutes. The age of an asset is the time since it was created, or last updated, or last refreshed, whichever is latest.

mode
required
string (ModeEnum)

Mode of the requested capacity

Enum: "FTL" "LTL" "VLTL" "PARTIAL" "DRAYAGE" "INTERMODAL" "INVALID" "OTHER" "FINAL_MILE" "PARCEL"
origin_range_distance
string <decimal> (Origin Range Distance)

The radial distance in units of range_distance_units to return (e.g 100 miles of origin location)

origin_range_distance_units
required
string (DistanceUnitsEnum)

Units of origin range distance. Should be in units of KM or MILE

Enum: "MILE" "KM"
destination_range_distance
string <decimal> (Destination Range Distance)

The radial distance in units of range_distance_units to return (e.g 100 miles of destination)

destination_range_distance_units
required
string (DistanceUnitsEnum)

Units of destination_range_distance. Should be KM or MILE

Enum: "MILE" "KM"
Responses
200

Successful Response

Response Schema: application/json
query_id
string (Query Id)

The query id

required
Array of objects (Results)

Capacity search response from the source loadboard

400

Validation Error

post/loadboards/{loadboard_name}/capacity/search
Request samples
application/json
{
  • "earliest": "2019-08-24T14:15:22Z",
  • "latest": "2019-08-24T14:15:22Z",
  • "origin": {
    },
  • "destination": {
    },
  • "equipment": [
    ],
  • "age_limit_minutes": 0,
  • "mode": "FTL",
  • "origin_range_distance": "string",
  • "origin_range_distance_units": "MILE",
  • "destination_range_distance": "string",
  • "destination_range_distance_units": "MILE"
}
Response samples
application/json
{
  • "query_id": "string",
  • "results": [
    ]
}
Copyright © Shipwell 2024. All right reserved.