Laravel SDK (module) for Shiprocket API Version 1. The integration of Shiprocket API in your laravel application is made easy.
You can install the package via composer:
composer require meeeet-dev/laravel-shiprocketYou can publish config file with:
php artisan vendor:publish --provider="MeeeetDev\Shiprocket\ShiprocketServiceProvider" --tag="config"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', '[email protected]'),
'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',
];https://apidocs.shiprocket.in/?version=latest#8a56b4d6-b418-43cf-be25-ead62532aa18
use MeeeetDev\Shiprocket\Shiprocket;
.
.
.
$loginDetails = Shiprocket::login([
'email' => '[email protected]',
'password' => 'example'
])
// if you added credentials at shiprocket.php config file no need to pass credentialsOr
use MeeeetDev\Shiprocket\Shiprocket;
.
.
.
$token = Shiprocket::getToken();// if you added credentials at shiprocket.php confighttps://apidocs.shiprocket.in/?version=latest#d4f48023-b0b2-40af-8072-1adf97227d21
$token = Shiprocket::getToken();
$orderDetails = [
// refer above url for required parameters
'per_page'=>20,
];
$response = Shiprocket::order($token)->getOrders($orderDetails);https://apidocs.shiprocket.in/?version=latest#247e58f3-37f3-4dfb-a4bb-b8f6ab6d41ec
$orderDetails = [
// refer above url for required parameters
];
$token = Shiprocket::getToken();
$response = Shiprocket::order($token)->create($orderDetails);https://apidocs.shiprocket.in/?version=latest#45126d19-74ed-4cf5-9447-8ac1041bbb3c
$orderDetails = [
// refer above url for required parameters
];
$channelSpecificOrder = true;
$response = Shiprocket::order($token)->create($orderDetails,$channelSpecificOrder);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
https://apidocs.shiprocket.in/?version=latest#7bd788f4-63ba-49c3-889e-960a379d090f
$orderDetails = [
// refer aboce url for required parameters
];
$response = Shiprocket::order($token)->quickCreate($orderDetails);https://apidocs.shiprocket.in/?version=latest#5c0e41ca-d868-44c4-8ddb-73a8de239401
$ids = [12345,12346];
$response = Shiprocket::order($token)->cancel($ids);https://apidocs.shiprocket.in/?version=latest#4ba045ab-e25b-4bb1-adbd-37bbd07b354e
$orderDetails = [
'order_id' => [12345,123456 ]
'pickup_location' => 'location name'
];
$response = Shiprocket::order($token)->updatePickupLocation($orderDetails);Use these API's to assign AWB to your order, check for courier serviceability, and request for the pickup of your order. https://apidocs.shiprocket.in/?version=latest#a091dfc1-f882-466a-96a1-e245d3c80c5b
https://apidocs.shiprocket.in/?version=latest#b267ca9a-f7aa-4edc-8477-7dc15e46e08a
$data = [
'shipment_id' => '',
'courier_id' => ''
];
$response = Shiprocket::courier($token)->generateAWB($data);
// for more details visit above urlhttps://apidocs.shiprocket.in/?version=latest#29ff5116-0917-41ba-8c82-638412604916
$pincodeDetails = [
// for paramets refer obove url.
];
$response = Shiprocket::courier($token)->checkServiceability($pincodeDetails);https://apidocs.shiprocket.in/?version=latest#6d1f2fb0-43c1-434f-8c93-50674a0b59ef
$pincodeDetails = [
// for paramets refer obove url.
];
$response = Shiprocket::courier($token)->checkInterNationalServiceability($pincodeDetails);https://apidocs.shiprocket.in/?version=latest#9f42cdfd-a055-4934-a0f4-86764f87c80d
$pickupDetails = [
// for paramets refer obove url.
];
$response = Shiprocket::courier($token)->requestPickup($pickupDetails);https://apidocs.shiprocket.in/?version=latest#0f9a75fd-6d23-453c-a3d7-85857e8c8759
https://apidocs.shiprocket.in/?version=latest#a9913eaf-94ba-4012-a105-9687fddc7221
$filterParam = []; // you can use sort, sort_by, filter,filter_by
$shipments = Shiprocket::shipment($token)->get();https://apidocs.shiprocket.in/?version=latest#5f9bced5-4f16-4868-be55-a8c0215d0711
$shipemntId = 1232122;
$shipments = Shiprocket::shipment($token)->getSpecific($shipemntId);Use these API's to get the tracking details of your shipments through the AWB code or the Shipment ID. https://apidocs.shiprocket.in/?version=latest#62304450-5d27-4a28-929f-6c68d08040aa
https://apidocs.shiprocket.in/?version=latest#f2ac0962-4c34-4fe4-8266-50f8a1e8eab0
$awb = 1234444222;
$response = Shiprocket::track($token)->throughAwb($awb);https://apidocs.shiprocket.in/?version=latest#cf273e6a-08d0-4624-bf7a-7510c28292e0
$awbs = ["788830567028","788829354408"];
$response = Shiprocket::track($token)->throwMultipleAwb($awb);https://apidocs.shiprocket.in/?version=latest#89005f4f-2b2f-473d-95b0-f54665a16b42
$shipmentId = 123213;
$response = Shiprocket::track($token)->throwShipmentId($shipmentId);https://apidocs.shiprocket.in/?version=latest#bfcf3357-4e39-4134-831a-1ff33f67205e
$orderId = 123213;
$channelID = 121; //optional
$shipment = Shiprocket::track($token)->throwOrderId($orderId,$channelID);https://apidocs.shiprocket.in/?version=latest#6949d954-d0ba-4749-99aa-2435ab7aaf4f
https://apidocs.shiprocket.in/?version=latest#6fbe81f5-c3d5-462e-b18f-d6316dde7779
$newLocation = []; //Refer the above url for required parameteres
$location = Shiprocket::pickup($token)->addLocation($newLocation);https://apidocs.shiprocket.in/?version=latest#3bd67de6-8f00-435f-a708-c0c3ab252fee
$location = Shiprocket::pickup($token)->getLocations();https://apidocs.shiprocket.in/?version=latest#6233e207-6de3-4960-a59c-b34ebe3fe33d
https://apidocs.shiprocket.in/?version=latest#b9b9bcbe-923c-4ccd-a46e-d9f089622a80
$channels = Shiprocket::channel($token)->get();https://apidocs.shiprocket.in/?version=latest#a9f708ec-5861-43b9-a510-8c1bba074cb5
https://apidocs.shiprocket.in/?version=latest#dc281151-33e6-485f-a76a-015d8d36b49f
$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)
https://apidocs.shiprocket.in/?version=latest#dd1e168b-6bb2-45b9-a930-68cae3cbe97c
$orderIds = [ 'order_ids' => [121221,122112] ];
$response = Shiprocket::generate($token)->printManifest(orderIds);https://apidocs.shiprocket.in/?version=latest#4dfcbd78-4789-4680-82bf-9ff07f56d34e
$shipmentIds = [ 'shipment_id' => [121221,122112] ];
$response = Shiprocket::generate($token)->label(shipmentIds);https://apidocs.shiprocket.in/?version=latest#421f997f-1216-41e0-8c9b-433ddb666ad4
$orderIds = [ 'ids' => [121221,122112] ];
$response = Shiprocket::generate($token)->invoice(orderIds);https://apidocs.shiprocket.in/?version=latest#5046ae90-2014-4453-90d5-2ce776567f47
https://apidocs.shiprocket.in/?version=latest#0b8d1f26-3abd-4f4e-9cd8-3928bcfcf30b
$filterParam = []; // you can use sort, sort_by, filter,filter_by
$shipments = Shiprocket::product($token)->get();https://apidocs.shiprocket.in/?version=latest#134f7710-660c-464f-b579-6da46ba9402f
$productId = 1232122;
$shipments = Shiprocket::product($token)->getSpecific($productId);https://apidocs.shiprocket.in/?version=latest#344b789d-584e-486a-a7a9-0cf33ce52bf3
$productDetails = [
// refer above url for required parameters
];
$response = Shiprocket::product($token)->create($productDetails);
$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. $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 $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 $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']Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.