Submitting an Offer to Ship Cargo
The Submit Offer API allows for the submittal of a freight forwarder (carrier) offer to a shippers freight quote/rate request.
Warning: By submitting an offer to a freight rate request you will not be able to determine who made the request until the shipper has agreed to the selected rate. If selected, the contact details for the shipper will be provided so that you may finalize the transaction details.
Submit Quote/Rate Request Details
In order to accomplish this action, you will need to create a POST request. The following example shows how to submit an offer for a quote request.
//Submit Offer Example
curl -v -X POST 'https://lclxchange.com/api/quote/submitoffer' -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 quote |
||
offer | The total amount of the offer |
||
currencyIndex | The index of the currency this offer is made in (get from currency API) |
||
rates | (Optional) A list of itemized costs or fees that make up the offer |
||
terms | (Optional) The Terms & Conditions of the offer |
||
The URL of the API Services |
https://lclxchange.com/api/quote/submitoffer |
||
Query Parameters |
None |
||
HTTP Request Body |
A JSON formatted POST request. |