Freight Bidding API
This section describes the API method to obtain the list of your freight offers and the current status of the offer. Additionally, this API also allows you to make an offer to ship the cargo made under the freight request.
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 rate requests and your offer for that freight.
// Example Request
curl -v -X GET 'https://lclxchange.com/api/quote/bid' -H "Content-Type: application/json" -H "Authorization: Bearer <access_token>"
On a successful authentication the result will look something like:
//Example Result
{
"bids": {
"0": {
"index": 5,
"cargoname": "Wine",
"refId": "HBMN7U4JU8",
"status": "Selected",
"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,
"packingtype": "Pallet",
"measureUnit": "m",
"cargowidth": 2,
"cargoheight": 3,
"cargolength": 1,
"massUnit": "kg",
"weight": 100,
"loadingPOC": {
"name": "Jane Doe",
"email": "jane.doe@anymailserver.com"
},
"loadingCompany": {
"name": "Freight and Loading Inc.",
"address1": "80 WASHINGTON STREET",
"city": "New York",
"state": "NY",
"postal": "00005",
"country": "UNITED STATES",
"fax": "(123) 123-1500",
"otilicense": "001234"
},
"price": 2000,
"currencyIndex": 776
}
}
}
Submitting an Offer to Ship Cargo
The freight bidding API allows for the submittal of an offer to a freight rate request. To accomplish this action, you will need to create a POST request. The following example shows how to submit an offer to a freight rate request.
Warning: By submitting an offer to a freight rate request for a quote you will not be able to determine who made the request until you have agreed to the selected rate. If selected, the contact details for the requestor will be provided so that you may finalize the transaction details.
//Example Rate Publish
curl -v -X POST 'https://lclxchange.com/api/quote/request' -H "Content-Type: application/json" -H "Authorization: Bearer <access_token>" -d
'{
"requestIndex" : 6,
"offer" : 10,
"currencyId" : 52,
"rates" : {
"Chassis Fee": 10.12,
"Ocean Freight": 195
},
"terms": "Rate Validity:\nRate validity is indicated in this tariff.\nAll rates and surcharges are subject to change without prior notice.",
}'
On a successful authentication and validated arguments, the result will look something like:
//Example Result
{
"bid": {
"index": 6,
"cargoname": "Toys",
"refId": "VK9JUDEZ7X",
"status": "Available",
"origin": "Hong Kong",
"destination": "Los Angeles",
"needdate": "2019-02-16 00:00:00",
"notes": "A customer has a need to ship 4.400682 cbm of Toys to Los Angeles. The requested arrival date for the cargo is 16 Feb 2019",
"qty": 2,
"packingtype": "Piece",
"measureUnit": "m",
"cargowidth": 4.29,
"cargoheight": 0.23,
"cargolength": 2.23,
"massUnit": "kg",
"weight": 341,
"offer": {
"index": "11",
"offerAmount": 10,
"currencyIndex": 52,
"status": "pending",
"terms": "Rate Validity:\nRate validity is indicated in this tariff.\nAll rates and surcharges are subject to change without prior notice.",
"rates": {
"Chassis Fee": 10.12,
"Ocean Freight": 195
}
}
}
}
An error or invalid credentials will return:
{
"Unauthorized": "Access denied."
}
API REQUEST DETAILS
This section provides information about what is required to generate a bid API Request. These fields populate the JSON request.
| GET | POST | Component | Description |
|---|---|---|---|
| requestIndex | The index of the request |
||
| offer | The total amount of the offer |
||
| currencyIndex | The index of the currency this offer is made in |
||
| rates | (Optional) A list of itemized costs or fees that make up the offer |
||
| terms | (Optional) The Terms & Conditions of the offer |
||
| offset | The page offset starting at 0 |
||
| rowsperpage | The number of results to return per page, this value must be included with offset |
||
| type | The type of results to return use: active, nsel - not selected, sel - selected, offers |
||
| The URL of the API Services |
https://lclxchange.com/api/quote/bid |
||
| Query Parameters |
None |
||
| HTTP Request Body |
A JSON formatted GET or POST request. |