Connect Shiprocket

Link a Shiprocket API user so you can book, label, track and cancel Shiprocket parcels from your orders.

Where to find itDeliveryCouriersAdd courierShiprocket

Before you start

Shipping must be enabled for your shop, and you need a Shiprocket account with an API user and a pickup address. Turn on Courier shipping in Shop › Features. If you do not see it there, ask support.

Needs

Turn it on in Shop › Features (ask support if you do not see it)

Who can use this

Shop owner

Shiprocket is an Indian aggregator that books several couriers under one account. It supports everything in the courier comparison: live rates, pincode check, labels, cash on delivery, pickup booking, manifests, AWB retry, cancel, tracking, status webhooks, return pickup and COD payout sync.

Get these from Shiprocket first

The screens are Shiprocket's own; the form's help text names where to look.

An API user, created under Shiprocket's Settings › API. It has its own email and password. Your Shiprocket panel login does not work here.
A pickup address in Shiprocket's pickup addresses. Note its exact name and its pincode.
For testing only: Shiprocket's Sandbox gives separate API credentials for its test system.

Connect

The Add courier form for Shiprocket with the credential and pickup fields numbered

Open the form
Go to Delivery › Couriers, select Add courier and choose Shiprocket.

Fill the fields

#	Field	What to enter
	Name	Your own label for this account
1	API user email	The API user's email. Required
2	API user password	The API user's password. Required
3	Environment	Live or Sandbox (testing). Sandbox orders never reach a courier or your Shiprocket wallet
4	Pickup location name	Exactly as named in Shiprocket's pickup addresses. Required
5	Pickup pincode	The pincode of that address. Used to check which couriers reach a customer, and by the test
6	Customer email when none	Required. Shiprocket needs an email on every order; this one is used for customers who have none

Save
Set the Default package, active and default options as described in Couriers, then select Add courier.
Check the pickup location
On the saved account, Load from Shiprocket beside Pickup location name lists your Shiprocket pickup addresses. Pick one and select Save changes.
Test the connection
Select Test connection. A pass begins "Connected: Shiprocket" and "accepted the API user", and says whether couriers are available from your pickup pincode.

Set up the status webhook

On the saved account, find the Status webhook card. Copy Webhook URL. The address contains "rocket" rather than "shiprocket" on purpose: Shiprocket does not accept its own name in a webhook address.
Select Generate token and copy the Token at once. It is not shown again.
In Shiprocket's webhook settings (the card names Settings › API › Webhooks), paste the URL and the token. Shiprocket sends the token back as the x-api-key header.

Without the webhook, statuses are still checked every 30 minutes.

Troubleshooting

"Shiprocket rejected the API user login … Check the API user email and password (Shiprocket → Settings → API)." You entered the panel login, or the API user details are wrong. A rejected login is remembered for 15 minutes; saving new credentials or Test connection clears it.
"Warning: the pickup location "…" does not exist in Shiprocket (…)." The name does not match. Use Load from Shiprocket and pick one from the list.
"No courier serves pincode … — check the pickup pincode." Correct Pickup pincode.
"No pickup address is set up in Shiprocket yet." Add one in Shiprocket first.
Live credentials fail in Sandbox, or the reverse. Each environment has its own API user.

More in Troubleshooting. Booking is covered in Book a shipment.

Get these from Shiprocket first

The screens are Shiprocket's own; the form's help text names where to look.

An API user, created under Shiprocket's Settings › API. It has its own email and password. Your Shiprocket panel login does not work here.

A pickup address in Shiprocket's pickup addresses. Note its exact name and its pincode.

For testing only: Shiprocket's Sandbox gives separate API credentials for its test system.

Connect

Open the form

Go to Delivery › Couriers, select Add courier and choose Shiprocket.

Fill the fields

#	Field	What to enter
	Name	Your own label for this account
1	API user email	The API user's email. Required
2	API user password	The API user's password. Required
3	Environment	Live or Sandbox (testing). Sandbox orders never reach a courier or your Shiprocket wallet
4	Pickup location name	Exactly as named in Shiprocket's pickup addresses. Required
5	Pickup pincode	The pincode of that address. Used to check which couriers reach a customer, and by the test
6	Customer email when none	Required. Shiprocket needs an email on every order; this one is used for customers who have none

Save

Set the Default package, active and default options as described in Couriers, then select Add courier.

Check the pickup location

On the saved account, Load from Shiprocket beside Pickup location name lists your Shiprocket pickup addresses. Pick one and select Save changes.

Test the connection

Select Test connection. A pass begins "Connected: Shiprocket" and "accepted the API user", and says whether couriers are available from your pickup pincode.

Set up the status webhook

On the saved account, find the Status webhook card. Copy Webhook URL. The address contains "rocket" rather than "shiprocket" on purpose: Shiprocket does not accept its own name in a webhook address.

Select Generate token and copy the Token at once. It is not shown again.

In Shiprocket's webhook settings (the card names Settings › API › Webhooks), paste the URL and the token. Shiprocket sends the token back as the x-api-key header.

Without the webhook, statuses are still checked every 30 minutes.

Troubleshooting

"Shiprocket rejected the API user login … Check the API user email and password (Shiprocket → Settings → API)." You entered the panel login, or the API user details are wrong. A rejected login is remembered for 15 minutes; saving new credentials or Test connection clears it.

"Warning: the pickup location "…" does not exist in Shiprocket (…)." The name does not match. Use Load from Shiprocket and pick one from the list.

"No courier serves pincode … — check the pickup pincode." Correct Pickup pincode.

"No pickup address is set up in Shiprocket yet." Add one in Shiprocket first.

Live credentials fail in Sandbox, or the reverse. Each environment has its own API user.