Download the PHP package xi0s/royal-mail-shipping-rest-api-client without Composer

On this page you can find all versions of the php package xi0s/royal-mail-shipping-rest-api-client. 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?

Example code of xi0s/royal-mail-shipping-rest-api-client

Informations about the package royal-mail-shipping-rest-api-client

Royal Mail API Shipping v3 Client

This API specification details the requirements for integrating with Royal Mail API Shipping V3.

It specifically covers how the Royal Mail API Shipping V3 can be used by business customers to conduct shipping activity with Royal Mail and provides the technical information to build this integration. This specification must be used with the relevant accompanying specifications for customers wishing to interface their systems with Royal Mail services.

Royal Mail API Shipping V3 exposes a fully RESTful service that allows account customers to create shipments, produce labels, and produce documentation for all the tasks required to ship domestic items with Royal Mail.

Built on industry standards, Royal Mail API Shipping V3 provides a simple and low cost method for customers to integrate with Royal Mail, and allows them to get shipping quickly. The API offers data streaming and offline barcoding to allow customers greater flexibility when generating their labels. There are no costs to customers for using the Royal Mail API Shipping V3 services, however customers’ own development costs must be covered by the customer developing the solution. Royal Mail will not accept any responsibility for these development, implementation and testing costs. Customers should address initial enquiries regarding development of systems for these purposes to their account handler.

This API can be used in conjunction with Royal Mail Pro Shipping, a GUI based shipping platform. For more details on Royal Mail Pro Shipping, including videos on and briefs on updating/ cancelling a shipment and Manifesting please refer to http://www.royalmail.com/pro-shipping-help.

This PHP package is automatically generated by the Swagger Codegen project:

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Tests

To run the unit tests:

Getting Started

Please follow the installation procedure and then run the following:

Documentation for API Endpoints

All URIs are relative to ///shipping/v3

Class Method HTTP request Description
AddressesApi addressesCreate POST /addresses Create Address
AddressesApi addressesDelete DELETE /addresses/{addressId} Delete Address
AddressesApi addressesGet GET /addresses/{addressId} Get Address
AddressesApi addressesGetAll GET /addresses Get Addresses
AddressesApi addressesUpdate PUT /addresses/{addressId} Update address
ItemsApi itemsCreate POST /items Create Item
ItemsApi itemsDelete DELETE /items/{itemId} Delete Item
ItemsApi itemsGet GET /items/{itemId} Get Item
ItemsApi itemsGetAll GET /items Get Items
ItemsApi itemsUpdate PUT /items/{itemId} Update item
ManifestsApi manifestsCreate POST /manifests Manifest All Shipments
ManifestsApi manifestsCreateByCarrier POST /manifests/bycarrier Manifest by Carrier Code(s)
ManifestsApi manifestsCreateByService POST /manifests/byservice Manifest by Service Code(s)
PackagingApi packagingCreate POST /packaging Create Packaging
PackagingApi packagingDelete DELETE /packaging/{packagingId} Delete Packaging
PackagingApi packagingGet GET /packaging/{packagingId} Get Packaging
PackagingApi packagingGetAll GET /packaging Get All Packaging
PackagingApi packagingUpdate PUT /packaging/{packagingId} Update packaging
ShipmentsApi shipmentsCancel PUT /shipments/cancel Cancel Shipments
ShipmentsApi shipmentsCreate POST /shipments Create Shipment
ShipmentsApi shipmentsDefer PUT /shipments/defer Defer Shipments
ShipmentsApi shipmentsHold PUT /shipments/hold Hold Shipments
ShipmentsApi shipmentsPrintDocument PUT /shipments/{shipmentId}/printDocument Print Document
ShipmentsApi shipmentsPrintLabel PUT /shipments/{shipmentId}/printLabel Print Label
ShipmentsApi shipmentsRelease PUT /shipments/release Release Shipments
ShipmentsApi shipmentsServiceAvailability POST /shipments/serviceAvailability Service Availability
TokenApi authenticatePost POST /token Authenticates a User and provides token.

Documentation For Models

Documentation For Authorization

clientID

clientSecret

Author

All versions of royal-mail-shipping-rest-api-client with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.8
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 xi0s/royal-mail-shipping-rest-api-client contains the following files

Loading the files please wait ....