Scribd
Upload
16 views

Shiproken API call and usage guide

Frequently used Shiprocket API calls and usage guide

Uploaded by

Tejaswi Bhargava
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
16 views

Shiproken API call and usage guide

Frequently used Shiprocket API calls and usage guide

Uploaded by

Tejaswi Bhargava
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 3

Create a token - valid for 240 hours.

https://apidocs.shiprocket.in/#c148860e-26ab-4737-a8be-23589f681b03

1. Create a customer order?

Post: https://apiv2.shiprocket.in/v1/external/orders/create/adhoc
● Pickup location to be taken from the saved address. (of shiprocket account owner)
● Be sure to input the correct calculated sub_total amount. The total is not calculated
automatically through the API.
● The order_id received in response must be saved to be used in other API calls.

Params: https://apidocs.shiprocket.in/#247e58f3-37f3-4dfb-a4bb-b8f6ab6d41ec

2. Update Customer's Delivery address after order creation?

POST: https://apiv2.shiprocket.in/v1/external/orders/address/update
● Updates Customer Delivery Address and name through this API by passing the
Shiprocket order id and the necessary customer details.
● This request does not return any response body
● For example -
● in previous call the order ID was ->
"order_id": 705944082,

● Previous Name & Address:


"billing_customer_name": "Naruto",
"billing_last_name": "Uzumaki",
"billing_address": "House 221B, Leaf Village",
"billing_address_2": "Near Hokage House",
"billing_city": "New Delhi",
"billing_pincode": "110002",
"billing_state": "Delhi",
"billing_country": "India",
"billing_email": "[email protected]",
"billing_phone": "9876543210",

Lets change it to :

{
"order_id": 705944082,
"shipping_customer_name": "Shailesh",
"shipping_phone": "9988998899",
"shipping_address": "lalghati",
"shipping_address_2": "",
"shipping_city": "Bhopal",
"shipping_state": "M.P",
"shipping_country": "India",
"shipping_pincode": 462023
}

3. Check Delivery availability at Pincode location?

GET: https://apiv2.shiprocket.in/v1/external/courier/serviceability/

● To check the availability of couriers between the pickup and delivery postal codes.
● Details like the estimated time of delivery, the rates along with the ids are also shown
Required Parameters:

{
"pickup_postcode": [
"The pickup postcode field is required when order id is not present."
],
"delivery_postcode": [
"The delivery postcode field is required when order id is not present."
],
"weight": [
"The weight field is required when order id is not present."
],
"cod": [
"The cod field is required when order id is not present."
],
"order_id": [
"The order id field is required when pickup postcode / delivery postcode / cod / weight is not present."
]
},

4. Price Calculation:
The total is not calculated automatically through the API.

You might also like