Authentication & AccessShiprocket App
Shiprocket API Credentials & Permissions Guide
Learn how to generate dedicated API credentials in your Shiprocket panel, configure mandatory access permissions, and securely connect your workspace.
1How to Generate API Credentials in Shiprocket
To allow Softymize to securely authenticate and sync your orders and shipment tracking status, you need to create an API User in your Shiprocket account:
- Log in to your Shiprocket Seller Dashboard (
app.shiprocket.in). - Navigate to Settings from the left sidebar and click on API Users.
- Click on the Add New API User button on the top right.
- Enter a dedicated email address for API integration (e.g.
[email protected]) and set a strong password. - Confirm the password and click Save API User.
Required Shiprocket API Permissions Matrix
Ensure the newly created API User has the following permissions enabled in Shiprocket:
| Permission Category | Required Access | Why Softymize Requires This |
|---|---|---|
| Orders API | Read & Write | To fetch customer details, order items, total pricing, and trigger Order Created flows. |
| Shipments & Tracking | Read Only | To obtain AWB tracking codes, courier partner names, ETD dates, and live status updates. |
| Webhooks API | Full Access | To transmit real-time shipment status callbacks directly to Softymize Webhook Listener. |
| Pickup Locations | Read Only | To populate registered pickup warehouse locations in your Softymize workspace. |
2Connecting Shiprocket in Softymize Workspace
Once your API User is created in Shiprocket, follow these steps to connect your workspace:
Automatic JWT Token Management
Softymize automatically authenticates with Shiprocket REST API endpoints and refreshes JWT access tokens every 9 days. You never have to manually update your password or token after initial connection.
- Go to your Softymize Dashboard > App Store > Shiprocket Integration.
- Enter your API Email and API Password created in Step 1.
- Select your preferred default Pickup Warehouse Location.
- Click Connect Account & Authenticate.