Booking & couriers
GET
/v1/shipping/serviceableRate and serviceability
Which couriers will carry this lane and what each charges, cheapest decided by you. dropped_couriers is the honest half: every courier that was considered and excluded, with the reason — no_rate_card, cod_config_missing, reverse_not_supported and so on.
performance carries the delivered/RTO percentages and TAT for the lane where there is enough history; null where there is not. It is never invented.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| from_pinrequired | query | string | Pickup pincode. Must match ^\d{6}$. |
| to_pinrequired | query | string | Delivery pincode. Must match ^\d{6}$. |
| physical_weightrequired | query | number | Kilograms, greater than zero. |
| volumetric_weight | query | number | Kilograms. Defaults to 0. |
| order_type | query | string | "1" for COD, anything else prepaid. One of 0 · 1. |
| collectable_amount | query | number | COD amount to collect. |
| operation | query | string | Set reverse to price the return leg. One of reverse. |
Responses
| Status | Meaning |
|---|---|
| 200 | {data:[{logistic_id, courier_name, total, cod_charge, freight_charge, shipping_charge_tax, zone, weight, rto_charge, performance}], dropped_couriers:[{logistic_id, logistic_name, reason, detail}]}. |
400from_pin, to_pin and physical_weight are required | Any of the three is missing. |
422lane_not_priced | No courier on your rate card prices this lane. |
503rate_unavailable | The pricing engine is unreachable. Retry. |