{"id":161787,"date":"2019-02-08T12:19:55","date_gmt":"2019-02-08T12:19:55","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=161787"},"modified":"2026-10-01T08:33:44","modified_gmt":"2026-10-01T08:33:44","slug":"odoo-aramex-shipping-integration","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/odoo-aramex-shipping-integration\/","title":{"rendered":"User Guide for Odoo Aramex Shipping Integration"},"content":{"rendered":"\n
\n

INTRODUCTION<\/strong><\/h2>\n<\/div><\/div>\n\n\n\n

Fast and secure shipping with Odoo Aramex Shipping Integration!<\/em><\/strong><\/p>\n\n\n\n

Aramex is one of the renowned shipping platforms famous for its service across multiple nations globally. Moreover, Aramex logistics services help you deliver products to customers with ease.<\/p>\n\n\n\n

What if you can integrate Aramex into your Odoo?<\/p>\n\n\n\n

Odoo Aramex Shipping Integration<\/a> allows you to integrate the Aramex Delivery Carrier into your Odoo. <\/p>\n\n\n\n

After configuration, the customer can choose the Aramex delivery method for their products. Moreover, the module automatically calculates the shipping cost after selection.<\/p>\n\n\n\n

The admin can also choose the Aramex delivery carrier while creating orders from the Odoo backend.<\/p>\n\n\n\n

You can generate the shipping label in the Odoo backend after creating an Aramex shipment for the order.<\/p>\n\n\n\n

\n

FEATURES<\/strong><\/h2>\n<\/div><\/div>\n\n\n\n
    \n
  1. Connect Aramex shipping services with Odoo.<\/li>\n\n\n\n
  2. Fetch live Aramex shipping rates based on order weight and service.<\/li>\n\n\n\n
  3. Add Aramex delivery charges to sales orders.<\/li>\n\n\n\n
  4. Configure Aramex credentials from the delivery method.<\/li>\n\n\n\n
  5. Support domestic and international Aramex shipping.<\/li>\n\n\n\n
  6. Configure Aramex Product Group, Product Type, Payment Method, and Service.<\/li>\n\n\n\n
  7. Add package weight and dimensions before shipment.<\/li>\n\n\n\n
  8. Generate Aramex shipping labels during delivery validation.<\/li>\n\n\n\n
  9. Access shipment and tracking details from the delivery order.<\/li>\n<\/ol>\n\n\n\n

    INSTALLATION<\/strong><\/h2>\n\n\n\n
      \n
    1. Once you purchase the App from Webkul store, you will receive the link to download the zip file of the module.<\/li>\n\n\n\n
    2. Extract the file on your system after the download finishes. You will be able to see a folder named \u2018aramex_delivery_carrier\u2019.<\/strong><\/li>\n\n\n\n
    3. Copy and paste this folder inside your Odoo Add-Ons path.<\/li>\n\n\n\n
    4. Now, open the Odoo App and click on the Settings menu. Here, click on Activate Developer Mode.<\/li>\n\n\n\n
    5. Then, open the Apps menu and click on \u2018Update Modules List\u2019.<\/strong><\/li>\n\n\n\n
    6. In the search bar, remove all the filters and search \u2018aramex_delivery_carrier\u2019.<\/strong><\/li>\n\n\n\n
    7. You will be able to see the module in the search results. Click on \u2018Install<\/strong>\u2019 to install it.<\/li>\n<\/ol>\n\n\n\n
      \n

      POINTS TO REMEMBER WHILE USING THE MODULE<\/strong><\/h2>\n<\/div><\/div>\n\n\n\n

      Please keep the following points in mind to avoid getting an error message while placing a delivery with Aramex Shipping Carrier.<\/p>\n\n\n\n

      1) Valid Credentials<\/strong><\/h3>\n\n\n\n

      Please use the correct Aramex credentials to configure the module and successfully generate Aramex shipping in Odoo backend and on the website.<\/p>\n\n\n\n

      2) Correct Destination and Sender Address<\/strong><\/h3>\n\n\n\n

      In the order, the addresses entered for both user\/receiver and warehouse\/sender should be valid entries to process the shipping successfully. T<\/p>\n\n\n\n

      he address range from the source to the destination depends upon the type of Aramex service the admin availed.<\/p>\n\n\n\n

      3) A Non-Zero Weight of the Package<\/strong><\/h3>\n\n\n\n

      The product added to Aramex shipping should not have zero as the listed weight in Odoo. Otherwise, the shipment generation request returns an error from Aramex.<\/p>\n\n\n\n

      To avoid this, the admin can also choose a default weight to be automatically sent to AusPost in case the product’s listed weight is zero.<\/p>\n\n\n\n

      \n

      WORKFLOW<\/strong><\/h2>\n<\/div><\/div>\n\n\n\n

      Let\u2019s look at the configuration of Odoo Aramex Shipping Integration.<\/p>\n\n\n\n

      \n

      CONFIGURATION<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n

      1. Firstly, Log into the Odoo backend, go to \u2018Settings> General Settings> Shipping Integration,\u2019<\/strong> and tick the box next to \u2018Aramex Shipping Service.\u2019<\/strong><\/p>\n\n\n\n

      \"configuring-odoo-aramex-shipping-integration\"<\/a><\/figure>\n\n\n\n

      2. Open Delivery Methods<\/strong><\/h3>\n\n\n\n

      Go to Inventory \u2192 Configuration \u2192 Delivery Methods<\/strong> and open the Aramex Express Shipping<\/strong> delivery method.<\/p>\n\n\n\n

      \"delivery-methods\"<\/a><\/figure>\n\n\n\n

      3. Configure the Aramex Delivery Method and Credentials<\/strong><\/h3>\n\n\n\n

      Select Aramex<\/strong> as the provider.<\/p>\n\n\n\n

      Under Integration Level<\/strong>, select Get Rate and Create Shipment<\/strong> to allow Odoo to create the shipment when the delivery order is validated.<\/p>\n\n\n\n

      Configure the Margin on Rate, Additional Margin, Delivery Product,<\/strong> and Invoicing Policy<\/strong> according to your requirements.<\/p>\n\n\n\n

      In the Aramex Credentials<\/strong> section of the same delivery method, enter the required User Name, Password, Aramex Account Number, Account PIN, Account Entity,<\/strong> and Account Country Code<\/strong>.<\/p>\n\n\n\n

      These credentials connect the delivery method with the Aramex account. The module also provides a Test Environment for checking the connection before production use.<\/p>\n\n\n\n

      \"aramex-delivery-method-credentials\"<\/a><\/figure>\n\n\n\n

      4. Configure Delivery and Aramex Shipping Information<\/strong><\/h3>\n\n\n\n

      Open the Extra<\/strong> tab.<\/p>\n\n\n\n

      Under Delivery Setting<\/strong>, configure the Packaging Type, Default Weight, Odoo Product UoM, API UoM,<\/strong> and Packaging<\/strong>.<\/p>\n\n\n\n

      Under Aramex Shipping Information<\/strong>, select the Aramex Product Group, Aramex Product Type, Aramex Payment Method,<\/strong> and Aramex Service<\/strong>.<\/p>\n\n\n\n

      \"aramex-shipping-information\"<\/a><\/figure>\n\n\n\n
      \n

      GET ARAMEX SHIPPING RATE<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n

      5. Create a Sales Order<\/strong><\/h3>\n\n\n\n

      Go to the Sales<\/strong> module and create a sales order for which you want to apply Aramex shipping.<\/p>\n\n\n\n

      \"sales-order\"<\/a><\/figure>\n\n\n\n

      6. Request the Aramex Shipping Rate<\/strong><\/h3>\n\n\n\n

      Click Add shipping<\/strong> on the sales order.<\/p>\n\n\n\n

      In the Add a shipping method<\/strong> window, select Aramex Express Shipping<\/strong>. Check the displayed order weight and click Get rate<\/strong> to request the current shipping cost from Aramex.<\/p>\n\n\n\n

      \"get-aramex-shipping-rate\"<\/a><\/figure>\n\n\n\n

      7. Add the Shipping Charge to the Order<\/strong><\/h3>\n\n\n\n

      Review the returned Aramex shipping rate and click Add<\/strong>.<\/p>\n\n\n\n

      The Aramex delivery charge is added as a separate line to the sales order, and the order total is updated accordingly.<\/p>\n\n\n\n

      \"aramex-delivery-charge\"<\/a><\/figure>\n\n\n\n
      \n

      PACKAGE PREPARATION<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n

      8. Add Package Details<\/strong><\/h3>\n\n\n\n

      Open the related delivery order and click Put in Pack<\/strong>.<\/p>\n\n\n\n

      In the popup, select the Package Type<\/strong> and enter the Shipping Weight<\/strong>. Then enter the package Height, Width,<\/strong> and Length<\/strong>.<\/p>\n\n\n\n

      Click Put in Pack<\/strong> to assign the products to the package.<\/p>\n\n\n\n

      \"aramex-package-details\"<\/a><\/figure>\n\n\n\n
      \n

      SHIPMENT AND LABEL GENERATION<\/strong><\/h3>\n<\/div><\/div>\n\n\n\n

      9. Validate the Delivery and Create the Shipment<\/strong><\/h3>\n\n\n\n

      After preparing the package, validate the delivery order.<\/p>\n\n\n\n

      Since Get Rate and Create Shipment<\/strong> is enabled, Odoo sends the required shipment details to Aramex during validation. <\/p>\n\n\n\n

      The shipment is created and the Aramex shipping label is generated and attached to the delivery order.<\/p>\n\n\n\n

      The delivery status changes from Ready<\/strong> to Done<\/strong>, while the delivery chatter records the shipment response and tracking details.<\/p>\n\n\n\n

      \"validate-delivery-create-shipment\"<\/a><\/figure>\n\n\n\n

      10. View the Aramex Shipping Label<\/strong><\/h3>\n\n\n\n

      Open the generated shipping label from the delivery order.<\/p>\n\n\n\n

      The label contains the shipment information required for processing the Aramex package.<\/p>\n\n\n\n

      \"aramex-shipping-label\"<\/a><\/figure>\n\n\n\n

      OTHER ODOO SHIPPING MODULES<\/strong><\/h2>\n\n\n\n