Download the PHP package nomisoft/royal-mail-tracking-api without Composer

On this page you can find all versions of the php package nomisoft/royal-mail-tracking-api. 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 nomisoft/royal-mail-tracking-api

Informations about the package royal-mail-tracking-api

Royal Mail Tracking API

To be able to track items through the Royal Mail API you'll need to be a Royal Mail account holder and have approved access to the Tracking API through the Royal Mail developer portal at https://developer.royalmail.net/

Installation

Usage

You'll need the tracking reference number of the item you wish to retrieve details of as well as your Client ID, Client Secret and App ID (all available from the Royal Mail developer portal)

Single item summary

The response returned is an array containing a DateTime object, the status and summary text

Single item full history

The response returned is a multidimensional array. Each delivery status update contains a DateTime object, the location and the status

Multiple item summaries

The response returned is a multidimensional array with the tracking reference number as the key. Each item contains a DateTime object, status and the summary

Proof of delivery

The response returned is an array containing a DateTime object and the name of the person that signed for the parcel

Errors

A RoyalMailException Exception is thrown if an error response is received from the API. Calling the getMessage() function will return Royal Mail's error description. There's also an additional getCause() function which will return the value of the 'Cause' field returned by the API

If the item was delivered over 30 days ago you might see the following printed from the above sample code

All versions of royal-mail-tracking-api with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.0
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 nomisoft/royal-mail-tracking-api contains the following files

Loading the files please wait ....