Download the PHP package mimicak/shipway-php-sdk without Composer
On this page you can find all versions of the php package mimicak/shipway-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package shipway-php-sdk
Shipway PHP SDK
A production-ready PHP client for the Shipway shipping API.
Requirements
- PHP 8.1+
- Composer
Installation
Authentication
Shipway uses HTTP Basic Auth. Your credentials are:
| Field | Where to find |
|---|---|
user_email |
Your Shipway registered email |
api_key |
Shipway dashboard → Profile → Manage Profile → License Key |
Quick Start
Using environment variables
Orders
Create an order (auto-assign carrier)
Create an order with specific carrier and warehouse
Fetch orders
Track a shipment
Create a manifest
Cancel orders (before booking)
Put orders on hold
Cancel a booked shipment
Couriers
List available couriers
Check pincode serviceability
Get carrier rate cards
Warehouses
Create a warehouse / pickup address
Error handling
All SDK methods throw typed exceptions. Catch the most specific type you need:
Exception hierarchy
Configuration reference
Order status codes
| Code | Description |
|---|---|
O |
New order |
A |
Processing |
E |
Manifested |
G |
Dispatched |
Shipment status codes
| Code | Description |
|---|---|
DEL |
Delivered |
INT |
In Transit |
UND |
Undelivered |
RTO |
RTO In Transit |
RTD |
RTO Delivered |
CAN |
Cancelled |
SCH |
Shipment Booked |
ONH |
On Hold |
OOD |
Out for Delivery |
NFI |
Status Pending |
RSCH |
Pickup Scheduled |
ROOP |
Out for Pickup |
RPKP |
Shipment Picked Up |
RDEL |
Return Delivered |
RINT |
Return In Transit |
PCAN |
Pickup Cancelled |
RPF |
Pickup Failed |
Running tests
Coverage report:
License
MIT
All versions of shipway-php-sdk with dependencies
PHP Build Version
Package Version
Requires
guzzlehttp/guzzle Version
^7.10
psr/http-client Version ^1.0
psr/http-factory Version ^1.1
psr/log Version ^3.0
vlucas/phpdotenv Version ^5.6
psr/http-client Version ^1.0
psr/http-factory Version ^1.1
psr/log Version ^3.0
vlucas/phpdotenv Version ^5.6
The package mimicak/shipway-php-sdk contains the following files
Loading the files please wait ...