Appearance
Shiprocket configuration
The current Shiprocket client accepts only Shiprocket credentials.
ts
new ShiprocketClient({
email: "your@email.com",
password: "yourpassword",
});The same options go to the recommended entry point, which selects Shiprocket with provider:
ts
new OpenLogistics({
provider: "shiprocket",
email: "your@email.com",
password: "yourpassword",
});What is configurable today
| Option | Type | Required | Notes |
|---|---|---|---|
email | string | yes | Shiprocket account email |
password | string | yes | Shiprocket account password |
- Authentication credentials
- Request payloads for each client method
- Pagination values for
listOrders(page, perPage)
The API base URL is fixed at https://apiv2.shiprocket.in/v1/external. Cached tokens are reused for roughly 10 days or until Shiprocket returns 401.
What is not configurable yet
- Global retry policy
- Per-provider configuration
- Fallback routing between providers (use
OpenLogisticsto pick one at construction instead) - Timeout settings
- Base URL overrides
Practical guidance
If you need those controls, they are gaps in the current implementation rather than hidden options.