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 countries to enable Aramex shipping.
• Enable or disable COD service for Aramex.
• The admin can set the Aramex shipping method name that will be shown on Checkout.
• The available toggle button applies to calculating tax on shipping.
• The admin can track the shipment.

Required for Installation

• Bagisto v2.4.10

Steps to Installation

1. Extract and merge the package

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

2. Register service Provider

Open bootstrap/providers.php and add the provider class

use Webkul\Aramex\Providers\AramexServiceProvider;

return [
    // ...
    AramexServiceProvider::class,
];

3. Update composer.json

Add the following PSR-4 autoload rule under autoload.psr-4 in composer.json.

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

4. Dump Autoload

Run the dump-autoload command:

composer dump-autoload

5. Clear Optimization Cache

Clear the application cache using Artisan

php artisan optimize:clear

6. Run Aramex Installer

Run the installation command to publish configuration and assets

php artisan aramex:install

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

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

Status

• Toggle to enable or disable Aramex during checkout

Title

• The shipping method name shown to the customer on checkout

Description

• Short text shown beneath the method name on the shipping step

Sandbox Mode (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 Allowed Countries
• Specified Countries (based on selection above)

Ship To Countries

• Select allowed countries
• Aramex API validates service availability

All settings above are channel-based, so they can be saved separately for each sales channel selected at the top of the configuration page.

Account Credentials

Provide the following details:

• Aramex Account Country Code : Select the 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

Allowed Domestic Methods

Select available shipping services within the same country.

Allowed International Methods

Select services for cross-border shipping.

After setting up 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.