ShippingQuote¶
Quotes a shipment without creating it. The prices depend on your agreement with Servientrega USA. To create the air waybill, use GenerateAWBData.
URL¶
POST https://ocelot.servientrega.us/api/KiwiService20/kwapi/ShippingQuote
POST https://ocelotkiwi.azurewebsites.net/api/KiwiService20/kwapi/ShippingQuote
Parameters¶
Send them as JSON (Content-Type: application/json).
| Name | Type | Required | Rules |
|---|---|---|---|
userId |
text | Yes | Your Kiwi username (the same one used to request the token) |
password |
text | Yes | Your Kiwi password. Case sensitive |
senderCity |
text | Yes | Sender's city. For shipments from outside the USA, use MIAMI |
senderState |
text | Yes | Sender's state. For shipments from outside the USA, use FL |
senderCountry |
text | Yes | Sender's country, ISO 2-letter code. For shipments from outside the USA, use US |
recipientCity |
text | Yes | Destination city name, as it appears in the list of destination cities, or its official code |
recipientState |
text | Conditional | State, province or department. Required when recipientCity is a name; optional with the official code |
destinationCountry |
text | Yes | Destination country, ISO 2-letter code: CO Colombia, EC Ecuador |
units |
number | No | Always 1 |
weight |
number | Yes | Weight in pounds (or kilograms, see unitWeight), up to 3 decimals |
unitWeight |
text | No | LB (default) or KG. With KG, weight is converted to pounds. The dimensions are always in inches |
declaredValue |
number | Yes | Declared value in USD, greater than 0, up to 2 decimals |
long |
number | No | Length in inches, up to 2 decimals |
wide |
number | No | Width in inches, up to 2 decimals |
high |
number | No | Height in inches, up to 2 decimals |
shippingType |
text | Yes | SPX, DOC, CTC or BFR. See Shipping types and tariff positions |
tariffPosition |
text | Yes | Tariff position. See Shipping types and tariff positions |
Note
Use a dot (.) as the decimal separator in every number.
Units differ from GenerateAWBData
ShippingQuote converts kilograms to pounds when unitWeight is KG;
GenerateAWBData does not. To get a quote that matches the air waybill, send the weight
in pounds (LB) in both methods.
Request example¶
curl -X POST "https://ocelot.servientrega.us/api/KiwiService20/kwapi/ShippingQuote" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d @quote.json
curl -X POST "https://ocelotkiwi.azurewebsites.net/api/KiwiService20/kwapi/ShippingQuote" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
-d @quote.json
quote.json:
{
"userId": "<YOUR_USERNAME>",
"password": "<YOUR_PASSWORD>",
"senderCity": "MIAMI",
"senderState": "FL",
"senderCountry": "US",
"recipientCity": "MEDELLIN",
"recipientState": "ANTIOQUIA",
"destinationCountry": "CO",
"units": 1,
"weight": 8.000,
"unitWeight": "LB",
"declaredValue": 100.00,
"long": 10.00,
"wide": 7.00,
"high": 2.00,
"shippingType": "SPX",
"tariffPosition": "98.07.20.00.00"
}
Response example¶
{
"result": true,
"entities": [
{
"freightValue": 13.90,
"overFreightValue": 0.00,
"taxValue": 0.00,
"valueOthers": 0.00,
"totalValue": 13.90,
"volumeInvoice": 0
}
],
"messages": [
"Liquidated AWB"
],
"notificationType": 3
}
| Field | Meaning |
|---|---|
freightValue |
Freight |
overFreightValue |
Additional freight |
taxValue |
Taxes |
valueOthers |
Other charges |
totalValue |
Total |
volumeInvoice |
Always 0 in this method |
Notes¶
- Check
notificationTypeandmessages: see Responses. - When a value is not valid, the response has
notificationType: 1and the reasons inmessages, for example"- City destination provided not found."or"- Declared value is required.". Several reasons can come together in the same message. - The quote does not create an air waybill and does not reserve the price.