Download the PHP package supershipvn/supership-sdk-php without Composer
On this page you can find all versions of the php package supershipvn/supership-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download supershipvn/supership-sdk-php
More information about supershipvn/supership-sdk-php
Files in supershipvn/supership-sdk-php
Package supership-sdk-php
Short Description SuperShip SDK for PHP - Use SuperShip in your PHP project
License MIT
Homepage https://github.com/supershipvn/supership-sdk-php
Informations about the package supership-sdk-php
SuperShip SDK for PHP
Introduction
Using the SuperShip SDK for PHP, developers can easily integrate SuperShip APIs into their PHP codebase, enabling businesses to automate and scale their shipping operations.
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 for more details.
API Documentation
Documentation for SuperShip APIs can be found on the API Documentation Website.
Installation
You can install the package via composer:
Usage
Orders API
Create Order
To create a new order, call the createOrder
method using the following syntax:
Optionally, you can retrieve the Order Code using the following method:
Get Single Order Info
To retrieve single order, call the getOrderInfo
method using the following syntax:
Get All Order Statuses
To retrieve all order statuses, call the getOrderStatuses
method using the following syntax:
Create Print Token
To obtain a new token for label printing, call the createPrintToken
method using the following syntax:
Get Print Link
To get a print link for print token, call the getOrderInfo
method using the following syntax:
Warehouses API
Get All Warehouses
To retrieve all warehouses, call the getWarehouses
method using the following syntax:
Create Warehouse
To create a new warehouse, call the createWarehouse
method using the following syntax:
Update Warehouse
To edit the current warehouse, call the editWarehouse
method using the following syntax:
Webhooks API
Get All Webhooks
To retrieve all webhooks, call the getWebhooks
method using the following syntax:
Register Webhook
To register a new webhook, call the registerWebhook
method using the following syntax:
Auth API
Create User
To create a new user, call the createUser
method using the following syntax:
Retrieve Token
To retrieve a token via username and password, call the retrieveToken
method using the following syntax:
Areas API
Get All Provinces
To retrieve all provinces, call the getProvinces
method using the following syntax:
Get All Districts
To retrieve all districts, call the getDistricts
method using the following syntax:
Get All Communes
To retrieve all communes, call the getCommunes
method using the following syntax:
Changelog
Please see CHANGELOG for more information about recent changes.
Contributing
Thank you for considering contributing to SuperShip SDK for PHP! The contribution guide can be found in our contributing guidelines.
Security
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Credits
License
SuperShip SDK for PHP is open-sourced software licensed under the MIT license.
All versions of supership-sdk-php with dependencies
ext-curl Version *
ext-json Version *