Royal Mail V3 Shipping API Integration

Royal Mail V3 Shipping API Integration

OMS now integrates with the Royal Mail Shipping REST API (V3). The integration allows items to be dispatched using a scan point, which creates a shipment in the Royal Mail's system and also generates a label back to the user. The integration also allows customs declaration documents  and manifest documents to be printed for every shipment.

Royal Mail On-boarding Process

Just download and complete the following Pro Shipping Onboarding Form and return it to us.

We will forward this on to our contacts at Royal Mail and they will contact you via email within a few days to let you know the account is set up and ready.

Within the email they will be ask you to click on the 'Verify Your Account' and set up a password

You should log into the RM Pro shipping account to get the following:

  1. API Username
  2. API Password (this is the password client set in the RM Pro Shipping Account)
  3. Posting location (9 digit number)
Return this information to the Custom Gateway team indicating the dropship company you would like Royal Mail set up on and they will enable to integration for you.

OMS Settings

In the Royal Mail (REST) V3 settings popup in OMS, enter the API Username, Password, Client ID, Client Secret and the Posting Location in the respective fields. These details are required for the integration to obtain the Authorization token needed to access the Royal Mail API functions.

Also select the client in the Shipping Service Strategy field. This is not required and is only used when the STANDARD options below do not fulfil the client needs, where this is the case a custom strategy can be made at an additional development cost.

A shipment strategy can also be selected from the Shipment Strategy drop down. If nothing is selected, the default Combined Strategy is used.

Also the dimensions strategy field can be left blank to use the default dimensions. If the customer requires specific shipment dimensions, please obtain the dimensions for their shipments and contact the support team to configure this.

Order And Product Requirements

To trigger the Royal Mail API integration, the Shipping Carrier on the order must be set to Royal Mail
The Shipping Method should also be set to an appropriate value to trigger the appropriate Royal Mail service for the client. Please see  some of the current shipping method / service code mappings below:
The enhancements are TrackingNotifications, LocalCollect, SafePlace, ConsequentialLoss, RecordedSignedFor and SaturdayGuaranteed. Please refer to the Royal Mail documentation for clarifications for each of these and the respective service code and the format code.
NB: The Service Code, Format Code and Enhancement Types are provided by the integration using the shipping method specified in the order.


Carrier
Method
Service Code
Format Code
TrackingNotifications
LocalCollect
SafePlace
ConsequentialLoss
RecordedSignedFor
SaturdayGuaranteed
Royal Mail
standard untracked 24 letter
CRL1
L
-
-
-
-
-
-
Royal Mail
standard untracked 24 large letter
CRL1
F
-
-
-
-
-

Royal Mail
standard untracked 24
CRL1
P
-
-
-
-
-
-
Royal Mail
standard untracked 48 letter
CRL2
L
-
-
-
-
-
-
Royal Mail
standard untracked 48 large letter
CRL2
F
-
-
-
-
-
-
Royal Mail
standard untracked 48
CRL2
P
-
-
-
-
-
-
Royal Mail
first class letter
STL1
L
-
-
-
-
-
-
Royal Mail
first class large letter
STL1
F
-
-
-
-
-
--
Royal Mail
first class 
STL1
P
-
-
-
-
-
-
Royal Mail
tracked 24 letter 
TPMN
L
-
false
-
-
-
-
Royal Mail
tracked 24 large letter
TPMN
F
-
false
-
-
-
-
Royal Mail
tracked 24
TPMN
P
-
false
-
-
-
-

Also refer to the attached 'Royal Mail Shipping Service' spreadsheet for a list of all the available service codes and there respective format codes and enhancement types.

The weight in Grams and the RRP price on the product must be set. Also note that when setting the price, the quantity should be set to 1.

The  currency field on the company the integration is enabled on must also be set.

A service strategy named 'Standard Weight' is now available.  The strategy uses the same services as the 'Standard' service strategy and determines the format of the service (Letter, Large Letter or Parcel) based on the combined weight of the order.  The weight breaks are listed below.

Weight under 25g is for Letter.
Weight between 25g and 600g is for Large Letter.
Weight greater than 600g for Parcel.

When using the shipping mapping rules on the system with weight ranges, the 'Standard' service strategy should be used to avoid conflict with the weight ranges in the Standard Weight service strategy.


    • Related Articles

    • Royal Mail Shipping API Shipping Integration

      OMS is now able to integrate directly with Royal Mail’s shipping API so that when an item is dispatched using a scan point, a shipment is created in Royal Mail’s system and an official Royal Mail shipping label returned to the user. OMS will only ...
    • MWW Supplier Integration

      Overview It is now possible to send orders directly to the MWW On Demand platform via the new Custom Gateway supplier integration. If you would like to take advantage of this feature, please contact Custom Gateway Support quoting your MWW API key. ...
    • Supplier Shipping API

      Suppliers who have their own workflow systems and don’t have OMS user accounts (e.g. those who use the Generic Filesystem supplier integrations) can now make use of OMS shipping integrations via a simple API. The API allows a supplier to create a ...
    • Global Mail - Deutsche Post Shipping Integration

      This is not available using the legacy scan points. Requirements from Deutsche Post EKP - EKP is required as your unique identifier from Deutsche Post Client Secret - Your password provided by Deutsche Post for any API Call Client Key - Your unique ...
    • ShipStation API Shipping Integration

      OMS can integrate with the ShipStation shipping API so that when an item is dispatched using a scan point, a shipment is created in the ShipStation system and a shipping label for one of your enabled ShipStation carriers is generated . You must have ...