/royalmail-php-library

PHP library for calculating Royal Mail shipping prices offline

Primary LanguagePHPOpen Software License 3.0OSL-3.0

Royal Mail PHP Shipping Method Library

image

This repository contains the source code for the Meanbee Royal Mail PHP Library. It takes the country code, package value, and package weight and then outputs an array of objects containing the available shipping methods.

Using the Library

To use the library, call the getMethods method with your country code (in the ISO 3166 format), package value, and package weight.

Example Usage

$calculateMethodClass = new CalculateMethodClass();

$calculateMethodClass->getMethods('GB', 20, 0.050);

This will return an array of objects where each object contains the shipping method name, minimum weight, maximum weight, price of the method, maximum insurance value, and proper name of the shipping method.

Unit Testing

This program is automatically unit tested with phpunit and travis.

CSV data format

This library uses six CSV files to determine which shipping methods are available:

  1. 1_countryCodeToZone.csv

    • Country code
    • World zone. Each country, defined by its country code can be in more then one zone. The code "GB" for Great Britain is in the EU and the GB World zone. There are four world zones:
      • WORLD_ZONE_GB
      • WORLD_ZONE_EU
      • WORLD_ZONE_ONE
      • WORLD_ZONE_TWO

  2. 2_zoneToDeliveryMethod.csv

    • World zone
    • Shipping zone.

    Each shipping method's name starts with the world zone it links to as prices differ between zones.

  3. 3_deliveryMethodMeta.csv

    • Delivery method
    • Minimum price of method
    • Maximum price available to the method (the maximum price of shipping cart this method applies to)
    • Max insurance available on method
    • Human-friendly method name
    • Delivery group

  4. 4_deliveryToPrice.csv

    • Method name
    • Minimum weight
    • Maximum weight
    • Price of method
    • Max insurance value
    • In the case of small or medium parcel up to 2kg in weight "SMALL" or "MEDIUM" else blank

Method names are constructed in the WORLDZONE_NAME_WITH_UNDERSCORES format with a separate method being added for each separate foramt. Examples of these can be seen in multiple of the csvs. In the case of extra insurance available on the item, another method must be created. An example can be seen in the 3_deliveryMethodMeta.csv.