GET /v1/external/courier/serviceability/
Use this API to check the availability of couriers between the pickup and delivery postal codes.
Further details like the estimated time of delivery, the rates along with the ids are also shown.
Note:
- One of either the 'order_id' or 'cod' and 'weight' is required. If you specify the order id, the cod and weight fields are not required and vice versa.
- You can add further fields to add the shipment details and filter the search.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
pickup_postcode | YES | integer | Postcode from where the order will be picked. | 110030 |
delivery_postcode | YES | integer | Postcode where the order will be delivered | 122002 |
order_id | NO | integer | If order id is already created in Shiprocket panel then you can use this shiprocket order id in servicibility | 123456 |
cod | CONDITIONAL YES | boolean | 1 for Cash on Delivery and 0 for Prepaid orders. | 1 |
weight | CONDITIONAL YES | string | The weight of shipment in kgs. | 2 |
length | NO | integer | The length of the shipment in cms. | 15 |
breadth | NO | integer | The breadth of the shipment in cms. | 10 |
height | NO | integer | The height of the shipment in cms. | 5 |
declared_value | NO | integer | The price of the order shipment in rupees. | 50 |
mode | NO | string | The mode of travel. Either: Surface or Air | Air |
is_return | NO | integer | Whether the order is a return order or not. 1 in case of Yes and 0 for No. (declared_value field is required in case you use this parameter) | 0 |
couriers_type | NO | integer | Use this to filter out and show only "documents" couriers like XB documents, etc. The only accepted value is 1. | 1 |
only_local | NO | integer | Use this to filter out and show only Hyperlocal couriers. The only accepted value is 1. | 1 |
qc_check | CONDITIONAL YES | integer | Use this filter to show only the QC-enabled couriers. is_return has to be set to 1 | 1 |
Servers
- https://apiv2.shiprocket.in
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.