PHPackages                             nimbuspost/nimbuspost - 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. nimbuspost/nimbuspost

ActiveLibrary[API Development](/categories/api)

nimbuspost/nimbuspost
=====================

Nimbus Post apis package

v0.0.1(2y ago)09MITPHPPHP ^7.3|^8.0

Since Nov 29Pushed 2y ago1 watchersCompare

[ Source](https://github.com/tech-nimbuspost/nimbuspost-api)[ Packagist](https://packagist.org/packages/nimbuspost/nimbuspost)[ Docs](https://github.com/tech-nimbuspost/nimbuspost-api)[ RSS](/packages/nimbuspost-nimbuspost/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

NimbusPost API (V1) PHP SDK
===========================

[](#nimbuspost-api-v1-php-sdk)

Index
-----

[](#index)

1. [Installation](https://github.com/tech-nimbuspost/nimbuspost-api#installation)
2. [Usage](https://github.com/tech-nimbuspost/nimbuspost-api#installation)
    1. [Authentication](https://github.com/tech-nimbuspost/nimbuspost-api#Authentication)
    2. [Couriers](https://github.com/tech-nimbuspost/nimbuspost-api#Couriers)
    3. [NDR](https://github.com/tech-nimbuspost/nimbuspost-api#NDR)
    4. [Tracking](https://github.com/tech-nimbuspost/nimbuspost-api#Tracking)
    5. [Orders](https://github.com/tech-nimbuspost/nimbuspost-api#Orders)
    6. [Shipments](https://github.com/tech-nimbuspost/nimbuspost-api#Shipments)
    7. [Manifest](https://github.com/tech-nimbuspost/nimbuspost-api#Manifest)
    8. [Warehouse](https://github.com/tech-nimbuspost/nimbuspost-api#Warehouse)
3. [Contributors](https://github.com/tech-nimbuspost/nimbuspost-api#contributors)

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

[](#installation)

You can install the package via composer:

```
composer require nimbuspost/nimbuspost
```

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

[](#authentication)

##### Get the login details

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

```
use Nimbuspackage\Nimbuspost\NimbuspostApi;

$config=[
    'key'=>'07faa9dxxxxxxxxxxxxxxxxxxxe1c1',
    'email'=>'xxxxx',
    'password'=>'xxxxxxx'
];

$object=new NimbuspostApi($config);
$object->setResponseType('array') // default object
```

Couriers
--------

[](#couriers)

#### get list of available couriers

[](#get-list-of-available-couriers)

```
$object=new NimbuspostApi($config);
$response=$object->getCouriers();
```

#### Get the list of all available pincode with serviceability

[](#get-the-list-of-all-available-pincode-with-serviceability)

```
$object=new NimbuspostApi($config);
$response=$object->getCouriersServiceable();
```

#### Check serviceablity and get Freight Charges between origin and destination pincodes

[](#check-serviceablity-and-get-freight-charges-between-origin-and-destination-pincodes)

```
$object=new NimbuspostApi($config);
$payload = [
  // refer above url for required parameters
  'weight'=>500,
];
$response=$object->getCourierServiceability($payload);
```

NDR
---

[](#ndr)

### Get NDR List

[](#get-ndr-list)

```
$object=new NimbuspostApi($config);
$payload = [
  // refer above url for required parameters
  'per_page'=>1,
];
$response=$object->getNdr($payload);
```

### Submit NDR Action

[](#submit-ndr-action)

```
$object=new NimbuspostApi($config);
$payload = [
  // refer above url for required parameters
  [
    "awb" : "NMBC0002111111",
  ]
];
$response=$object->putNdrAction($payload);
```

Tracking
--------

[](#tracking)

### Get the single tracking history through awb

[](#get-the-single-tracking-history-through-awb)

```
$object=new NimbuspostApi($config);
$awb='N123456789';
$response=$object->getShipmentTracking($awb);
```

### Get the bulk tracking history through awb

[](#get-the-bulk-tracking-history-through-awb)

```
$object=new NimbuspostApi($config);
$payload=[
         "awb"=> [
             "77845353283",
             "4270712142976"
         ]
     ]
$response=$object->getShipmentsTracking($payload);
```

### Get the tracking history through shipment id

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

```
$object=new NimbuspostApi($config);
$shipmentId=123456789;
$response=$object->getShipmentTrackingByShipmentId($shipmentId);
```

Order
-----

[](#order)

### Get orders list

[](#get-orders-list)

```
$object=new NimbuspostApi($config);
$payload = [
 // refer above url for required parameters
 'per_page'=>1
];
$response=$object->getOrders($payload);
```

### Get specific order

[](#get-specific-order)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$orderId=123123123;
$response=$object->getOrder($orderId);
```

### Create custom order

[](#create-custom-order)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
 'order_number'=>'4423',
];
$response=$object->createOrder($payload);
```

### Create autoship order

[](#create-autoship-order)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
 'order_number'=>'4423',
];
$response=$object->createAutoshipOrder($payload);
```

### Cancel order

[](#cancel-order)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$orderId=123123123;
$response=$object->cancelOrder($orderId);
```

### Ship by order id

[](#ship-by-order-id)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
 'id'=>'4423',
];
$response=$object->shipByOrderId($payload);
```

Shipments
---------

[](#shipments)

### Get list of shipments

[](#get-list-of-shipments)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
'page'=>'1',
];
$response=$object->getShipments($payload);
```

### Get specific shipment

[](#get-specific-shipment)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$shipmentId=12314;
$response=$object->getShipment($shipmentId);
```

### Create Shipment

[](#create-shipment)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
  'order_number'=>'1231',
];
$response=$object->createShipment($payload);
```

### Cancel Shipment

[](#cancel-shipment)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
  'awb'=>'59632218892',
];
$response=$object->cancelShipment($payload);
```

Manifest
--------

[](#manifest)

### Generate manifest through awb number

[](#generate-manifest-through-awb-number)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
 "awbs": [
        "4152911775885",
        "NMBC0001789312"
    ]
];
$response=$object->createManifest($payload);
```

Warehouse
---------

[](#warehouse)

### Get the list of warehouse

[](#get-the-list-of-warehouse)

```
$object=new NimbuspostApi($config);
$response=$object->getWarehouses();
```

### Create warehouse

[](#create-warehouse)

```
$object=new NimbuspostApi($config);
// refer above url for required parameters
$payload=[
 "name": "XXXXXXXXX"
];
$response=$object->createWarehouse($payload);
```

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

892d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d4d1ec1285b8a8e01f0dbd4e78be52a8783277627e50a6a31a3e07b5ec672a49?d=identicon)[tech-nimbuspost](/maintainers/tech-nimbuspost)

---

Top Contributors

[![tech-nimbuspost](https://avatars.githubusercontent.com/u/152402881?v=4)](https://github.com/tech-nimbuspost "tech-nimbuspost (5 commits)")

### Embed Badge

![Health badge](/badges/nimbuspost-nimbuspost/health.svg)

```
[![Health](https://phpackages.com/badges/nimbuspost-nimbuspost/health.svg)](https://phpackages.com/packages/nimbuspost-nimbuspost)
```

###  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.1M453](/packages/google-gax)

PHPackages © 2026

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