Rate Calculator
Use this API to get the shipping rate for one customer pincode and one seller or warehouse pincode, before you place a pickup order.
This API is for Prepaid clients. It returns a quote only. No amount is held from your wallet and no order is created.
What you send
| Field | Required | Notes |
|---|---|---|
origin_pincode | Yes | 6-digit customer pincode, where the item is picked up |
destination_pincode | Yes | 6-digit seller or warehouse pincode, where the item is delivered |
service | Yes | reverse or reverse_qc |
weight | No | Weight in kg. If you do not send it, the rate is priced at 1 kg |
Send reverse for a plain pickup. Send reverse_qc for a pickup with a quality check at the customer door.
Code
What you get back
Code
shipping_rate is the rate before GST. gst is returned on its own. Add the two to get the total. In the example above the total is 81.42 rupees.
Both amounts come back as strings with two decimal places.
If there is no rate for the pair
The API still returns HTTP 200. The rate fields are null.
Code
Check message, not the status code. Success means a rate was found.
Errors
| Status | Meaning | What to do |
|---|---|---|
| 400 | The request is not valid, for example a pincode that is not 6 digits | Fix the field named in message |
| 401 | The token is missing or not valid | Check your Authorization header. See Authentication |
| 503 | The rate service did not respond | Retry the request |
This is the same API used for forward deliveries. To price a delivery to a customer, see Rate Calculator in Forward Logistics, where service is forward.
See Get Rate for a Pincode Pair in the API Reference for the full schema.