EasyStore integrates with Aramex Connect, one of the most popular shipping carriers in the Middle East, New Zealand, and Australia. This integration enables merchants to offer it as a reliable shipping option at checkout. After setup, they can manage shipping rates and generate shipping labels directly from EasyStore.

Before You Begin

To integrate Aramex Connect, ensure you have the following:

• An active Aramex Connect merchant account
• API credentials (Account Number and Password for both Live and Test modes)
• Shipping regions configured in EasyStore

Adding Aramex Connect As Your Shipping Carrier

1. Log in to your Joomla Dashboard and navigate to Components > EasyStore > Settings > Shipping.
   

   
   

   

2. If your region is already set up, click the three-dot icon next to it and select Edit. If you haven't set up your regions yet, you'll need to configure them first before you can add any shipping carriers.
   
   

   

3. Scroll down to the Add Shipping Carrier section and click on the Add Carrier button to open the list of available shipping providers.
   
   

   

4. Locate Aramex Connect in the list and click the Add button.
   
   

   

5. After completing the setup, click the "Back to the list" button. Aramex Connect will now be added to your store’s available shipping options. 
   
   

   

Enable the toggle switch to make Aramex Connect visible as a shipping option on the checkout page. 

Note: For the shipping carrier to appear at checkout, make sure your Store Address in General Settings is complete and includes the correct Country and ZIP Code.

Configuring Aramex Connect Shipping Carrier

After adding Aramex Connect as your preferred shipping carrier, locate it in the list and click the "Setup" button next to it.

This will open a pop-up window where you can configure the Aramex Connect settings for smooth integration with your store’s shipping process.

Title

Give your integration a title (e.g., "Aramex Connect"). This is a user-defined title that helps you identify this integration within your Joomla Dashboard.

Environment

Choose either "Live" or "Test" mode based on your needs. Select "Live" to process actual shipments in a production environment, or "Test" to simulate shipping for setup and testing purposes.

Sandbox Client ID/Production Client ID

Insert your Live or Test client ID you received while creating your Aramex Connect account.

Sandbox Client ID/Production Client Secret

Enter the Live or Test client password that you set when creating your Aramex Connect account.

Default Origin Postcode

Choose the default origin postcode. This is the postcode of the region you are operating or shipping from.

Default Origin Country

By default, the origin country is set to New Zealand. However, you can choose to change it.

Default Package Weight (kg)

Set the default package weight.

Default Package Length (cm)

Set the default package length.

Default Package Width (cm)

Set the default package width.

Default Package Height (cm)

Set the default package height.

Default Unit

By default, the unit of measurement is set to centimeters. However, you can choose to change it.

After configuring the Aramex Connect shipping carrier, click "Save and Close" to apply and save your changes.

Displaying Aramex Connect as the Shipping Method on the Checkout

Once Aramex Connect is selected as the shipping carrier, customers will be able to choose the shipping method based on the available services.

For the Aramex Connect shipping option to appear on the checkout page, customers must select a destination country that is within Aramex Connect's service area. If a country not supported by Aramex Connect is chosen, the shipping method will not be displayed. This ensures that only valid and applicable shipping options are shown based on the customer's selected location.

For example, if a customer selects Wellington as their city and enters the zip code 5016, the available pickup points corresponding to that location will be displayed in the pickup point list.

Please note that for Aramex Connect to appear as a shipping method during checkout, customers must select a city and provide a valid zip code.

How To Get API Key, Secret Key, and Account Number

To get your Client API Key, Secret Key, and Account Number, you will need to head over to the official aramexConnect Developers website (based on your region) and sign up for a DHL account or log in to an existing account. Then, you will have to follow the given steps:

• Navigate to Administration > API Keys and click on Create Key.
• Fill up the required fields and save.
• Now, in the Credentials section, you can find your generated Client ID and Client Secret.

To learn more about how to acquire your API credentials, please refer to the official aramexConnect documentation.