Capacity Search Retrieve

SecurityAPIKeyHeader

Request

path Parameters

loadboard_name required	string (LoadboardType) An enumeration. Enum: "dat" "truckstop" "invalid_loadboard" "internal"
query_id required	string (Query Id)

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

get/loadboards/{loadboard_name}/capacity/search/{query_id}

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

application/json

{"query_id": "string",
"results": [{"loadboard_search_request_id": "string",
"equipment": [{"equipment_type": "DRY_VAN",
"gross_weight": {"unit": "KG",
"value": "string"
},
"temperature": {"unit": "C",
"minimum": "string",
"maximum": "string"
},
"dimensions": {"unit": "CM",
"length": "string",
"height": "string",
"width": "string"
}
}
],
"age_minutes": 0,
"available_at": "2019-08-24T14:15:22Z",
"capacity_created_at": "2019-08-24T14:15:22Z",
"mode": "FTL",
"origin": {"country": "st",
"line_1": "515 Congress Ave",
"line_2": "Suite 2650",
"line_3": "line 3",
"locality": "string",
"postal_code": "string",
"region": "str",
"urbanization": "string",
"residential": false,
"geolocation": {"latitude": "string",
"longitude": "string"
}
},
"origin_distance": "string",
"origin_distance_units": "MILE",
"destination": {"country": "st",
"line_1": "515 Congress Ave",
"line_2": "Suite 2650",
"line_3": "line 3",
"locality": "string",
"postal_code": "string",
"region": "str",
"urbanization": "string",
"residential": false,
"geolocation": {"latitude": "string",
"longitude": "string"
}
},
"destination_distance": "string",
"destination_distance_units": "MILE",
"contact": {"contact_type": "ACCOUNT_REP",
"company_name": "string",
"person_name": "string",
"email": "string",
"phone": "string",
"fax": "string",
"website": "string"
},
"rate": {"value": "string",
"currency_code": "USD"
},
"rate_unit": "string",
"minimum_distance": "string",
"minimum_distance_units": "MILE",
"quantity": 0,
"usdot_number": 0,
"mc_number": 0
}
]
}