Approve Carrier Offer API
The Approve Carrier Offer API allows you to select the best freight forwarders offer to ship your cargo. Once selected you will be provided the selected forwarders information. Likewise they will be provided your information to formalize the transaction.
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.
Approving an Offer Details
This section describes the API method for a shipper to accept or decline an offer.
Warning: You will not be able to determine who made the offer until you have agreed to the selected rate. Once an offer is selected, a representative from the selected forwarder will contact you to formalize the transaction.
// Example Request
curl -v -X POST 'https://lclxchange.com/api/quote/approveoffer' -H "Content-Type: application/json" -H "Authorization: Bearer <access_token>" -d
'{
"offerIndex": 21,
"approved": 1
}'
On a successful authentication and validated arguments, the result will look something like:
//Example Approval
{
"offers": {
"0": {
"index": 22,
"cargoname": "BS6yyEDq",
"status": "Available",
"origin": "Hong Kong",
"destination": "Los Angeles",
"needdate": "2019-02-07 00:00:00",
"notes": "A customer has a need to ship 194.1408 cbm of BS6yyEDq to Los Angeles. The requested arrival date for the cargo is 07 Feb 2019",
"qty": 18,
"packingtype": "Piece",
"measureUnit": "m",
"cargowidth": 2.14,
"cargoheight": 1.5,
"cargolength": 3.36,
"massUnit": "kg",
"weight": 297,
"offer": {
"offerIndex": "21",
"offerAmount": 145,
"currencyId": 52,
"status": "selected",
"loadingPOC": {
"name": "John Doe",
"email": "j.doe@lclxchange.com"
},
"loadingCompany": {
"name": "BLUESEA SHIPPING LINE, INC.",
"address1": "6103 OBISPO AVENUE",
"city": "LONG BEACH",
"state": "CA",
"postal": "90805",
"country": "UNITED STATES",
"fax": "(310) 324-4440",
"otilicense": "016232"
}
}
}
}
}
An error or invalid credentials will return:
{
"Unauthorized": "Access denied."
}
API REQUEST DETAILS
This section provides information about what is required to generate an offer API Request. These fields populate the JSON request.
| GET | POST | Component | Description |
|---|---|---|---|
| offerIndex | The index of the offer to respond to |
||
| approved | A true or false response. Use 1 for true, 0 for false |
||
| The URL of the API Services |
https://lclxchange.com/api/quote/approveoffer |
||
| Query Parameters |
None |
||
| HTTP Request Body |
A JSON formatted POST request. |