Reading list Switch to dark mode

    Magento 2 Multi Vendor Royal Mail Shipping

    Updated 26 October 2023

    Marketplace Royal Mail Shipping for Magento 2 module provides the Royal Mail Shipping method for shipping the products domestically and Internationally from the U.K – the United Kingdom. By using this module, you can provide Royal Mail shipping to your customers. Royal Mail is a widely known and acknowledged company that was established in early 1516 then now it’s with the Marketplace.

    Please Note:

    Check the backend configuration –

    Check the storefront working –


    • Admin can Enable or Disable the Royal Mail Shipping method.
    • Admin can set the Royal Mail shipping method Title Name that is Visible on the frontend.
    • The admin can set the Parcel Size then Weight Units.
    • Admin can set the Domestic Allowed Methods.
    • Admin can set to Calculate the Handling Fee as Fixed or Percentage.
    • The admin can set the Amount of Handling Fee.
    • You can check the handy guide to U.K & International Parcel and Letter Service Prices.
    • The Origin for the Seller Store must be United kingdom.
    • The shipping rate is calculated according to the Product Weight than the Destination Country.

    Install from Webkul Store

    #1 Download Module

    Firstly, you need to log in to Webkul Store, go to My Account>My Purchased Products section, verify and then download and extract the contents of this zip folder on the system.

    Searching for an experienced
    Magento 2 Company ?
    Find out More

    #2 Upload Folder

    Once the module zip is extracted, follow path src>app and then copy the app folder into the Magento 2 root directory on the server as shown below:


    #3 Run Commands

    After uploading the module folder, you need to run the following commands in the Magento 2 root directory:

    • php bin/magento setup:upgrade
    • php bin/magento setup:di:compile
    • php bin/magento setup:static-content:deploy
    • php bin/magento indexer:reindex
    • php bin/magento cache:flush

    Install from Magento Marketplace

    If you have purchased this extension from the Magento Marketplace then please follow the below process or visit this link.

    #1 Get Access Keys

    You need to get access keys, navigate to My Profile in Magento Marketplace, then choose Access Keys in the My Products section.


    Go to Magento 2 and then you need to copy both the Access Keys – Public Key and Private Key. These access keys will be needed in the next steps for authentication.


    If access keys are not created earlier, click Create A New Access Key, enter any name and click OK.


    #2 Update composer.json File

    To know the component name and version number, go to your Magento Marketplace account section, My Profile>My Purchases, then find this extension to view the details. Please note – Below is an example image, every extension will have its unique component name and version.


    After that, navigate to your Magento project directory and update your composer.json file in the following format.

    composer require <component-name>:<version>

    For example, to install version 5.0.0 of this extension you need to run the following command:

    composer require webkul/marketplace-base-royal-mail-shipping:5.0.0

    #3 Enter Access Keys

    Now you will need to enter the Access Keys that you obtained as explained in the first step #1 Get Access Keys. Wait for Composer to finish updating your project dependencies and make sure there aren’t any errors.

    #4 Run Command

    You need to run the following commands:

    • php bin/magento setup:upgrade
    • php bin/magento setup:di:compile
    • php bin/magento setup:static-content:deploy
    • php bin/magento indexer:reindex
    • php bin/magento cache:flush

    Multi-Lingual Setup

    For Multilingual support, please navigate through Store > Configuration->General > Locale Options and select your desired language from the locale option.


    Module Language Translation

    If you need to do the module translation, please navigate the path app/code/Webkul/shopping-list/i18n and edit the file named en_US.csv as shown in the below screenshot.


    Once you have opened the file for editing, replace the words after the comma(,) on the right with your translated words. After editing the CSV file, save it and then upload it to the same path app/code/Webkul/MpRoyalMailShipping/i18n. The module will now get translated into your desired language. It supports both the LTR and RTL languages.


    How to Get Royal Mail API Credentials?

    Here the admin will configure the module and enter the Client ID and Client Secret for the Royal Mail. Client Id and Client Secret Id can be generated by registering at

    royal mail shipping

    Check Email

    After registering, you will receive an email having a link to activate your account. You need to click the activation link, which will redirect you to the login page.

    Now enter your login Id (Email Id used for the registration) and the password that you set while registering and click the login button.

    royal mail login

    After logging in, go to the menu item Getting Started and then navigate to the Register your Application point and click the “Register Your Application” button.

    royal mail account

    On the Register Application page, provide the application name that will be consuming the API, enter the description and click the submit button.

    royal mail shipping

    After clicking the submit button, you will find your Client Id and Client Secret as per the below snapshot.

    royal mail shipping

    After generating the Client Id and the Client Secret, the admin and sellers will enter it at the Marketplace Royal Mail shipping configuration page. Admin will configure the rest of the settings as follows.

    Module Configuration

    Next to the successful installation of the Marketplace Royal Mail Shipping for Magento 2 module, you will be able to see the configuration panel under Store-> Configuration -> Sales -> Delivery Methods -> Marketplace Royal Mail Shipping.

    • Enabled for Checkout -Admin will set the value to “Yes” to enable the module for checkout or “No” to Disable it.
    • Test Mode – The admin can select the test mode as “Yes” for testing the shipping or “No” to go Live.
    • Allow Sellers to Save Royal Mail Details – The admin can allow the sellers to save the royal mail details at their end too.
    • Title – Admin will enter the shipping name that will be visible at the time of checkout.
    • Client Id – The admin will enter his Client Id.
    • Client Secret – Admin will enter his Client Secret key.
    • Parcel Size
      The admin will select the Parcel Size as Small(2 Kgs.) or Medium.
    • Weight Unit – Admin will select the weight unit for the parcels as Kilograms or Pounds.
    • Allowed Domestic Methods -The admin can select to allow the Domestic Delivery methods available.
    • Ship to Specific Countries – Admin can select to ship to specific countries or all countries under this option.
    • Ship to Applicable Countries -The admin can select “All Allowed Countries” or “Specific Countries”.
    • Calculate Handling Fee – Admin can set to calculate the handling fee as Fixed or Percentage.
    • Handling Fee– The admin will set the handling fee.
    • Displayed Error Message – Admin will enter the error message that will be displayed if the method is not available.
    • Show Method if Not Applicable – Admin selects “Yes”, then the error message will be displayed if the method is not available.
    • Debug – If set to “Yes”, then the debug log file will be created.

    Change Currency

    NOTE: The admin will need to set the currency rate in British Pounds for the working of the module.

    After login to the admin panel, on the side panel navigate through Store->Currency Rates.


    On the currency page as shown below, tap on Options.


    This brings up the Currency Options. Here, for the allowed currencies option select British Pounds and save the setting.


    Lastly, after saving the configuration you can see the GBP added as per the snapshot below.


    Marketplace Royal Mail Seller Workflow

    If the admin has allowed the sellers to add their Royal Mail Shipping Details, then the seller can also enter their Royal Mail Credentials from the seller dashboard. The seller can also generate their Royal Mail Credential by clicking on the link here. The seller can follow the steps to generate their credential as mentioned earlier.

    royal mail credential

    Customer Workflow

    The customer can estimate the shipping costs and available shipping methods of the Royal Mail Shipping.


    When the buyer adds the products into the cart then goes for the checkout, he will be able to see the Marketplace Royal Mail Shipping on the checkout page as per the snapshot below.


    Customers can also see the selected shipping method on the Order Review page as shown below in the snapshot.


    After the order has been placed, the customer can go to his account menu then click “My Orders” to see the Order details as shown below in the snapshot.


    Seller – Order Management

    For Marketplace Royal Mail Shipping, when the order is placed, the seller can see the order under “My Order History” as per the image below. Now click on the View Order to see the details for the Order as shown below. The seller needs to click the Ship button and enter the tracking number.


    After clicking the Ship button, the seller generates the Shipment and can view the shipment details, print the packing slip and send tracking details to the customer.


    The seller can download the packing slip in pdf format by clicking the Print Shipment button.


    Admin Order Management

    The extension also works with the admin’s products. This means the admin can allow its customers to choose the Royal Mail shipping methods for the admin’s own products.


    Once the order is placed, the admin can create the shipment for his own product purchased by the customer.


    Once the shipment is created by the admin, he can add shipment and tracking information and send details to the customer.


    That’s all for the Marketplace Royal Mail Shipping for Magento 2 modules still have a doubt get back to us at or drop a mail at [email protected].

    Current Product Version - 5.0.2

    Supported Framework Version - Magento 2.0.x, 2.1.x, 2.2.x,2.3.x, 2.4.x

    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*

    Be the first to comment.

    Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content