PHPackages                             supershipvn/supership-sdk-laravel - 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. supershipvn/supership-sdk-laravel

ActiveLibrary[API Development](/categories/api)

supershipvn/supership-sdk-laravel
=================================

SuperShip SDK for Laravel

v1.0.0(3y ago)015MITPHPPHP ^5.4|^7.0|^8.0

Since Mar 2Pushed 3y ago1 watchersCompare

[ Source](https://github.com/supershipvn/supership-sdk-laravel)[ Packagist](https://packagist.org/packages/supershipvn/supership-sdk-laravel)[ Docs](https://github.com/supershipvn/supership-sdk-laravel)[ RSS](/packages/supershipvn-supership-sdk-laravel/feed)WikiDiscussions 1.x Synced 3d ago

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

SuperShip SDK for Laravel
=========================

[](#supership-sdk-for-laravel)

[![Total Downloads](https://camo.githubusercontent.com/dde1f73a68c34dd4a064a6e637e76b5c7d834d81cf2ff4264ed6daba443762f1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f737570657273686970766e2f7375706572736869702d73646b2d6c61726176656c)](https://packagist.org/packages/supershipvn/supership-sdk-laravel)[![Latest Stable Version](https://camo.githubusercontent.com/735f7395d415213dabc53bfd9d33f3719e8f023f7082f107b941894a0a94dd6b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f737570657273686970766e2f7375706572736869702d73646b2d6c61726176656c)](https://packagist.org/packages/supershipvn/supership-sdk-laravel)[![License](https://camo.githubusercontent.com/1e58ca2c66bae51a6afe16fb0cb02248bfcbdb487ad66e208747b783c0fec114/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f737570657273686970766e2f7375706572736869702d73646b2d6c61726176656c)](https://packagist.org/packages/supershipvn/supership-sdk-laravel)

Introduction
------------

[](#introduction)

Using the **SuperShip SDK for Laravel**, developers can easily integrate [SuperShip APIs](https://docs.developers.supership.vn) into their Laravel codebase, enabling businesses to automate and scale their shipping operations.

Features
--------

[](#features)

Some of the SuperShip APIs available include:

- Areas API: This API allows developers to retrieve a list of provinces, districts, and communes supported by SuperShip for the pickup, delivery, and return of goods.
- Auth API: This API allows developers to register a new user and retrieve a token via username and password.
- Orders API: This API allows developers to retrieve shipping rates, create a new order, retrieve order information, obtain order status lists, and generate shipping labels.
- Warehouses API: This API allows developers to create a new warehouse, edit the current warehouse, and retrieve information on all warehouses.
- Webhooks API: This API allows developers to register a new webhook, edit the current webhook, and retrieve registered webhooks.

Please check [SuperShip API Documentation](https://docs.developers.supership.vn) for more details.

API Documentation
-----------------

[](#api-documentation)

Documentation for SuperShip APIs can be found on the [API Documentation Website](https://docs.developers.supership.vn).

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

[](#installation)

You can install the package via [Composer](https://getcomposer.org/):

```
composer require supershipvn/supership-sdk-laravel
```

The package will automatically register itself.

You can optionally publish the config file with:

```
php artisan vendor:publish --provider="SuperShipVN\SuperShip\SuperShipServiceProvider" --tag="supership-config"
```

***The following steps are necessary only if your Laravel version is lower than 5.5***

- To add the service provider, update the `config/app.php` file by including an entry for it.

```
'providers' => [
    // ...
    SuperShipVN\SuperShip\SuperShipServiceProvider::class
];
```

- To register the class alias, add an entry for it in the aliases section.

```
'aliases' => [
    // ...
    'SuperShip' => SuperShipVN\SuperShip\Facades\SuperShip::class
];
```

Configuration
-------------

[](#configuration)

To enter your *SuperShip API Token*, update the `.env` file with the following information:

```
SUPERSHIP_API_TOKEN=xxxxxxxxxxxxxxxxxxxx

```

Usage
-----

[](#usage)

### Orders API

[](#orders-api)

#### Create Order

[](#create-order)

To create a new order, call the `createOrder` method using the following syntax:

```
use SuperShip;

$params = [
    'pickup_phone' => '0989999999',
    'pickup_address' => '45 Nguyễn Chí Thanh',
    'pickup_commune' => 'Phường Ngọc Khánh',
    'pickup_district' => 'Quận Ba Đình',
    'pickup_province' => 'Thành phố Hà Nội',
    'name' => 'Trương Thế Ngọc',
    'phone' => '0945900350',
    'email' => null,
    'address' => '35 Trương Định',
    'province' => 'Thành phố Hồ Chí Minh',
    'district' => 'Quận 3',
    'commune' => 'Phường 6',
    'amount' => '220000',
    'value' => null,
    'weight' => '200',
    'payer' => '1',
    'service' => '1',
    'config' => '1',
    'soc' => 'KAN7453535',
    'note' => 'Giao giờ hành chính',
    'product_type' => '2',
    'products' => [
        [
            'sku' => 'P899234',
            'name' => 'Tên Sản Phẩm 1',
            'price' => 200000,
            'weight' => 200,
            'quantity' => 1,
        ],
        [
            'sku' => 'P899789',
            'name' => 'Tên Sản Phẩm 2',
            'price' => 250000,
            'weight' => 300,
            'quantity' => 2,
        ],
    ]
];

SuperShip::createOrder($params);
```

Optionally, you can retrieve the Order Code using the following method:

```
$order = SuperShip::createOrder($params);

return $order['results']['code'];
```

#### Get Single Order Info

[](#get-single-order-info)

To retrieve single order, call the `getOrderInfo` method using the following syntax:

```
$supershipOrderCode = 'SUPERSHIP_ORDER_CODE';

SuperShip::getOrderInfo($supershipOrderCode);
```

#### Get All Order Statuses

[](#get-all-order-statuses)

To retrieve all order statuses, call the `getOrderStatuses` method using the following syntax:

```
SuperShip::getOrderStatuses();
```

#### Create Print Token

[](#create-print-token)

To obtain a new token for label printing, call the `createPrintToken` method using the following syntax:

```
$params = [
    'code' => [
        'SUPERSHIP_ORDER_CODE_1',
        'SUPERSHIP_ORDER_CODE_2'
    ]
];

SuperShip::createPrintToken($params);
```

#### Get Print Link

[](#get-print-link)

To retrieve the print link for a print token, call the `getPrintLink` method using the following syntax:

```
$printToken = '49ef6620-423e-11e9-b019-b71407a43f47';
$labelSize = 'K46';

SuperShip::getPrintLink($printToken, $labelSize);
```

### Warehouses API

[](#warehouses-api)

#### Get All Warehouses

[](#get-all-warehouses)

To retrieve all warehouses, call the `getWarehouses` method using the following syntax:

```
SuperShip::getWarehouses();
```

#### Create Warehouse

[](#create-warehouse)

To create a new warehouse, call the `createWarehouse` method using the following syntax:

```
$params = [
    'name' => 'Kho HBT',
    'phone' => '0989999888',
    'contact' => 'Trần Cao Cường',
    'address' => '47 Lê Lợi',
    'province' => 'Thành phố Hồ Chí Minh',
    'district' => 'Quận Tân Bình',
    'district' => 'Phường 13',
    'primary' => '1'
];

SuperShip::createWarehouse($params);
```

#### Update Warehouse

[](#update-warehouse)

To edit the current warehouse, call the `editWarehouse` method using the following syntax:

```
$params = [
    'code' => 'WLKGT07050',
    'name' => 'Kho Hai Bà Trưng',
    'phone' => '0989999888',
    'contact' => 'Dương Mạnh Quân'
];

SuperShip::editWarehouse($params);
```

### Webhooks API

[](#webhooks-api)

#### Get All Webhooks

[](#get-all-webhooks)

To retrieve all webhooks, call the `getWebhooks` method using the following syntax:

```
SuperShip::getWebhooks();
```

#### Register Webhook

[](#register-webhook)

To register a new webhook, call the `registerWebhook` method using the following syntax:

```
$partnerUrl = 'https://example.com/listen/supership';

SuperShip::registerWebhook($partnerUrl);
```

### Auth API

[](#auth-api)

#### Create User

[](#create-user)

To create a new user, call the `createUser` method using the following syntax:

```
$params = [
    'project' => 'HMN Store',
    'name' => 'Hoàng Mạnh Nam',
    'phone' => '0989998888',
    'email' => 'hmn.store@gmail.com',
    'password' => '323423',
    'partner' => 'lPxLuxfiTotCyZ1ZnQjMepUL24HLd05ybNBhVGFN'
];

SuperShip::createUser($params);
```

#### Retrieve Token

[](#retrieve-token)

To retrieve a token via username and password, call the `retrieveToken` method using the following syntax:

```
$params = [
    'client_id' => 'AZN6QUo40w',
    'client_secret' => 'C4fFVeFPkISEDQ8acNo9oSHUd8yIGuvoLWJdX9zY',
    'username' => 'hmn.store@gmail.com',
    'password' => '323423',
    'partner' => 'lPxLuxfiTotCyZ1ZnQjMepUL24HLd05ybNBhVGFN'
];

SuperShip::retrieveToken($params);
```

### Areas API

[](#areas-api)

#### Get All Provinces

[](#get-all-provinces)

To retrieve all provinces, call the `getProvinces` method using the following syntax:

```
SuperShip::getProvinces();
```

#### Get All Districts

[](#get-all-districts)

To retrieve all districts, call the `getDistricts` method using the following syntax:

```
$provinceCode = '79';

SuperShip::getDistricts($provinceCode);
```

#### Get All Communes

[](#get-all-communes)

To retrieve all communes, call the `getCommunes` method using the following syntax:

```
$districtCode = '777';

SuperShip::getCommunes($districtCode);
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information about recent changes.

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

[](#contributing)

Thank you for considering contributing to **SuperShip SDK for Laravel**! The contribution guide can be found in our [contributing guidelines](CONTRIBUTING.md).

Security
--------

[](#security)

If you've found a bug regarding security please mail  instead of using the issue tracker.

Credits
-------

[](#credits)

- [SuperShip](https://github.com/supershipvn)
- [All Contributors](../../contributors)

License
-------

[](#license)

**SuperShip SDK for Laravel** is open-sourced software licensed under the [MIT license](LICENSE).

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 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

Every ~0 days

Total

2

Last Release

1221d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/0645d7ab927eb8b1bc94e689bf927e6094f947566c21920ca52897e3e5f0f4e2?d=identicon)[supership](/maintainers/supership)

---

Top Contributors

[![kendykan107](https://avatars.githubusercontent.com/u/98110089?v=4)](https://github.com/kendykan107 "kendykan107 (2 commits)")

---

Tags

phplaravelsdksupership

### Embed Badge

![Health badge](/badges/supershipvn-supership-sdk-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/supershipvn-supership-sdk-laravel/health.svg)](https://phpackages.com/packages/supershipvn-supership-sdk-laravel)
```

###  Alternatives

[resend/resend-laravel

Resend for Laravel

1222.7M9](/packages/resend-resend-laravel)[jetimob/asaas-sdk-php-laravel

Laravel SDK for Asaa's API

195.5k](/packages/jetimob-asaas-sdk-php-laravel)

PHPackages © 2026

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