PHPackages                             james-and-james-fulfilment/royalmail-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. james-and-james-fulfilment/royalmail-php

ActiveLibrary[HTTP & Networking](/categories/http)

james-and-james-fulfilment/royalmail-php
========================================

PHP module for interfacing with the Royal Mail shipping api : http://www.royalmail.com/corporate/services/shipping-api

v0.1.0.4(8y ago)03.9k1MITPHPPHP >=5.4.0

Since Oct 11Pushed 6y ago4 watchersCompare

[ Source](https://github.com/JamesAndJamesFulfilment/royalmail-php)[ Packagist](https://packagist.org/packages/james-and-james-fulfilment/royalmail-php)[ RSS](/packages/james-and-james-fulfilment-royalmail-php/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (3)Versions (7)Used By (0)

Royal Mail API SDK for PHP
==========================

[](#royal-mail-api-sdk-for-php)

[![Build Status](https://camo.githubusercontent.com/9bf0600ace5926534fdbfb5bae574ac0217fde91f333b9cfa268273b0d303f05/68747470733a2f2f7472617669732d63692e6f72672f747572746c6564657369676e2f726f79616c6d61696c2d7068702e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/turtledesign/royalmail-php)

This repository contains a PHP SDK/Interface for the (UK) [Royal Mail's Shipping API](http://www.royalmail.com/corporate/services/shipping-api)

> This module is in an alpha state and hasn't yet been tested against the Royal Mail's servers.
> It should be now be possible to use it in development mode to integrate with client systems, see the [documentation (also still being created) in the wiki](https://github.com/turtledesign/royalmail-php/wiki)This is not an official SDK, we () are a 3rd party integrator releasing the module with an open source licence because why not.

Prerequisites
-------------

[](#prerequisites)

- PHP 5.4 or above
- [soap](http://php.net/manual/en/book.soap.php) & [openssl](http://php.net/manual/en/book.openssl.php) extensions must be enabled
- [fileinfo](http://php.net/manual/en/book.fileinfo.php) required for testing.

Installation
------------

[](#installation)

### - Using Composer

[](#--using-composer)

[**composer**](https://getcomposer.org/) is the recommended way to install the SDK. To use the SDK with project, add the following dependency to your application's composer.json and run `composer update --no-dev` to fetch the SDK.

You can download composer using instructions on [Composer Official Website.](https://getcomposer.org/download/)

#### Prerequisites

[](#prerequisites-1)

- *composer* for fetching dependencies (See )

#### Steps to Install :

[](#steps-to-install-)

Currently, the SDK is available at [https://packagist.org](https://packagist.org/packages/turtledesign/royalmail-php). To use it in your project, you need to include it as a dependency in your project composer.json file. It can be done in two ways :

- Running `composer require 'turtledesign/royalmail-php:*@dev'` command on your project root location (where project composer.json is located.)
- Or, manually editing composer.json file `require` field, and adding `"turtledesign/royalmail-php" :  "*@dev"` inside it.

The resultant sample *composer.json* would look like this:

```
{
  ...

  "name": "sample/website",
  "require": {
  	"turtledesign/royalmail-php" : "*@dev"
  }

  ...
}
```

### - Direct Download (without using Composer)

[](#--direct-download-without-using-composer)

If you do not want to use composer, you can grab the SDK zip that contains Royal Mail API SDK with all its dependencies with it.

#### Steps to Install :

[](#steps-to-install--1)

- Download zip archive with desired version from our [Releases](https://github.com/turtledesign/royalmail-php/releases). Each release will have a `direct-download-*.zip` that contains PHP Rest API SDK and its dependencies.
- Unzip and copy vendor directory inside your project, e.g. project root directory.
- If your application has a bootstrap/autoload file, you should add `include '/vendor/autoload.php'` in it. The location of the `` should be replaced based on where you downloaded **vendor** directory in your application.
- This *autoload.php* file registers a custom autoloader that can autoload the Royal Mail SDK files, that allows you to access PHP SDK system in your application.

More help
---------

[](#more-help)

- [Royal Mail Shipping API Service Page](http://www.royalmail.com/corporate/services/shipping-api)
- [API Reference - PDF](http://www.royalmail.com/sites/default/files/Shipping-API-Technical-User-Guide-v2_1-June-2015.pdf)
- [Reporting issues / feature requests](https://github.com/turtledesign/royalmail-php/issues)

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 88.2% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~154 days

Total

5

Last Release

3247d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/76c703c3de96776eafc564cd80d9c50cbb5487a179984c2c90558233d38cda33?d=identicon)[doublejames-ah](/maintainers/doublejames-ah)

![](https://avatars.githubusercontent.com/u/110097854?v=4)[JJTechWizards](/maintainers/JJTechWizards)[@JJTechWizards](https://github.com/JJTechWizards)

---

Top Contributors

[![Buntix](https://avatars.githubusercontent.com/u/678256?v=4)](https://github.com/Buntix "Buntix (60 commits)")[![minioak](https://avatars.githubusercontent.com/u/1151320?v=4)](https://github.com/minioak "minioak (5 commits)")[![Nocture](https://avatars.githubusercontent.com/u/6805805?v=4)](https://github.com/Nocture "Nocture (2 commits)")[![akhumphrey](https://avatars.githubusercontent.com/u/69626?v=4)](https://github.com/akhumphrey "akhumphrey (1 commits)")

---

Tags

barcodesshippingroyal mailpostagepost-office

### Embed Badge

![Health badge](/badges/james-and-james-fulfilment-royalmail-php/health.svg)

```
[![Health](https://phpackages.com/badges/james-and-james-fulfilment-royalmail-php/health.svg)](https://phpackages.com/packages/james-and-james-fulfilment-royalmail-php)
```

###  Alternatives

[turtledesign/royalmail-php

PHP module for interfacing with the Royal Mail shipping api : http://www.royalmail.com/corporate/services/shipping-api

2016.6k](/packages/turtledesign-royalmail-php)[whatarmy/fedex-rest

New FedEx Rest API wrapper

2440.5k1](/packages/whatarmy-fedex-rest)[ivanmitrikeski/laravel-shipping

Shipping package for Laravel. Supported providers: CanadaPost, USPS, UPS, FedEx and Purolator.

206.8k2](/packages/ivanmitrikeski-laravel-shipping)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)