User Guide for Laravel eCommerce Aramex Shipping

• Fully custom admin configured module based on all low key settings.
• Enable or disable Aramex shipping on checkout.
• Enable or disable Aramex testing.
• Select specific or all channels to enable Aramex shipping.
• Select specific or all countries to enable Aramex shipping.
• Enable or disable COD service for Aramex(Will be usable with future versions of this module).
• The admin can set the Aarmex shipping method name that will be shown on Checkout.
• Tax rate can be calculated based on Aarmex shipping.

• Bagisto Version: v2.4.1

Step 1: Extract Package

Unzip the extension package and merge the packages folder into your project root.

Step 2: Register Service Provider

Go to: bootstrap/providers.php file and add the following line under ‘providers’

use Webkul\Aramex\Providers\AramexServiceProvider 

return 
[
 AramexServiceProvider::class,
 ]

Go to the composer.json file and add the following line under ‘psr-4’

"Webkul\\Aramex\\": "packages/Webkul/Aramex/src"

Run these commands below to complete the setup:

composer dump-autoload

php artisan optimize:clear

php artisan vendor:publish --provider=Webkul\Aramex\Providers\AramexServiceProvider --force

After the successful installation of the module, the admin will have to configure the module.

Go to:
Admin Panel → Configure → Sales → Shipping Methods

Next, you need to configure the Aramex Settings. Below is the field information that you need to provide:

Enable On Checkout

• Toggle to enable or disable Aramex during checkout

Sandboxing (Testing Mode)

• Enabled: Uses Aramex test credentials
• Disabled: Uses live credentials

Weight Unit

• Supported units:
  • Kilograms
  • Pounds 

Calculate Tax

• Enabled: Applies tax on Aramex shipping, adds it to totals, and shows it in order summary.
• Disabled: No tax is applied; shipping remains tax-free.

Enable COD Service

• It will allow Aramex to collect cash on your behalf from your customers.

Ship To

• All Countries
• Specified Countries (based on selection above)

Ship To Countries

• Select allowed countries
• Aramex API validates service availability

Ship To Channels

• Select specific sales channels

Ship To Applicable Channel

• All Channels
• Specified Channels

Account Credentials

Provide the following details:

• Account Country Code : Select  country from the dropdown
• Account Entity: Code identifying the specific Aramex branch or region handling your account.
• Account Number : Unique customer account number assigned by Aramex.
• Username : Login username used for Aramex API authentication.
• Password : Secure password linked to your Aramex account for API access.
• Account PIN : Here the key has to be provided that is associated with your Aramex account to validate your identity

Domestic Methods

Select available shipping services within the same country.

International Methods

Select services for cross-border shipping.

After the setup of the Laravel eCommerce Aramex Shipping method, the customer can easily use this shipping method for the purchase.

1. Add Product to Cart

Customer adds items and proceeds to checkout.

2. Enter Billing Address

• Must include valid ZIP/Postal Code
• Invalid details → Aramex option will not appear

3. Select Shipping Method

Aramex shipping option appears with calculated cost.

4. Payment Selection

Choose preferred payment method (COD or others).

5. Place Order

Review details and confirm order.