Get Quote Request List API
This section describes the API method to obtain the list of available requests for transportation and warehousing rates. Once the shipping quote/rate request has been submitted, the request will be sent to our list of authorized forwarders where they may respond with a competitive offer.
Note: The sample requests contained in this document are for reference only. You will not be able to run the examples as is. Please construct your requests based on your authorization token and data requests with your own data values.
Generating the Request
As an example, the following request will return the list of current and available rate requests from third parties. This list contains the requests that are available for a freight forwarder to make a competitive offer.
// Example Get Requests
curl -v -X POST 'https://lclxchange.com/api/quote/getrequests' -H "Content-Type: application/json" -H "Authorization: Bearer <access_token>" -d '{ "type" : "all" }'
On a successful authentication the resulting array will look something like:
//Example Results
{
"raterequests": {
"0": {
"index": 4,
"commodityname": "Car Parts",
"refId": "C58MW1TTOC",
"requesttype": "Trucking",
"status": "Available",
"origin": "Penang",
"destination": "Hamburg",
"needdate": "2018-12-12 00:00:00",
"notes": "A customer has a need to ship 90cbm of Car Parts to Hamburg. The requested arrival date for the cargo is 12 Dec 2018",
"qty": 100,
"packaging": "Carton",
"measureUnit": "m",
"width": 1.5,
"height": 3,
"length": 0.2,
"massUnit": "kg",
"weight": 26580,
"hazardous": 0
},
"1": {
"index": 3,
"commodityname": "Wine",
"refId": "DUEFEH1SUO",
"requesttype": "Shipping",
"status": "Available",
"origin": "New York",
"destination": "Hamburg",
"needdate": "2018-12-20 00:00:00",
"notes": "A customer has a need to ship 72cbm of Wine to Hamburg. The requested arrival date for the cargo is 20 Dec 2018",
"qty": 12,
"packaging": "Pallet",
"measureUnit": "m",
"width": 2,
"height": 3,
"length": 1,
"massUnit": "kg",
"weight": 100,
"hazardous": 0
}
}
}
As another example, the request specifying an index will return one request result.
// Example Request
curl -v -X POST 'https://lclxchange.com/api/quote/getrequests' -H "Content-Type: application/json" -H "Authorization: Bearer <access_token>" -d
'{
"index" : "<index_value>"
}'
On a successful authentication and submission the result will look something like:
//Example Result
{
"raterequests": {
"0": {
"index": 3,
"commodityname": "Wine",
"refId": "6GFI42S7WV",
"requesttype": "Shipping",
"status": "Available",
"origin": "New York",
"destination": "Hamburg",
"needdate": "2018-12-20 00:00:00",
"notes": "A customer has a need to ship 72cbm of Wine to Hamburg. The requested arrival date for the cargo is 20 Dec 2018",
"qty": 12,
"packaging": "Pallet",
"measureUnit": "m",
"width": 2,
"height": 3,
"length": 1,
"massUnit": "kg",
"weight": 100,
"incoterm": EXW,
"hazardous": 0
}
}
}
Get Request Details
This section provides information about what is required to generate a rate request using the API. These fields populate the JSON request.
| GET | POST | Component | Description |
|---|---|---|---|
| index | The index of the target request |
||
| offset | The page offset starting at 0 |
||
| rowsperpage | The number of results to return per page (default 10), this value must be included with offset |
||
| secondsSinceUpdate | The number of seconds since last update. Default 1 hour (3600 seconds, max 432000 seconds) |
||
| type | The type of results to return use keyword (all, accept, pending):
all(default) - show all results |
||
| The URL of the API Services |
https://lclxchange.com/api/quote/getrequests |
||
| Query Parameters |
None |
||
| HTTP Request Body |
A JSON formatted POST request. |