Shipper Integration | Royal Mail V3

Shipper Integration | Royal Mail V3

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.

Updated Royal Mail V3 Shipping API Integration Features

At KornitX we have continued to develop updates for variants and this is due to the fact we pride ourselves on constant evolution and the release of new features and enhancements every week. We have detailed each new variant enhancement below. If you are interested in knowing what features arrive, they will be continually updated within the "Core Platform Feature Updates" Article - CLICK HERE
This will continue to be updated below whenever a new enhancement is rolled out to improve variants, a time stamp will be labelled with each feature
Integration Now Has Improved Dimension Calculations
This was added on 08-11-2021
The Royal Mail V3 integration has been updated to include improved dimension calculations in an aim to ensure the dimensions used in orders are improved. There are 3 dimension services that can be set on the Royal mail V3 shipping integration which are listed below. 
  1. Standard Dimensions strategy
  2. Standard Weight And Dimensions strategy
  3. Standard Weight strategy (which now has the right weight settings specified by Royal Mail)
Dimensions are now getting included within the API request as long as the product has been provided with these settings.
Default Shipping Strategy for Royal Mail V3
This was added on 03-02-2020
When setting up your integration for this, there is now four default shipping strategies associated to the integration, meaning by default we have included selection of stabdard shipping strategies. These options are "Manual Override". "Individual Parcels", "Combined Parcels" and "Bundled Parcels", as shown below. 


    • Related Articles

    • Shipper Integration | Royal Mail V2

      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 ...
    • Shipper Integration | ParcelHub

      Introduction This article has been created to show how to setup the Shipper Integration that Kornit X has built to connect to ParcelHub.  Setup To setup the ParcelHub integration, please head to your Dropship company and within the advanced settings ...
    • Shipper Integration | Paragon HDX

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to Paragon HDX.  Setup To setup the Paragon HDX integration, please head to your company and within the advanced settings head ...
    • Shipper Integration | Generic Label

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to a Generic Label. Setup To setup the Generic Label integration, please head to your company and within the advanced settings ...
    • Shipper Integration | GLS Spain

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to GLS Spain. Setup To setup the GLS Spain integration, please head to your company and within the advanced settings head to ...