README

Laravel integration for the Shiprocket PHP SDK (tims/shiprocket-php-sdk).

Why this package?

tims/shiprocket-php-sdk is the API client (PHP 8.0+). This package adds the Laravel layer around it:

Config and environment-based API user credentials (including multi-account)
JWT access-token caching via Laravel Cache (tokens last ~10 days)
HTTP retries for 429 and transient 5xx responses
Service-container bindings and a Shiprocket facade with resource shortcuts

Call the API with one-liners — no manual token plumbing:

Shiprocket::orders()->list(['page' => 1]);
Shiprocket::couriers()->serviceability([...]);
Shiprocket::withCredential('second')->warehouse()->srfServiceability([...]);

Requirements

PHP 8.3+
Laravel 10, 11, or 12
tims/shiprocket-php-sdk ^1.1

Installation

composer require tims/laravel-shiprocket

Publish the config:

php artisan vendor:publish --tag=shiprocket-config

Configuration

Add these to your .env:

SHIPROCKET_EMAIL=
SHIPROCKET_PASSWORD=

# Optional: named multi-account pair
# SHIPROCKET_DEFAULT_CREDENTIALS=default
# SHIPROCKET_SECOND_EMAIL=
# SHIPROCKET_SECOND_PASSWORD=

# Optional overrides
SHIPROCKET_BASE_URL=https://apiv2.shiprocket.in

# Token cache (enabled by default; JWTs last ~10 days)
SHIPROCKET_TOKEN_CACHE=true
SHIPROCKET_TOKEN_TTL=864000
SHIPROCKET_TOKEN_BUFFER=3600

# Retries for 429 / 5xx (enabled by default)
SHIPROCKET_RETRY_ENABLED=true
SHIPROCKET_RETRY_MAX_ATTEMPTS=3
SHIPROCKET_RETRY_BASE_DELAY_MS=500

SHIPROCKET_DEBUG=false
SHIPROCKET_HTTP_TIMEOUT=60

Create an API user in Shiprocket: Settings → API → Configure → Create an API User. Use that email/password (not your panel login).

Multi-account credentials

config/shiprocket.php:

'default_credentials' => env('SHIPROCKET_DEFAULT_CREDENTIALS', 'default'),

'credentials' => [
    'default' => [
        'email' => env('SHIPROCKET_EMAIL'),
        'password' => env('SHIPROCKET_PASSWORD'),
    ],
    'second' => [
        'email' => env('SHIPROCKET_SECOND_EMAIL'),
        'password' => env('SHIPROCKET_SECOND_PASSWORD'),
    ],
],

Shiprocket::withCredential('second')->orders()->list();

Each credential name gets its own token-cache namespace.

Usage

Facade shortcuts (recommended)

use Tims\LaravelShiprocket\Facades\Shiprocket;

$rates = Shiprocket::couriers()->serviceability([
    'pickup_postcode' => '110030',
    'delivery_postcode' => '122001',
    'weight' => 0.5,
    'cod' => 0,
]);

$orders = Shiprocket::orders()->list(['page' => 1]);

$srf = Shiprocket::warehouse()->srfServiceability([
    'postcode' => '110030',
    'sku' => 'SKU-1',
    'quantity' => 1,
]);

Type-hint the manager

use Tims\LaravelShiprocket\ShiprocketManager;

public function index(ShiprocketManager $shiprocket)
{
    return $shiprocket->orders()->list(['page' => 1]);
}

Explicit client / make

use Tims\Shiprocket\Api\OrdersApi;

$client = Shiprocket::client();
$api = Shiprocket::make(OrdersApi::class);
$token = Shiprocket::getToken();

SDK resource helpers (facade or $manager->…() / $manager->client()->…()):

auth, orders, couriers, shipments, pickup, products, inventory, listings, channels, account, ndr, imports, international, warehouse

See the tims/shiprocket-php-sdk README for full endpoint coverage.

Token cache

Tokens are cached under a key derived from the API user email and credential name. To force a fresh login:

use Tims\LaravelShiprocket\Facades\Shiprocket;

Shiprocket::forgetToken();
Shiprocket::withCredential('second')->forgetToken();

Webhooks

Shiprocket tracking webhooks are inbound POSTs to your app URL (configured in the Shiprocket panel). This package does not register webhook routes — add a controller/route in your application and optionally verify the x-api-key header. Use the PHP SDK client for outbound API calls; handle webhook payloads in your app.

License

MIT

tims / laravel-shiprocket

Maintainers

Package info

Statistics

Security