Ship with the Shiprocket API
Create orders, assign couriers, schedule pickups and track shipments from your own systems — the same capabilities as the Shiprocket panel, over HTTPS with JSON.
Getting Started
Welcome to Shiprocket's API Documentation. We've designed this document to help developers and Shiprocket users fully understand and integrate our API for a seamless and easy deployment. These APIs enable you to utilize most of your Shiprocket account's panel features fully.
We've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the Shiprocket APIs is by clicking the Run in Postman button above. The Postman is a free tool that helps developers run and debug API requests.
Typical flow
The base URL is https://apiv2.shiprocket.in/v1/external. Every call except POST /auth/login needs a bearer token in the Authorization header.
- Authenticate — POST your API user's email and password to
/auth/loginand keep the token. - Create an order — POST buyer details, items and dimensions to
/orders/create/adhoc. - Assign a courier — POST the returned
shipment_idto/courier/assign/awb. - Schedule pickup — POST to
/courier/generate/pickup. - Track — GET
/courier/track/awb/{awb_code}, or subscribe to the tracking webhook.