Laravel Shiprocket API

https://github.com/seshac/laravel-shiprocket-api
Admin
A Laravel SDK for the Shiprocket API (V1) that simplifies the integration of Shiprocket services...
Tokens:68,453
Snippets:558
Trust Score:8.1
Update:6 days ago
Show doc for...
Tokens:
Raw
### get() usage examples

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Shows how to fetch all products or apply filters using the get() method. The query string is built with http_build_query and omitted when $extraParam is null.

```php
// All products
$products = Shiprocket::product($token)->get();

// With filters
$products = Shiprocket::product($token)->get(['per_page' => 50, 'sort' => 'desc']);
```

--------------------------------

### quickCreate() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Example call to quickCreate with a partial order payload. Returns response of POST /v1/external/shipments/create/forward-shipment with status NEW/VERIFIED and shipment_id.

```php
$response = Shiprocket::order($token)->quickCreate([
    'order_id' => 'ORD-79201',
    'order_date' => '2020-08-20 11:00 PM',
    'billing_customer_name' => 'Jane Doe',
    // ... full payload per Shiprocket docs
]);
```

--------------------------------

### find() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Example call to find with an order id and echo of the order_id from the response. Returns response of GET /v1/external/orders/show/{id}.

```php
$response = Shiprocket::order($token)->find(16167171);
echo $response->get('data.order_id'); // Collection-based access (default responseType)
```

--------------------------------

### Install package via Composer

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Use this command to install the laravel-shiprocket-api package via Composer.

```bash
composer require seshac/laravel-shiprocket-api
```

--------------------------------

### create() usage examples (adhoc and channel-specific)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Two examples showing create() for custom (adhoc) order and channel-specific order. Endpoint selection is the only difference between modes.

```php
// Custom (adhoc) order
$response = Shiprocket::order($token)->create([
    'order_id' => 'ORD-1',
    'order_date' => '2020-08-20 11:00 PM',
    'payment_method' => 'Prepaid',
    // ...
]);
```

```php
// Channel-specific order
$response = Shiprocket::order($token)->create($orderDetails, true);
```

--------------------------------

### Get all products with Shiprocket::product()->get()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Fetches all products. The $filterParam array can include sort, sort_by, filter, and filter_by parameters.

```php
 $filterParam = [];  // you can use sort, sort_by, filter,filter_by
 $shipments = Shiprocket::product($token)->get();
```

--------------------------------

### throwMultipleAwb usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/08-tracking-resource.md

Example call to track multiple AWB codes using the Shiprocket facade.

```php
$response = Shiprocket::track($token)->throwMultipleAwb(["788830567028", "788829354408"]);
```

--------------------------------

### getOrders() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Example call to getOrders with per_page and sort parameters. Returns response of GET /v1/external/orders?{query}.

```php
$response = Shiprocket::order($token)->getOrders(['per_page' => 20, 'sort' => 'desc']);
```

--------------------------------

### checkServiceability usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/07-courier-resource.md

Example call to checkServiceability with pickup_postcode, delivery_postcode, cod, and weight. Returns response of GET /v1/external/courier/serviceability/?{query}.

```php
$response = Shiprocket::courier($token)->checkServiceability([
    'pickup_postcode' => 700001,
    'delivery_postcode' => 110001,
    'cod' => 0,
    'weight' => 0.5,
]);
```

--------------------------------

### create() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Creates a new product by passing an array with name, sku, price, weight, and other fields.

```php
$response = Shiprocket::product($token)->create([
    'name' => 'Baby Socks',
    'sku' => 'BABY-SOCKS-001',
    'price' => 199,
    'weight' => 0.15,
    // ...
]);
```

--------------------------------

### manifest() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/12-generate-resource.md

Example call to generate a manifest using Shiprocket::generate($token)->manifest() with shipment IDs.

```php
$response = Shiprocket::generate($token)->manifest(['shipment_id' => [121221, 122112]]);
```

--------------------------------

### invoice() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/12-generate-resource.md

Example call to generate an invoice using Shiprocket::generate($token)->invoice() with order IDs.

```php
$response = Shiprocket::generate($token)->invoice(['ids' => [121221, 122112]]);
```

--------------------------------

### get() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/11-channel-resource.md

Declares the get() method that takes no arguments and returns the response of GET /v1/external/channels.

```php
public function get()
```

--------------------------------

### printManifest() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/12-generate-resource.md

Example call to print a manifest using Shiprocket::generate($token)->printManifest() with order IDs.

```php
$response = Shiprocket::generate($token)->printManifest(['order_ids' => [121221, 122112]]);
```

--------------------------------

### Instantiate ShiprocketApi without facade

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Plain PHP example showing how to create a ShiprocketApi instance with a new ShiprocketClient.

```php
use Seshac\Shiprocket\ShiprocketApi;
use Seshac\Shiprocket\Clients\ShiprocketClient;

$api = new ShiprocketApi(new ShiprocketClient());
```

--------------------------------

### checkInterNationalServiceability usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/07-courier-resource.md

Example call to checkInterNationalServiceability with pickup_postcode, delivery_postcode, cod, weight, and country_code. Returns response of GET /v1/external/courier/international/serviceability/?{query}.

```php
$response = Shiprocket::courier($token)->checkInterNationalServiceability([
    'pickup_postcode' => '700001',
    'delivery_postcode' => '10001',
    'cod' => 0,
    'weight' => 1.2,
    'country_code' => 'US',
]);
```

--------------------------------

### Get Tracking Data for Multiple AWBS

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Fetch tracking details for multiple shipments at once by providing an array of AWB numbers. Note: the example uses a variable $awb (singular) but passes an array.

```php
$awbs = ["788830567028","788829354408"];
$response =  Shiprocket::track($token)->throwMultipleAwb($awb);
```

--------------------------------

### Usage example for checkServiceability

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/15-warehouse-resource.md

Example call to checkServiceability via Shiprocket::warehouse($token). The response is expected to have the shape ['serviceability' => true, 'etd' => '2020-12-06'].

```php
$response = Shiprocket::warehouse($token)->checkServiceability([
    'postcode' => 110030,
    'sku' => 'SKU name',
    'quantity' => 1,
]);

// expected shape: ['serviceability' => true, 'etd' => '2020-12-06']
```

--------------------------------

### requestPickup usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/07-courier-resource.md

Example call to requestPickup with shipment_id, pickup_location, pickup_date, and pickup_time. Returns response of POST /v1/external/courier/generate/pickup.

```php
$response = Shiprocket::courier($token)->requestPickup([
    'shipment_id' => ['2844411'],
    'pickup_location' => 'Banglore Warehouse',
    'pickup_date' => '2020-08-20',
    'pickup_time' => '10:00',
]);
```

--------------------------------

### getSpecific() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Fetches a single product by its ID using the getSpecific() method.

```php
$product = Shiprocket::product($token)->getSpecific('1232122');
```

--------------------------------

### login() usage examples

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Shows three usage patterns for `Shiprocket::login()`: with explicit credentials, with credentials from config, and error handling that catches `ShiprocketException` and prints the message.

```php
use Seshac\Shiprocket\Shiprocket;

// With explicit credentials
$loginDetails = Shiprocket::login([
    'email' => 'yourAPiMail@example.com',
    'password' => 'example',
]);

// Credentials from config/shiprocket.php
$loginDetails = Shiprocket::login();

// Error handling
use Seshac\Shiprocket\Exceptions\ShiprocketException;

try {
    Shiprocket::login(['email' => '', 'password' => '']);
} catch (ShiprocketException $e) {
    echo $e->getMessage(); // "Invalid Credentials"
}
```

--------------------------------

### getToken() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Shows how to obtain a token using `Shiprocket::getToken()` (credentials from config) and then use it in an order request.

```php
use Seshac\Shiprocket\Shiprocket;

$token = Shiprocket::getToken(); // credentials come from config

// then use everywhere:
$response = Shiprocket::order($token)->getOrders(['per_page' => 20]);
```

--------------------------------

### Get specific product details with Shiprocket::product()->getSpecific()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves details for a specific product by its ID. Replace $productId with the actual product ID.

```php
$productId = 1232122;
$shipments = Shiprocket::product($token)->getSpecific($productId);
```

--------------------------------

### label() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/12-generate-resource.md

Example call to generate a label using Shiprocket::generate($token)->label() with shipment IDs.

```php
$response = Shiprocket::generate($token)->label(['shipment_id' => [121221, 122112]]);
```

--------------------------------

### throwShipmentId usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/08-tracking-resource.md

Example call to track a shipment by its ID '2844411' using the Shiprocket facade.

```php
$response = Shiprocket::track($token)->throwShipmentId('2844411');
```

--------------------------------

### throwOrderId usage examples

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/08-tracking-resource.md

Examples of tracking by order ID with and without a channel ID. Note the implicit-nullable parameter may raise a Deprecated notice on PHP 8.1+.

```php
// With channel id
$response = Shiprocket::track($token)->throwOrderId(123213, 121);
```

```php
// Without channel id
$response = Shiprocket::track($token)->throwOrderId(123213);
```

--------------------------------

### cancel() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Example call to cancel with an ids array. Returns response of POST /v1/external/orders/cancel.

```php
$response = Shiprocket::order($token)->cancel(['ids' => [12345, 12346]]);
```

--------------------------------

### Get all NDR shipments with Shiprocket::ndr()->getShipments()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Fetches all shipments in NDR status. Corresponds to GET https://apiv2.shiprocket.in/v1/external/ndr/all.

```php
 $response = Shiprocket::ndr($this->token)->getShipments();
 
 // EX : GET : https://apiv2.shiprocket.in/v1/external/ndr/all where you can get all the shipments that are in NDR.
```

--------------------------------

### getLocations() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/10-pickup-resource.md

Example call to retrieve pickup locations and access the first pickup_location via data.shipping_address. Uses default 'collection' responseType.

```php
use Seshac\Shiprocket\Shiprocket;

$locations = Shiprocket::pickup($token)->getLocations();

// Typical access pattern (default 'collection' responseType)
$firstPickupLocation = $locations->pull('data.shipping_address.0.pickup_location');
```

--------------------------------

### GET /v1/external/products/show/{productId}

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Fetches a single product by its ID.

```APIDOC
## GET /v1/external/products/show/{productId}

### Description
Fetches a single product by its ID.

### Method
GET

### Endpoint
/v1/external/products/show/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - The product ID, e.g., `'1232122'`.

### Request Example
```php
$product = Shiprocket::product($token)->getSpecific('1232122');
```

### Response
#### Success Response (200)
- **mixed** - Response of the GET request.

#### Response Example
```json
{}
```
```

--------------------------------

### post usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/04-shiprocket-client.md

Shows how to send a POST request to create an adhoc order using a fluent chain.

```php
$client->setEndpoint('orders/create/adhoc')
       ->setHeaders($token)
       ->post($orderPayload);
```

--------------------------------

### updatePickupLocation() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Example call to updatePickupLocation with order_id array and pickup_location. Returns response of PATCH /v1/external/orders/address/pickup.

```php
$response = Shiprocket::order($token)->updatePickupLocation([
    'order_id' => [12345, 123456],
    'pickup_location' => 'Banglore Warehouse',
]);
```

--------------------------------

### Get login details with Shiprocket::login

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Authenticates with Shiprocket by passing email and password. If credentials are set in the config file, they can be omitted.

```php
use Seshac\Shiprocket\Shiprocket;
.
.
.

$loginDetails =  Shiprocket::login([
    'email' => 'yourAPiMail@example.com', 
    'password' => 'example'
])
// if you added credentials at shiprocket.php config file no need to pass credentials
```

--------------------------------

### GET /v1/external/products

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Lists all products. Supports optional query parameters for sorting, filtering, and pagination.

```APIDOC
## GET /v1/external/products

### Description
Lists all products. Supports optional query parameters for sorting, filtering, and pagination.

### Method
GET

### Endpoint
/v1/external/products

### Parameters
#### Query Parameters
- **$extraParam** (array) - Optional - Query parameters such as `sort`, `sort_by`, `filter`, `filter_by`, `per_page`.

### Request Example
```php
$products = Shiprocket::product($token)->get();

$products = Shiprocket::product($token)->get(['per_page' => 50, 'sort' => 'desc']);
```

### Response
#### Success Response (200)
- **mixed** - Response of the GET request.

#### Response Example
```json
{}
```
```

--------------------------------

### setEndpoint usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/04-shiprocket-client.md

Shows how to set endpoints with and without the 'warehouse' prefix, resulting in different base URLs.

```php
$client = new ShiprocketClient();

$client->setEndpoint('orders');                          // https://apiv2.shiprocket.in/v1/external/orders
$client->setEndpoint('warehouse/srf-serviceability/');   // https://apiv2.shiprocket.in/v1/warehouse/srf-serviceability/
```

--------------------------------

### Basic static call usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/01-shiprocket-facade.md

Shows how to use the Shiprocket facade for login, token retrieval, order fetching, and tracking via static calls.

```php
use Seshac\Shiprocket\Shiprocket;

// All of these are forwarded to the ShiprocketApi instance:
$loginDetails = Shiprocket::login([
    'email' => 'you@example.com',
    'password' => 'secret',
]);

$token = Shiprocket::getToken();

$orders = Shiprocket::order($token)->getOrders(['per_page' => 20]);

$tracking = Shiprocket::track($token)->throughAwb('788830567028');
```

--------------------------------

### addLocation() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/10-pickup-resource.md

Example call to add a pickup location with required payload fields. Uses Shiprocket::pickup($token)->addLocation().

```php
$response = Shiprocket::pickup($token)->addLocation([
    'pickup_location' => 'Banglore Warehouse',
    'name' => 'Jane Doe',
    'email' => 'jane@example.com',
    'phone' => '99530xxxxx',
    'address' => 'No 11, 2nd cross',
    'address_2' => 'Ashok Nagar',
    'city' => 'Bengaluru',
    'state' => 'Karnataka',
    'country' => 'India',
    'pin_code' => '560001',
]);
```

--------------------------------

### Get all integrated channels

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves details about all integrated channels using the Shiprocket API. Requires a valid token.

```php
$channels = Shiprocket::channel($token)->get();
```

--------------------------------

### getRequest method

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/05-resource.md

Performs a GET request to the given endpoint. Returns the response in the configured response type. Implementation: `$this->client->setEndpoint($endpoint)->setHeaders($this->token)->get();`

```php
public function getRequest(string $endpoint)
```

--------------------------------

### Error detection example for checkServiceability

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/15-warehouse-resource.md

Shows how to inspect the response for cURL errors or API-level error messages. No exceptions are thrown; check the returned value.

```php
use Seshac\Shiprocket\Shiprocket;

$result = Shiprocket::warehouse($token)->checkServiceability([
    'postcode' => 110030,
    'sku' => 'SKU name',
    'quantity' => 1,
]);

// default 'collection' responseType
if ($result->has('curl_error')) {
    abort(503, $result->get('curl_error'));
}

if ($result->has('message')) {
    // API-level error payload
    logger()->error($result->get('message'));
}
```

--------------------------------

### Get All Pickup Locations

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieve all pickup locations associated with the account. No parameters are required for this call.

```php
$location = Shiprocket::pickup($token)->getLocations();
```

--------------------------------

### Get token directly with Shiprocket::getToken

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves the authentication token directly. Requires credentials to be set in the shiprocket.php config file.

```php
use Seshac\Shiprocket\Shiprocket;
.
.
.

$token =  Shiprocket::getToken();//  if you added credentials at shiprocket.php config
```

--------------------------------

### Create quick order (Wrapper API)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

All-in-one API to create an order, ship it, add a new pickup location, and generate label and manifest. The $orderDetails array must include required parameters as per the API docs.

```php
$orderDetails = [
    // refer aboce url for required parameters 
];
$response =  Shiprocket::order($token)->quickCreate($orderDetails);
```

--------------------------------

### getSpecificShipment() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/14-ndr-resource.md

Calls getSpecificShipment() with an AWB code to get NDR information.

```php
$response = Shiprocket::ndr($token)->getSpecificShipment('0212331233322');
```

--------------------------------

### setHeaders usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/04-shiprocket-client.md

Shows how to set headers for login (no Authorization) and for authenticated requests (with Bearer token).

```php
$client->setHeaders('login');                    // Content-Type only
$client->setHeaders('eyJhbGciOi...');            // Content-Type + Authorization: Bearer eyJhbGciOi...
```

--------------------------------

### Get Specific Shipment Details

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves details for a specific shipment by its ID. The example uses a hardcoded shipment ID of 1232122.

```php
$shipemntId = 1232122;
$shipments = Shiprocket::shipment($token)->getSpecific($shipemntId);
```

--------------------------------

### Get specific Order

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves a single order by its ID. The example uses $orderId = 16167171; replace with the actual order ID.

```php
$token =  Shiprocket::getToken();
$orderId = 16167171;
$response =  Shiprocket::order($token)->find($orderId);
```

--------------------------------

### Changing config at runtime with config() helper

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/configuration.md

For tests or advanced usage. responseType must be set BEFORE constructing the client because it is read once at construction time.

```php
config(['shiprocket.credentials.email' => 'a@b.com']);
config(['shiprocket.credentials.password' => 'pw']);
config(['shiprocket.responseType' => 'array']); // must be set BEFORE constructing the client
```

--------------------------------

### getLocations() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/10-pickup-resource.md

Method signature for listing pickup locations. Takes no arguments. Returns response of GET /v1/external/settings/company/pickup.

```php
public function getLocations()
```

--------------------------------

### Shiprocket::order($token)->quickCreate($orderDetails)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Creates a quick order using a wrapper API that combines order creation, shipping, pickup location addition, and label/manifest generation in one call.

```APIDOC
## Shiprocket::order($token)->quickCreate($orderDetails)

### Description
Creates a quick order using a wrapper API that combines order creation, shipping, pickup location addition, and label/manifest generation in one call.

### Method
POST

### Endpoint
/orders/quick (as per Shiprocket API)

### Parameters
#### Request Body
- **orderDetails** (array) - Required - Order details (refer to Shiprocket API docs for required fields)

### Request Example
```php
$orderDetails = [
    // refer to Shiprocket API docs for required parameters
];
$response = Shiprocket::order($token)->quickCreate($orderDetails);
```

### Response
#### Success Response (200)
- **order_id** (integer) - ID of the created order
- **shipment_id** (integer) - ID of the shipment
- **label_url** (string) - URL to the generated label
- **manifest_url** (string) - URL to the generated manifest

#### Response Example
```json
{
  "order_id": 12345,
  "shipment_id": 67890,
  "label_url": "https://example.com/label.pdf",
  "manifest_url": "https://example.com/manifest.pdf"
}
```
```

--------------------------------

### GET /v1/external/products/show/{product_id}

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/endpoints.md

Retrieves a specific product by its ID. Requires Bearer token authentication.

```APIDOC
## GET /v1/external/products/show/{product_id}

### Description
Retrieves a specific product by its ID.

### Method
GET

### Endpoint
/v1/external/products/show/{product_id}

### Parameters
#### Path Parameters
- **product_id** (string) - Required - The product ID.

### Response
#### Success Response
No response body specified.
```

--------------------------------

### getSpecific() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Signature of the getSpecific() method. Requires a product ID and returns the response of GET /v1/external/products/show/{productId}.

```php
public function getSpecific(string $productId)
```

--------------------------------

### Add new product with Shiprocket::product()->create()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Creates a new product. The $productDetails array must contain required parameters as per the referenced API documentation.

```php
$productDetails = [
    // refer above url for required parameters
]; 
$response = Shiprocket::product($token)->create($productDetails);
```

--------------------------------

### Chaining through every resource

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Shows how to obtain a token and instantiate all resource wrappers. The token comes from `Shiprocket::getToken()` and is passed to each factory method. Sample calls demonstrate using the channel, warehouse, and NDR resources.

```php
use Seshac\Shiprocket\Shiprocket;

$token = Shiprocket::getToken();

$orders   = Shiprocket::order($token);
$pickups  = Shiprocket::pickup($token);
$couriers = Shiprocket::courier($token);
$track    = Shiprocket::track($token);
$channels = Shiprocket::channel($token);
$shipments = Shiprocket::shipment($token);
$generate  = Shiprocket::generate($token);
$products  = Shiprocket::product($token);
$warehouse = Shiprocket::warehouse($token);
$ndr       = Shiprocket::ndr($token);

// sample calls
$channels->get();
$warehouse->checkServiceability(['postcode' => 110030, 'sku' => 'SKU-1', 'quantity' => 1]);
$ndr->getShipments();
```

--------------------------------

### get() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/09-shipment-resource.md

Signature for the get() method that lists shipments. Accepts an optional array of query parameters (sort, sort_by, filter, filter_by). Returns the response of GET /v1/external/shipments.

```php
public function get(array $extraParam = null)
```

--------------------------------

### GET /v1/external/products

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/endpoints.md

Retrieves a list of products with optional pagination and filtering. Requires Bearer token authentication.

```APIDOC
## GET /v1/external/products

### Description
Retrieves a list of products with optional pagination and filtering.

### Method
GET

### Endpoint
/v1/external/products

### Parameters
#### Query Parameters
- **per_page** (int) - Optional - Pagination size.
- **any filter** (mixed) - Optional - Passed through `http_build_query`.

### Response
#### Success Response
No response body specified.
```

--------------------------------

### POST /v1/external/products

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Creates a new product with the provided details.

```APIDOC
## POST /v1/external/products

### Description
Creates a new product with the provided details.

### Method
POST

### Endpoint
/v1/external/products

### Parameters
#### Request Body
- **productDetails** (array) - Required - New product payload containing fields like `name`, `sku`, `price`, `weight`, etc.

### Request Example
```php
$response = Shiprocket::product($token)->create([
    'name' => 'Baby Socks',
    'sku' => 'BABY-SOCKS-001',
    'price' => 199,
    'weight' => 0.15,
    // ...
]);
```

### Response
#### Success Response (200)
- **mixed** - Response of the POST request.

#### Response Example
```json
{}
```
```

--------------------------------

### product

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Returns a typed resource wrapper for the products domain. This wrapper provides methods to interact with Shiprocket products.

```APIDOC
## product

### Description
Returns a typed resource wrapper for the products domain. This wrapper provides methods to interact with Shiprocket products.

### Method
product

### Parameters
- `$token` (string) - Required - Authentication token for API requests.

### Returns
Product resource wrapper (type not specified in source).
```

--------------------------------

### product(string $token)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Creates a new ProductResource instance using the shared client and the provided token. The token is used for authentication on all requests made by the resource.

```APIDOC
## product(string $token)

### Description
Creates a new ProductResource instance using the shared client and the provided token. The token is used for authentication on all requests made by the resource.

### Method
Factory method

### Parameters
- `$token` (string) - Required - The bearer token obtained from `getToken()` or the `token` field of `login()`.

### Return
ProductResource instance
```

--------------------------------

### Get all Orders

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Fetches a list of orders. The $orderDetails array can include parameters like 'per_page' as shown; refer to the linked Shiprocket API docs for required parameters.

```php
$token =  Shiprocket::getToken();
$orderDetails = [
        // refer above url for required parameters 
        'per_page'=>20,
    ];
    $response =  Shiprocket::order($token)->getOrders($orderDetails);
```

--------------------------------

### constructor

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Creates a new ShiprocketApi instance with the provided ShiprocketClient. The client is stored in the public property $client and is used for all HTTP requests.

```APIDOC
## Constructor

### Description
Creates a new ShiprocketApi instance with the provided ShiprocketClient. The client is stored in the public property $client and is used for all HTTP requests.

### Method
Constructor

### Parameters
- `$client` (Seshac\Shiprocket\Clients\ShiprocketClient) - Required - The HTTP client that performs all requests against the Shiprocket API.

### Example
```php
use Seshac\Shiprocket\ShiprocketApi;
use Seshac\Shiprocket\Clients\ShiprocketClient;

$api = new ShiprocketApi(new ShiprocketClient());
```
```

--------------------------------

### Print manifest (requires prior generation)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Prints the manifest for given order IDs. The manifest must be generated first using the 'Generate Manifest' API.

```php
$orderIds = [ 'order_ids' => [121221,122112] ];
$response = Shiprocket::generate($token)->printManifest(orderIds);
```

--------------------------------

### generateAWB usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/07-courier-resource.md

Example call to generateAWB with shipment_id and courier_id. Returns response of POST /v1/external/courier/assign/awb.

```php
$response = Shiprocket::courier($token)->generateAWB([
    'shipment_id' => '2844411',
    'courier_id' => '10',
]);
```

--------------------------------

### get()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/09-shipment-resource.md

Retrieves a list of shipments with optional filtering and sorting parameters. Returns the response of the GET /v1/external/shipments endpoint.

```APIDOC
## [GET] /v1/external/shipments

### Description
Retrieves a list of shipments. Optional query parameters allow filtering and sorting.

### Method
GET

### Endpoint
/v1/external/shipments

### Parameters
#### Query Parameters
- **sort** (string) - Optional - Sort order, e.g. 'desc'
- **sort_by** (string) - Optional - Field to sort by, e.g. 'created_at'
- **filter** (string) - Optional - Filter value, e.g. 'delivered'
- **filter_by** (string) - Optional - Field to filter by, e.g. 'status'

### Request Example
GET /v1/external/shipments?sort=desc&sort_by=created_at&filter=delivered&filter_by=status

### Response
#### Success Response (200)
- **data** (array) - List of shipments

#### Response Example
{
  "data": [
    {
      "shipment_id": "1232122"
    }
  ]
}
```

--------------------------------

### Fetching all shipments and with filters

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/09-shipment-resource.md

Shows how to retrieve all shipments with no parameters, and how to pass filter/sort parameters to the get() method. The query string is built with http_build_query and omitted when $extraParam is null or empty.

```php
// All shipments
$shipments = Shiprocket::shipment($token)->get();

// With filter/sort parameters
$shipments = Shiprocket::shipment($token)->get([
    'sort' => 'desc',
    'sort_by' => 'created_at',
    'filter' => 'delivered',
    'filter_by' => 'status',
]);
```

--------------------------------

### throughAwb usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/08-tracking-resource.md

Example call to track a single AWB code '788830567028' using the Shiprocket facade.

```php
$response = Shiprocket::track($token)->throughAwb('788830567028');
```

--------------------------------

### Resource factory method signatures

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Lists all factory methods on the Shiprocket class. Each returns a new resource wrapper instance constructed with the shared client and the given token. None of them throws; tokens are only validated by the remote API.

```php
public function order(string $token);      // → OrderResource
public function pickup(string $token);    // → PickupResource
public function courier(string $token);   // → CourierResource
public function track(string $token);     // → TrackingResource
public function channel(string $token);   // → ChannelResource
public function shipment(string $token); // → ShipmentResource
public function generate(string $token); // → GenerateResource
public function product(string $token);  // → ProductResource
public function warehouse(string $token);// → WarehouseResource
public function ndr(string $token);       // → NdrResource
```

--------------------------------

### create() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/13-product-resource.md

Signature of the create() method. Requires an array of product details and returns the response of POST /v1/external/products.

```php
public function create(array $productDetails)
```

--------------------------------

### quickCreate(array $order)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Creates a quick order using the Shiprocket wrapper API. This all-in-one method creates an order, ships it, adds a new pickup location, and generates label and manifest for the order.

```APIDOC
## quickCreate(array $order)

### Description
Creates a quick order using the Shiprocket wrapper API. This all-in-one method creates an order, ships it, adds a new pickup location, and generates label and manifest for the order.

### Method
POST

### Endpoint
/v1/external/shipments/create/forward-shipment

### Parameters
#### Request Body
- **$order** (array) - Required - Quick order payload (shipment + pickup + label + manifest data; see Shiprocket docs "Create quick order (Wrapper API)").

### Request Example
```php
$response = Shiprocket::order($token)->quickCreate([
    'order_id' => 'ORD-79201',
    'order_date' => '2020-08-20 11:00 PM',
    'billing_customer_name' => 'Jane Doe',
    // ... full payload per Shiprocket docs
]);
```

### Response
#### Success Response
- **mixed** - Response of POST /v1/external/shipments/create/forward-shipment. Status `NEW`/`VERIFIED`, includes `shipment_id`.
```

--------------------------------

### Get specific NDR shipment by AWB with Shiprocket::ndr()->getSpecificShipment()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves information for a specific AWB in NDR status. Corresponds to GET https://apiv2.shiprocket.in/v1/external/ndr/{AWB}.

```php
 $awb_code = '0212331233322';
 $response = Shiprocket::ndr($this->token)->getSpecificShipment($awb_code);
 
 // GET :  https://apiv2.shiprocket.in/v1/external/ndr/{AWB} Where you can information of specific AWB which is in NDR
```

--------------------------------

### Custom resource pattern: instantiate OrderResource directly

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/05-resource.md

Shows how to construct a concrete resource class directly in non-facade usage. Requires a ShiprocketClient instance and an API token. The resource methods return mixed types (Collection, stdClass, or array) depending on config('shiprocket.responseType').

```php
use Seshac\Shiprocket\Clients\ShiprocketClient;
use Seshac\Shiprocket\Resources\OrderResource;

$client = new ShiprocketClient();
$resource = new OrderResource($client, $apiToken);
```

--------------------------------

### create() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Signature for the create method. Accepts an array order and optional boolean channelSpecificOrder defaulting to false.

```php
public function create(array $order, bool $channelSpecificOrder = false)
```

--------------------------------

### quickCreate() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/06-order-resource.md

Signature for the quickCreate method. Accepts an array order payload and returns mixed.

```php
public function quickCreate(array $order)
```

--------------------------------

### Get all NDR shipments

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves all shipments that are in NDR (Non-Delivery Report) status.

```APIDOC
## [GET] /v1/external/ndr/all

### Description
Fetches all shipments that are currently in NDR status.

### Method
GET

### Endpoint
/v1/external/ndr/all

### Request Example
```php
$response = Shiprocket::ndr($this->token)->getShipments();
```

### Response
#### Success Response (200)
- **shipments** (array) - List of NDR shipments.

#### Response Example
```json
{
  "shipments": []
}
```
```

--------------------------------

### Constructor signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

The constructor accepts a ShiprocketClient instance and stores it in the public property $client. It does not validate the client.

```php
public function __construct(ShiprocketClient $client)
```

--------------------------------

### pickup(string $token)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Creates a new PickupResource instance using the shared client and the provided token. The token is used for authentication on all requests made by the resource.

```APIDOC
## pickup(string $token)

### Description
Creates a new PickupResource instance using the shared client and the provided token. The token is used for authentication on all requests made by the resource.

### Method
Factory method

### Parameters
- `$token` (string) - Required - The bearer token obtained from `getToken()` or the `token` field of `login()`.

### Return
PickupResource instance
```

--------------------------------

### getShipments() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/14-ndr-resource.md

Calls getShipments() to retrieve all shipments in NDR status.

```php
$response = Shiprocket::ndr($token)->getShipments();
```

--------------------------------

### login() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Method signature for `login()`. Accepts an optional `$credentials` array; when null, credentials are read from `config('shiprocket.credentials')`. Returns the `auth/login` response transformed by `responseType` (Collection by default). Throws `ShiprocketException("Invalid Credentials")` if credentials are invalid.

```php
public function login($credentials = null)
```

--------------------------------

### GET /v1/external/courier/international/serviceability/

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/endpoints.md

Checks courier serviceability for international shipments.

```APIDOC
## GET /v1/external/courier/international/serviceability/

### Description
Checks courier serviceability for international shipments.

### Method
GET

### Endpoint
/v1/external/courier/international/serviceability/

### Parameters
#### Query Parameters
- **pickup_postcode** (string) - Optional - Pickup postal code.
- **delivery_postcode** (string) - Optional - Delivery postal code.
- **cod** (boolean) - Optional - Cash on delivery flag.
- **weight** (number) - Optional - Shipment weight.
- **country_code** (string) - Optional - Country code.

### Response
#### Success Response (200)
- **data** (array) - List of serviceability options.

#### Response Example
{
  "data": []
}
```

--------------------------------

### GET /v1/external/shipments/{shipment_id}

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/endpoints.md

Retrieves a single shipment by its ID.

```APIDOC
## GET /v1/external/shipments/{shipment_id}

### Description
Retrieves a single shipment by its ID.

### Method
GET

### Endpoint
/v1/external/shipments/{shipment_id}

### Parameters
#### Path Parameters
- **shipment_id** (string) - Required - Shipment id.

### Response
#### Success Response (200)
- **shipment** (object) - Single shipment object.

#### Response Example
{
  "shipment": {}
}
```

--------------------------------

### Constructor method

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/04-shiprocket-client.md

Constructor that reads config('shiprocket.responseType') into the protected $responseType property. No network activity happens at construction time.

```php
public function __construct()
```

--------------------------------

### Get specific NDR shipment by AWB

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Fetches information for a specific NDR shipment using its AWB code.

```APIDOC
## [GET] /v1/external/ndr/{AWB}

### Description
Retrieves details of a specific NDR shipment identified by its AWB code.

### Method
GET

### Endpoint
/v1/external/ndr/{AWB}

### Parameters
#### Path Parameters
- **AWB** (string) - Required - The AWB code of the shipment.

### Request Example
```php
$awb_code = '0212331233322';
$response = Shiprocket::ndr($this->token)->getSpecificShipment($awb_code);
```

### Response
#### Success Response (200)
- **shipment** (object) - NDR shipment details.

#### Response Example
```json
{
  "shipment": {}
}
```
```

--------------------------------

### generate

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Returns a typed resource wrapper for the manifests/labels domain. This wrapper provides methods to generate manifests and labels.

```APIDOC
## generate

### Description
Returns a typed resource wrapper for the manifests/labels domain. This wrapper provides methods to generate manifests and labels.

### Method
generate

### Parameters
- `$token` (string) - Required - Authentication token for API requests.

### Returns
Manifest/label resource wrapper (type not specified in source).
```

--------------------------------

### login()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Authenticates with the Shiprocket API using provided credentials or those from configuration. Returns the full auth/login response transformed by the configured responseType.

```APIDOC
## login()

### Description
Authenticates with the Shiprocket API using provided credentials or those from configuration. Returns the full auth/login response transformed by the configured responseType.

### Method
login()

### Parameters
- **$credentials** (array) - Optional - Associative array with `email` and `password` keys. When null, credentials are read from `config('shiprocket.credentials')`.

### Return
- **mixed** - The full `auth/login` response transformed by the configured `responseType` (default: `Illuminate\Support\Collection`). The raw response includes `token` and `user` fields. Token is valid for 24 hours.

### Throws
- `Seshac\Shiprocket\Exceptions\ShiprocketException` - If `$credentials` is not an array or `email`/`password` is empty.

### Example
```php
use Seshac\Shiprocket\Shiprocket;

// With explicit credentials
$loginDetails = Shiprocket::login([
    'email' => 'yourAPiMail@example.com',
    'password' => 'example',
]);

// Credentials from config/shiprocket.php
$loginDetails = Shiprocket::login();

// Error handling
use Seshac\Shiprocket\Exceptions\ShiprocketException;

try {
    Shiprocket::login(['email' => '', 'password' => '']);
} catch (ShiprocketException $e) {
    echo $e->getMessage(); // "Invalid Credentials"
}
```
```

--------------------------------

### order(string $token)

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/02-shiprocket-api.md

Creates a new OrderResource instance using the shared client and the provided token. The token is used for authentication on all requests made by the resource.

```APIDOC
## order(string $token)

### Description
Creates a new OrderResource instance using the shared client and the provided token. The token is used for authentication on all requests made by the resource.

### Method
Factory method

### Parameters
- `$token` (string) - Required - The bearer token obtained from `getToken()` or the `token` field of `login()`.

### Return
OrderResource instance
```

--------------------------------

### Shiprocket::shipment($token)->get()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves all shipment details. Supports filtering and sorting via optional parameters.

```APIDOC
## Shiprocket::shipment($token)->get()

### Description
Retrieves all shipment details. Supports filtering and sorting via optional parameters.

### Method
GET

### Endpoint
Not specified in source

### Parameters
#### Query Parameters
- **sort** (string) - Optional - Sort order for the results.
- **sort_by** (string) - Optional - Field to sort by.
- **filter** (string) - Optional - Filter criteria.
- **filter_by** (string) - Optional - Field to filter by.

### Request Example
```php
$filterParam = [];  // you can use sort, sort_by, filter, filter_by
$shipments = Shiprocket::shipment($token)->get();
```

### Response
#### Success Response (200)
- **shipments** - The list of shipments.

#### Response Example
```json
{
  "shipments": "..."
}
```
```

--------------------------------

### reattempt() usage example

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/14-ndr-resource.md

Calls reattempt() with shipment details to open an NDR for action.

```php
$response = Shiprocket::ndr($token)->reattempt([
    'awb' => '190729394',
    'address_1' => 'Dr Nageshwar',
    'address2' => 'opposite Ashok Nagar',
    'phone' => '9534952626',
    'deferred_date' => '2020-08-27',
]);
```

--------------------------------

### boot() method signature

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/03-shiprocket-service-provider.md

Signature of the boot() method.

```php
public function boot()
```

--------------------------------

### checkInterNationalServiceability()

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/_autodocs/api-reference/07-courier-resource.md

Checks courier serviceability for international shipments. Returns the response of GET /v1/external/courier/international/serviceability/?{query}.

```APIDOC
## [GET] /v1/external/courier/international/serviceability/?{query}

### Description
Checks courier serviceability for international shipments. Returns the response of GET /v1/external/courier/international/serviceability/?{query}.

### Method
GET

### Endpoint
/v1/external/courier/international/serviceability/?{query}

### Parameters
#### Query Parameters
- **pickup_postcode** (string) - Required - Pickup postal code.
- **delivery_postcode** (string) - Required - Delivery postal code.
- **cod** (integer) - Required - COD flag (0 or 1).
- **weight** (number) - Required - Shipment weight in kg.
- **country_code** (string) - Required - ISO country code.

### Request Example
GET /v1/external/courier/international/serviceability/?pickup_postcode=700001&delivery_postcode=10001&cod=0&weight=1.2&country_code=US

### Response
#### Success Response (200)
- **rate** (number) - Courier rate.
- **cod** (boolean) - COD availability.
- **estimated_delivery_days** (integer) - Estimated delivery days.

#### Response Example
{
  "data": [
    {
      "rate": 200,
      "cod": false,
      "estimated_delivery_days": 7
    }
  ]
}
```

--------------------------------

### Get All Shipment Details

Source: https://github.com/seshac/laravel-shiprocket-api/blob/master/README.md

Retrieves all shipment details. The $filterParam array can include sort, sort_by, filter, and filter_by options.

```php
 $filterParam = [];  // you can use sort, sort_by, filter,filter_by
 $shipments = Shiprocket::shipment($token)->get();
```
Tokens:
Raw