Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ocular.dev/llms.txt

Use this file to discover all available pages before exploring further.

Ocular connects to Shiprocket using two credentials — an API user email (created inside Shiprocket) and the API key that Shiprocket emails to that address.

What you need

A dedicated API-user email (different from your main Shiprocket login) and the API key emailed to it.

What it unlocks

The Fulfilment data model — AWB-level data, courier costs, RTO status, pincode performance, and cost-discrepancy reconciliation.
Shiprocket connector placeholder

​
Step 1 · Create an API user in Shiprocket

Open the seller panel

Log in to your Shiprocket seller panel.

Open API Users

Navigate to Settings → API Users.

Add new API User

Click Add new API User and fill in the required details (email, password, etc.).
Enter a unique email address that is different from the one used for your main Shiprocket login. Using the same email will cause the API user creation to fail.

Receive the API key

Click Create User. Shiprocket sends an API Key to the email address you entered. Copy it from that email.
Save the API key somewhere secure. If you lose it, you may need to create a new API user to generate a fresh one.

​
Step 2 · Plug the credentials into Ocular

Open the connector form

In Ocular, navigate to Data Management → Connectors → Add connector → Shiprocket.

Fill the fields

Connector Name

Free-form label.

Connector Identifier

Auto-generated.

Start Date

YYYY-MM-DD — how far back Ocular pulls Shiprocket data.

Lookback Days

Default 30. Increase for long RTO windows.

Schedule Frequency

Numeric value + unit (e.g., 4 hours).

Auto Sync

Toggle on to start sync immediately on create.

Email

The API user email from Step 1.

API Key

The key Shiprocket emailed to that user.

Create the connector

Click Create Connector. Ocular stores the credentials in its encrypted vault and triggers the first sync.

​
Troubleshooting

Almost always because the email you entered matches your main Shiprocket login. Use a unique address — e.g., ocular-api@your-domain.com.
Check spam and confirm the email address is correct. If the key still doesn’t arrive, regenerate by deleting and recreating the API user in Settings → API Users.
If you’ve created a new API user or rotated the key, update both Email and API Key in the connector form and re-test.
For ticket-writing format when filing a connector issue, see Working with the Ocular team → Connector-not-working tickets.