Menu Close
    Start a Project Request quote Reading list Switch to dark mode

    Marketplace Aramex Shipping For Magento 2

    Marketplace Aramex Shipping For Magento 2 extension will allow the sellers to provide Aramex shipping method for shipping their products to the customers.

    Aramex is one of the best shipping providers in the world, and it is fast, reliable, and trusted by millions of customers around the globe.


    • This module is an add-on of Webkul’s Multi-Vendor Marketplace module. To use this module, you must have installed Multi Vendor Marketplace first.
    • The Aramex COD will be available for the Domestic Shipping methods only.


    • The admin will set the Aramex shipping method name which is visible at the frontend.
    • If the admin enables it, the shipping rates are tabulated as per the volumetric weight of the package.
    • The seller can generate the Aramex label.
    • The dynamic shipping method use for freight calculation.
    • The seller is allowed to manage his order from his account.
    • The admin can add COD rates with this shipping method.
    • The seller will add Invoice & Packing slip address, VAT, TAX information.
    • Ability to download Invoice and Shipping Slip easily.
    • The seller can generate the tracking ID by which the buyer can track their order.
    • The seller will able to print the Invoice of individual orders.
    • The code is fully open and easy to use.


    Customers will get a zip folder, and they have to extract the contents of this zip folder on their system.

    The extracted folder has an src folder, inside the src folder you have the app folder.

    The customer needs to transfer this app folder into the Magento 2 root directory on the server, as shown below.

    After the successful installation, the customer have to run these commands in the Magento 2 root directory:

    First command – php bin/magento setup:upgrade

    Second command –  php bin/magento setup:di:compile

    Third Command – php bin/magento setup:static-content:deploy

    After running the commands, the customer have to flush the cache from Magento admin panel by navigating through->System->Cache management as shown below.

    Thus, in this way the module installation completes.

    Configuration For Multi-lingual Support

    For the multilingual support, the admin will navigate through Store->Configuration->General ->Locale Options.

    After that, they has to select the locale as German (the language into which admin want to translate his store content).

    Thus, the admin can configure the Multi-Ligual Support.

    Module Translation

    If a user wants to translate their module from English to German, then they need to follow the path app/code/Webkul/MpAramexShipping/i18n in their unzipped folder.

    They will get a CSV file with name “en_US.csv”.

    Now, they have to rename that CSV as “de_DE.csv” and translate all right side content after the comma in the German language.

    After editing the CSV, they have to save it and then upload it to the path app/code/Webkul/MpAramexShipping/i18n where they have installed Magento 2 on the server.

    The module will get translated into the German Language. It supports both RTL and LTR languages.

    The user can edit the CSV like the image below:

    Thus in this way the module translation completes.

    How to get Aramex Credentials?

    Note:  To get the Aramex credentials for configuring the module, you can check the steps below or visit this Link.
    1. Email Aramex sales representative and cc
      Tell Aramex you need to integrate Aramex Shipping Services API and Rate Calculator API.
    2. Aramex will provide Aramex Developer guides, and two separate sets of credentials for sandbox and production environments:   Account Number , Username , Password , Account Pin and Account Entity

    Module Configuration Settings – Admin Backend

    After the successful installation of the Marketplace Aramex Shipping Magento 2, the admin will able to find the configuration panel under;

    Stores-> Configuration ->Sales ->Shipping Methods -> Webkul Marketplace Aramex Shipping.

    The admin can set the configurations as under:

    Enabled for Checkout: The admin can set the Aramex shipping to enable/disable on checkout.

    Sandbox Mode: The admin can set the shipping mode as Test or Live.

    Title: The admin can define the title of the Shipping method as desired.

    Account Email: The admin needs to enter the registered Aramex Email in this field.

    Account Pin: The admin needs to fill the Account Pin in the following field.

    Password: Add the Aramex Account Password.

    Account Number: Here the admin can add Aramex account number.

    Account Entity: The Account Entity is filled here.

    Country Code: The admin will add the country code from which the Aramex account is being created.

    Weight Unit: The admin can set the weight unit( Pound or Kilogram) for Aramex shipment.

    The configurations are set as follows:

    Allowed Domestic Methods: To select the selective methods that will use for domestic shipping.

    Allowed International Methods: To select the methods that will use for the International shipping.

    Enable COD Service: To enable the Cash On Delivery service for shipments in Aramex or not.

    The settings for the above configurations are as under:

    COD Instructions: To add the instructions for the Cash On Delivery for the shipments.

    COD Charge: The charges that will apply on the Cash On Delivery.

    Ship To Specific Countries: The admin will be able to select the countries in which shipment can deliver.

    Ship To Applicable Countries: The admin can select the specific countries for the delivery or can select all the countries.

    Displayed Error Message: The admin can set the text that will display whenever the error will occur.

    Handling Fee: The admin can add the handing fee for the shipment.

    The configurations are set by the admin as follows:

    Volumetric Weight Enabled: If enabled by the admin, then shipping will be calculated on the basis of volumetric weight.


    • If the products that are to be shipped are more in number, then the shipping rate shall be less as the rate is tabulated on the basis of the volume of the shipment.

    Allow Seller To Save Aramex Details: If set “Yes” then the seller will able to set their own Aramex Details.

    Show Method If Not Applicable: If set “Yes” then the method will display on the front end.

    Debug: The admin can set the debug as Yes / No as desired.

    Workflow – Seller & Customer’s End

    The sellers can save their Aramex configuration details if the admin has set the option “Allow Sellers To Save Aramex Details” to Yes from the backend.

    When the buyers place an order, they can see the Webkul Aramex Shipping method at the shopping cart page, as shown below:
    Buyers can also see the Webkul Aramex Shipping method under the available shipping methods on the checkout page.

    For the reference, check the below snapshot:
    Webkul Aramex shipping method is also visible at the order review page as shown below in the screenshot:
    NOTE: The shipping rate for Aramex Shipping rates are calculated based on the weight of the product(s) and address of the Buyer.

    Order Management – Seller’s End

    After the buyer has placed the order, the seller can see the order under “My Order History” as shown below in the screenshot.

    After that, the seller will able to generate invoices for their ordered products, generate the tracking number and shipment for the orders of their products.

    Even the seller can notify the customers by sending them emails, cancel/refund the order and also print the order.

    Once the seller generates the shipment and invoice, the seller will able to see the complete order details.

    Shipment Information :

    The seller can see the complete details of the shipment as shown below in the screenshot.

    Aramex Shipping Slip:

    The seller can click on “Aramex Shipping Slip,” and then the label will get downloaded as shown below.

    Sellers can download the Shipping and Invoice slip very easily.

    In the slip, you can also see the company logo and address, vat, tax information which is entered by the seller under the Manage Print PDF Header Info. Menu item in the seller’s panel.

    Shipping Slip
    Invoice Slip
    My Order History

    The seller can also download the PDF of shipping slip and Invoice slip under Marketplace -> My Order History.

    After clicking on Download All option, a pop-up window will open up.

    Here you will enter the date up to which you want to download shipping and invoice slip and click the “Submit” button to download the slips.

    When Aramex COD is enabled

    Now let’s see how this shipping method will work when Aramex COD is enabled from the back-end.

    On the checkout page, the customer can view the shipping method like the image below.

    The customer can choose any of the Aramex method desired and the Aramex COD payment method will available for them.

    At the checkout page, the customer can view the Payment Information like the image below.

    Rest of the process for the order management will remain the same and it is described above.

    Thus, that’s all for the Marketplace Aramex Shipping For Magento 2.

    Still, have any issue feel free to add a ticket and let us know your views to make the module better at

    Current Product Version - 3.0.2

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

    . . .

    Comments (2)

    Add Your Comment

  • Moutasem Shahin
    Hi Guys,

    just a question, can we make the shipping control to be from the admin side only ?

  • Back to Top
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again

    Table of Content

    Hide Index