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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
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

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
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package mimicak/shipway-php-sdk contains the following files

Loading the files please wait ...