PHPackages                             meeeet-dev/laravel-shiprocket - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. meeeet-dev/laravel-shiprocket

ActiveLibrary[API Development](/categories/api)

meeeet-dev/laravel-shiprocket
=============================

Shiprocket API (V1) Laravel SDK. Integration of Shiprocket API in your laravel application is easy, This package enables you to utilize most of your Shiprocket functions.

v1.1(2y ago)1681MITPHPPHP ^7.3|^8.0

Since Aug 25Pushed 2y ago1 watchersCompare

[ Source](https://github.com/meeeet-dev/laravel-shiprocket)[ Packagist](https://packagist.org/packages/meeeet-dev/laravel-shiprocket)[ Docs](https://github.com/meeeet-dev/laravel-shiprocket)[ RSS](/packages/meeeet-dev-laravel-shiprocket/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (3)Used By (0)

Shiprocket API (V1) Laravel SDK
===============================

[](#shiprocket-api-v1-laravel-sdk)

Laravel SDK (module) for [Shiprocket API Version 1](https://apidocs.shiprocket.in/?version=latest#intro). The integration of Shiprocket API in your laravel application is made easy.
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

[](#laravel-sdk-module-for-shiprocket-api-version-1-the-integration-of-shiprocket-api-in-your-laravel-application-is-made-easy)

[![Latest Version on Packagist](https://camo.githubusercontent.com/05a0ef1cdaec35123d2dc29cd4dc83558c653698e89a8ad98f51d3ed585cba47/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d65656565742d6465762f6c61726176656c2d73686970726f636b65742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/meeeet-dev/laravel-shiprocket)[![Psalm](https://github.com/meeeet-dev/laravel-shiprocket/workflows/Psalm/badge.svg?branch=master)](https://github.com/meeeet-dev/laravel-shiprocket/workflows/Psalm/badge.svg?branch=master)[![Total Downloads](https://camo.githubusercontent.com/f59f44fd69ce635320ecfe4c91bf2961734ff3f852e1e41eb0239cd46b555dfa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d65656565742d6465762f6c61726176656c2d73686970726f636b65742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/meeeet-dev/laravel-shiprocket)[![Tests](https://github.com/meeeet-dev/laravel-shiprocket/workflows/Tests/badge.svg?branch=master)](https://github.com/meeeet-dev/laravel-shiprocket/workflows/Tests/badge.svg?branch=master)

Index
-----

[](#index)

1. [Installation](https://github.com/meeeet-dev/laravel-shiprocket#installation)
2. [Usage](https://github.com/meeeet-dev/laravel-shiprocket#installation)
    1. [Authentication](https://github.com/meeeet-dev/laravel-shiprocket#Authentication)
    2. [Orders](https://github.com/meeeet-dev/laravel-shiprocket#Orders)
    3. [Couriers](https://github.com/meeeet-dev/laravel-shiprocket#Couriers)
    4. [Tracking](https://github.com/meeeet-dev/laravel-shiprocket#Tracking)
    5. [Shipments](https://github.com/meeeet-dev/laravel-shiprocket#Shipments)
    6. [Pickup Addresses](https://github.com/meeeet-dev/laravel-shiprocket#Pickup-Addresses)
    7. [Channels](https://github.com/meeeet-dev/laravel-shiprocket#Channels)
    8. [Manifest/Generate-Labels/Print-Invoice](https://github.com/meeeet-dev/laravel-shiprocket#Generate)
    9. [Products](https://github.com/meeeet-dev/laravel-shiprocket#Products)
    10. [Warehouse](https://github.com/meeeet-dev/laravel-shiprocket#Warehouse)
3. [Contributors](https://github.com/meeeet-dev/laravel-shiprocket#contributors)

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require meeeet-dev/laravel-shiprocket
```

You can publish config file with:

```
php artisan vendor:publish --provider="MeeeetDev\Shiprocket\ShiprocketServiceProvider" --tag="config"
```

This is the contents of the published config file:
--------------------------------------------------

[](#this-is-the-contents-of-the-published-config-file)

```
return [
    /*
    |--------------------------------------------------------------------------
    | Default Shiprocket Credentilas
    |--------------------------------------------------------------------------
    |
    | Here you can set the default shiprocket credentilas. However, you can pass the credentials while connecting to shiprocket client
    |
    */

    'credentials' => [
        'email' => env('SHIPROCKET_EMAIL', 'example@email.com'),
        'password' => env('SHIPROCKET_PASSWORD', 'password'),
    ],

   /*
    |--------------------------------------------------------------------------
    | Default output response type
    |--------------------------------------------------------------------------
    |
    | Here you may specify which of the output response you need.
    |
    | Supported: "collection" , "object", "array"
    |
    */

    'responseType' => 'collection',
];
```

Authentication
--------------

[](#authentication)

```
https://apidocs.shiprocket.in/?version=latest#8a56b4d6-b418-43cf-be25-ead62532aa18

```

##### Get the login details

[](#get-the-login-details)

```
use MeeeetDev\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
```

Or

##### Get the Token directly

[](#get-the-token-directly)

```
use MeeeetDev\Shiprocket\Shiprocket;
.
.
.

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

Orders
------

[](#orders)

#### get all Orders

[](#get-all-orders)

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

#### Create Custom Order

[](#create-custom-order)

```
$orderDetails = [
    // refer above url for required parameters
];
$token =  Shiprocket::getToken();
$response =  Shiprocket::order($token)->create($orderDetails);
```

#### Create Channel Specific Order

[](#create-channel-specific-order)

```
$orderDetails = [
    // refer above url for required parameters
];

$channelSpecificOrder = true;

$response =  Shiprocket::order($token)->create($orderDetails,$channelSpecificOrder);
```

#### Create quick order ( Wrapper API )

[](#create-quick-order--wrapper-api-)

This is an all in one API to create an order, ship the order, add a new pickup location and generate label along with the manifest for the same. Create, Ship and Generate Label and Manifest for Order

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

#### Cancel an order

[](#cancel-an-order)

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

### Update pickup location

[](#update-pickup-location)

```
$orderDetails = [
   'order_id' => [12345,123456 ]
   'pickup_location' => 'location name'
];
$response =  Shiprocket::order($token)->updatePickupLocation($orderDetails);
```

Couriers
--------

[](#couriers)

Use these API's to assign AWB to your order, check for courier serviceability, and request for the pickup of your order.

#### Generate AWB for Shipment

[](#generate-awb-for-shipment)

```
$data = [
    'shipment_id' => '',
    'courier_id' => ''
];
$response =  Shiprocket::courier($token)->generateAWB($data);
// for more details visit above url
```

#### Check Courier Serviceability

[](#check-courier-serviceability)

```
$pincodeDetails = [
    // for paramets refer obove url.
];
$response =  Shiprocket::courier($token)->checkServiceability($pincodeDetails);
```

#### Check International Courier Serviceability

[](#check-international-courier-serviceability)

```
$pincodeDetails = [
    // for paramets refer obove url.
];
$response =  Shiprocket::courier($token)->checkInterNationalServiceability($pincodeDetails);
```

#### Request for Shipments Pickup

[](#request-for-shipments-pickup)

```
$pickupDetails = [
    // for paramets refer obove url.
];
$response =  Shiprocket::courier($token)->requestPickup($pickupDetails);
```

Shipments
---------

[](#shipments)

#### Get the all shipment details

[](#get-the-all-shipment-details)

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

#### Get the details of a specific Shipment

[](#get-the-details-of-a-specific-shipment)

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

Tracking
--------

[](#tracking)

Use these API's to get the tracking details of your shipments through the AWB code or the Shipment ID.

#### Get Tracking through AWB

[](#get-tracking-through-awb)

```
$awb = 1234444222;
$response =  Shiprocket::track($token)->throughAwb($awb);
```

#### Get Tracking Data for Multiple AWBS

[](#get-tracking-data-for-multiple-awbs)

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

#### Get Tracking through Shipment ID

[](#get-tracking-through-shipment-id)

```
$shipmentId = 123213;
$response =  Shiprocket::track($token)->throwShipmentId($shipmentId);
```

#### Get Tracking Data through Order iD

[](#get-tracking-data-through-order-id)

```
$orderId = 123213;
$channelID = 121; //optional
$shipment =  Shiprocket::track($token)->throwOrderId($orderId,$channelID);
```

Pickup-Addresses
----------------

[](#pickup-addresses)

#### Add a New Pickup Location

[](#add-a-new-pickup-location)

```
$newLocation = []; //Refer the above url for required parameteres
$location = Shiprocket::pickup($token)->addLocation($newLocation);
```

#### Get All Pickup Locations

[](#get-all-pickup-locations)

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

Channels
--------

[](#channels)

#### To get details about all the integrated channels

[](#to-get-details-about-all-the-integrated-channels)

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

Manifest/Generate-Labels/Print-Invoice
--------------------------------------

[](#manifestgenerate-labelsprint-invoice)

#### Generate the manifest of orders using shipment Id's

[](#generate-the-manifest-of-orders-using-shipment-ids)

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

#### Print the Manifest (Mnaifest needs to be generated first in order for this API to print it. Use the 'Generate Manifest' API to do the same)

[](#print-the-manifest-mnaifest-needs-to-be-generated-first-in-order-for-this-api-to-print-it-use-the-generate-manifest-api-to-do-the-same)

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

#### Generate the label of an order by passing the shipment id in the form of an array

[](#generate-the-label-of-an-order-by-passing-the-shipment-id-in-the-form-of-an-array)

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

#### Generate the invoice for you're order.

[](#generate-the-invoice-for-youre-order)

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

Products
--------

[](#products)

#### Get the all products

[](#get-the-all-products)

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

#### Get the details of a specific Product

[](#get-the-details-of-a-specific-product)

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

#### Add New Products

[](#add-new-products)

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

NDR Shipments
-------------

[](#ndr-shipments)

#### Where you can get all the shipments that's are in NDR status

[](#where-you-can-get-all-the-shipments-thats-are-in-ndr-status)

```

 $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.
```

#### Where you can information of specific AWB which is in NDR

[](#where-you-can-information-of-specific-awb-which-is-in-ndr)

```
 $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
```

#### For open NDR where you can take action such as Reattempt, RTO :

[](#for-open-ndr-where-you-can-take-action-such-as-reattempt-rto-)

```
 $shipmentDetails = ['awb' => '', 'address_1' => '', 'address2' => '', 'phone' => ''];
 $response = Shiprocket::ndr($this->token)->reattempt($shipmentDetails);

 // POST : https://apiv2.shiprocket.in/v1/external/ndr/reattempt?awb=190729394&address1=Dr Nageshwar&address2=opposite Ashok Nagar&phone=9534952626&deferred_date=2020-08-27
```

Warehouse
---------

[](#warehouse)

#### Check Warehouse SRF serviceabbility

[](#check-warehouse-srf-serviceabbility)

```
 $filterParam = [
    'postcode' => 110030, // Delivery Post Code
    'sku' => "SKU name",
    'quantity' => 1, //Quantity in numbers
 ];
 $response = Shiprocket::warehouse($this->token)->checkServiceability($filterParam);

 // EX : https://apiv2.shiprocket.in/v1/warehouse/srf-serviceability?postcode=784001&sku=Baby-socket&quantity=1
 // Response :  ['serviceability'=>true,'etd'=>'2020-12-06']
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [Meeeet Dev](https://github.com/meeeet-dev)
- [All Contributors](../../contributors)

Please feel free to contact me if you find any bug or create an issue for that!.
--------------------------------------------------------------------------------

[](#please-feel-free-to-contact-me-if-you-find-any-bug-or-create-an-issue-for-that)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE) for more information.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 83.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~215 days

Total

2

Last Release

773d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/fa29d2bdcb1a0b4203cc47ddd55ff9aec404ec0a6b680961c1c02e193c26f356?d=identicon)[meeeet-dev](/maintainers/meeeet-dev)

---

Top Contributors

[![Meetbhana9567](https://avatars.githubusercontent.com/u/46040270?v=4)](https://github.com/Meetbhana9567 "Meetbhana9567 (5 commits)")[![meeeet-dev](https://avatars.githubusercontent.com/u/123059891?v=4)](https://github.com/meeeet-dev "meeeet-dev (1 commits)")

---

Tags

laravel Shiprcoket ApiLaravel Shiprocket WrapperShiprocket SDK Modulemeeeet dev

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/meeeet-dev-laravel-shiprocket/health.svg)

```
[![Health](https://phpackages.com/badges/meeeet-dev-laravel-shiprocket/health.svg)](https://phpackages.com/packages/meeeet-dev-laravel-shiprocket)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M475](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M270](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M452](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)