ARAMEX OPENCART EXTENSION · Add items to cart and proceed to checkout 1 View the cost of delivery...

ARAMEX OPENCART EXTENSION User Manual for Versions 2.0+

ARAMEX OPENCART EXTENSION – USER MANUAL FOR VERSIONS 2.0+

aramex.com 1

1. OVERVIEW

Welcome to the user manual for the Aramex OpenCart Extension!

This Extension enables direct communication between the OpenCart store admin panel and

Aramex shipping and tracking systems.

The sections below guide you through all aspects of using the Aramex OpenCart Extension.

ARAMEX

OPENCART

EXTENSION OpenCart store

admin panel

Aramex shipping and

tracking systems

https://www.aramex.com/


aramex.com 2

2. WHAT’S IN THIS DOCUMENT

This manual explains how to work with the Aramex OpenCart Extension.

understand

how the extension works

configure extension settings

for Aramex shipments

understand the process of

order checkout

prepare Aramex shipments based

on orders

calculate shipping rate

for an Aramex shipment

schedule shipment pickup

by Aramex courier

track an Aramex shipment

download an Aramex

shipment label

handle an Aramex

return shipment



aramex.com 3

3. HOW IT WORKS

This graph illustrates the Aramex OpenCart Extension usage from different points of view and shows the

events that take place after one another.

manage

prepared

shipments

view

LABEL schedule

PICKUPS

1 by 1 or in

bulk

IT DEPARTMENT CUSTOMER ADMINISTRATOR

place

ORDER

TRACK

shipment

RETURN

shipment

calculate

RATE

prepare

SHIPMENT

automatically manually 1 by 1 or in bulk

TRACK

shipment

manage

RETURNS

INSTALL

extension

configure

SETTINGS

for creating

shipment

for order

checkout



aramex.com 4

1. First, the store’s tech department installs the Aramex OpenCart Extension.

Version 2.0 or above of the Aramex OpenCart Extension (Aramex Module) is available for installation

at opencart.com.

2. Next, the tech department needs to configure the Aramex OpenCart Extension.

3. During order checkout, store customers can view the cost of shipping with Aramex and

select Aramex as a shipping method.

4. After a store customer places an order, a store administrator can prepare Aramex shipment and

check the shipping cost.

5. Store administrator can then download the shipment label, for example, to print it.

6. Aramex number is assigned to the shipment. Store administrator can use this number to track the

shipment at any further stage until the shipment is delivered.

Store customer can track the shipment too, at aramex.com.

7. When one or more shipments are prepared, the store administrator can request Aramex courier to

pick up the ordered items.

8. If the store customer decides to return the delivered items, the store administrator then needs to

process the request to return the order.


https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=23345&filter_search=aramex


https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=23345&filter_search=aramex


aramex.com 5

4. EXTENSION SETTINGS

The first thing you need to do after installing the Aramex OpenCart Extension is to configure basic

information: account details, shipping methods, and more.

This configuration speeds up the preparation of Aramex shipments.

To configure Extension settings:

1. In the OpenCart store admin panel, go to Extensions.

2. Under Choose the extension type, select Shipping.



aramex.com 6

3. Under Shipping, next to Aramex, click Edit.

4. Configure these settings:

Account

information

Service

configuration

Shipper

details

Default service

configuration for

front end

4.1 Account information

When configuring the Aramex OpenCart Extension settings, start by providing your Aramex account

details.

Account

information

Service

configuration

Shipper

details

Default service

configuration for

front end

Note: You can view your account details at aramex.com > My Accounts page. For more information, see the aramex.com help

system.


https://www.aramex.com/accounts

https://www.aramex.com/help/Content/Topics/Dashboard/Accounts/Manage_accounts.htm

https://www.aramex.com/help/Content/Topics/Dashboard/Accounts/Manage_accounts.htm


aramex.com 7

Fill in the following account information.

• Email and Password – your Aramex account credentials, used for authentication to Aramex server

(for example, during shipment preparation or rate calculation).

• Account Pin – number used for Aramex account activation. If you do not know your PIN number,

you can request it at aramex.com.

• Account Number – unique account ID (will be used during shipment preparation).

• Account Entity – international code of the city where the account is created (for example, Bombay is

BOM, Dubai is DXB, and so on).

• Account Country Code – international 2-letter abbreviation of the country name (for example, India

is IN, United Arab Emirates is AE, and so on).

4.2 Service configuration

When configuring the Aramex OpenCart Extension settings, define and test the Aramex delivery methods

and additional services for both domestic and international shipments.

Account

information

Service

configuration

Shipper

details

Default service

configuration for

front end

Important: Make sure that you select the methods and services as defined in the business agreement between Aramex and your

store.

Extension settings

Shipment preparation


https://www.aramex.com/accounts


aramex.com 8

Configure the following settings.

• Test Mode:

• No – you are working with real shipments.

• Yes – you are testing shipment methods and services (shipments are not actually sent).



aramex.com 9

• Report ID – determines the type and content of shipment labels (same for all shipments).

Depending on the agreement between your store and Aramex, enter one of the following:

• 9201 – prepaid shipment is the agreed payment method for shipment delivery.

• 9729 – COD shipment is the agreed payment method for shipment delivery.

You can download a shipment label after you create the shipment. For more information,

see Shipment label.

• Select the Methods and Additional services for shipment delivery (must be defined according to the

agreement between your store and Aramex).

For information about shipping methods and services for order checkout, see Default service

configuration for front end.

• Weight Class – unit for measuring the weight of shipped items (select Kilogram or Pound).

• Tax Class – additional tax applied to shipments depending on shipment cost and the country of

shipment destination.

• Geo Zone – country or group of countries for which the Aramex delivery will be available during

order checkout (depends on the country of destination selected by a store customer).

• Status – when set to Enabled, shows Aramex as a shipping method during order checkout.

Otherwise, the Aramex is hidden from delivery methods available for a store customer.

• Sort Order – defines where Aramex appears among other shipping methods during order checkout

(for example, enter 1 to show Aramex as the first shipping method, 2 as the second one, and so on).


Extension settings



aramex.com 10

4.3 Shipper details

When configuring the Aramex OpenCart Extension settings, provide your store information.

Account

information

Service

configuration

Shipper

details

Default service

configuration for

front end

Shipper details are filled automatically when an Aramex shipment (regular or return) is prepared, but can

be edited if necessary. For more information, see Shipper/receiver details.

Extension settings




aramex.com 11

4.4 Default service configuration for front end

When configuring the Aramex OpenCart Extension settings, you need to define additional delivery

options, mostly related to order checkout.

Account

information

Service

configuration

Shipper

details

Default service

configuration for

front end

Define the following settings.

• Auto Create Shipment – automatically prepares an Aramex shipment as soon as a store customer

pays for the order. If this option is set to No, you need to manually prepare shipments.

• Live Rate Calculation – automatically calculates shipping rate depending on the order details filled by

a store customer, including shipment item destination, weight, and other.

Order checkout Extension settings



aramex.com 12

Note: The Live Rate Calcuation option is related to order checkout only and does not impact the rate calculation option

available for a store administrator.

• Default Rate – sets a standard shipping rate for all Aramex shipments. In other words, shipping cost

is always the same, regardless of order destination, weight, and other.

Important: If you are using the Default Rate option, make sure that Live Rate Calculation is set to No.

• Allowed Domestic Methods – shipping methods available for a store customer during order

checkout if the country of shipment origin is the same as the country of shipment destination.

These shipping methods can be different from the shipping methods for preparing a shipment

(defined in Service configuration).

• Allowed Domestic Additional Services – extra shipping services available for a store customer by

Aramex during order checkout if the country of shipment origin is the same as the country of


• Allowed International Methods – shipping methods available for a store customer during order

checkout if the country of shipment origin is different from the country of shipment destination.

These shipping methods can be different from the shipping methods for preparing a shipment

(defined in Service configuration).

• Allowed International Additional Services – extra shipping services available for a store customer by

Aramex during order checkout if the country of shipment origin is different from the country of


After all the Extension settings are configured, check if the Aramex delivery method works as expected

during order checkout. L



aramex.com 13

5. ORDER CHECKOUT

This graph illustrates how the store customers interact with the Aramex OpenCart Extension.

Add items to cart and

proceed to checkout

1

View the cost of delivery

and select Aramex as the

shipping method 2

The store customer needs to…

Choose the payment type,

shipping method, and

additional services, if any 3

Get order confirmation and

Aramex tracking number 4



aramex.com 14

Here’s how the Aramex OpenCart Extension settings impact order checkout.

API Location Validator

this setting checks if

country, city, and

ZIP code match in

the store customer’s

shipping address

(by default, is set

to No)

Test Mode, Geo Zone, Status, Sort Order

these settings

define if Aramex

appears among

shipping methods

+ its position among

other shipping

methods

Live Rate Calculation, Default Rate

these settings

control if Aramex

shipping fee is

standard or

calculated based on

package destination

and weight

Methods, Additional Services

these settings

define the delivery

type and services

available for

domestic and

international

shipping



aramex.com 15

6. PREPARING ARAMEX SHIPMENT

When a store customer creates an order, it gets the Pending status. After this, you are expected to review

the order and prepare an Aramex shipment.

Note: You can also configure autocreation of Aramex shipments. In this case, you only need to schedule their pickup.

To create an Aramex shipment:

1. In the OpenCart store admin panel, go to Orders.

2. Next to the needed order, click View.



aramex.com 16

3. Click Aramex Shipment.

4. Complete the following details:

• Billing account

• Shipper/receiver details

• Shipment information

5. Click Create Shipment.



aramex.com 17

The order status is changed to Processing, and an Aramex shipment number is generated.

The store customer who placed the order receives the Aramex shipment number by email and can use

this number to track the shipment on the Aramex website. For information on how to track an Aramex

shipment using the Aramex OpenCart Extension, see Tracking shipments.

Your next step is to schedule pickup for one or more prepared shipments.

6.1 Billing account

When preparing an Aramex shipment, in Billing Account, enter the following details.

• Account – number of your Aramex account (autofilled from Account information).

• Payment – account from which Aramex delivery cost will be paid.

• Shipper Account (select this option if this is NOT a return order) – your store is shipping to the

store customer who placed the order.

Shipping expenses are billed to your store account (according to the agreement between your

store and Aramex).

Note: Cost of shipping by Aramex depends on shipment weight, destination, and other details. For information on

how to calculate an exact rate, see Rate calculation.



aramex.com 18

• Consignee Account (use only for return orders) – customer who placed the order is shipping to

your store, and shipping expenses are billed to the customer. For more information, see Return

orders.

• Third Party – another company (for example, a shop that acts as your contractor) is shipping to

your store, and shipping expenses are billed to that company.

Next, you need to fill in Shipper/receiver details.

6.2 Shipper/receiver details

After you specify the billing account, the system autofills the shipper/receiver details.

• Shipper Details – contact info of the account from which the shipment is sent.

• Receiver Details – contact info of the account to which the shipment is sent.

This table illustrates the dependency between the Billing Account > Payment field value and

Shipper/Receiver Details.

Billing Account > Payment Shipper Details Receiver Details

Shipper Account Info of your store (autofilled from Account

information)

Info of the store customer who created the

order (autofilled from the order form)

Consignee Account Info of the store customer who created the

order (autofilled from the order form)

Info of your store (autofilled from Account

information)

Third Party Info of the third-party company (needs to be

filled manually)

Info of your store (autofilled from Account

information)

Next, you need to fill in Shipment information.



aramex.com 19

6.3 Shipment information

During preparation of Aramex shipment, most shipment info is autofilled from the order form. You may

need to configure final shipment details, such as payment options, delivery method, etc.

Fill in the following shipment details:

• Total weight – sum weight of all items to be shipped (preferred unit of measurement – kilogram or

pound – can be defined in Service configuration).

• Reference – order number assigned by your store.

• Product Group – type of shipment:

• Domestic – country in Shipper Details is the same as the country in Receiver Details.

• International Express – country in Shipper Details is different from the country in Receiver Details.

• Service Type – preferred delivery method (available methods may differ depending on the selected

Product Group).

This service type does not necessarily need to match the delivery method selected by a store

customer in the order form.

Important: If Payment Option is Cash, then Service Type should be Cash on Delivery.

If the needed service type is not on the list, check Service configuration.

• Additional Services – one of the additional services offered by Aramex (the available services may

differ depending on the selected Product Group).



aramex.com 20

If the needed service type is not on the list, check Service configuration.

• Payment Type – method of payment, depends on the Billing Account > Payment value:

• Prepaid – select this type if Payment is Shipper Account.

• Collect – select this type if Payment is Consignee Account.

• Third Party – select this type if Payment is Third Party.

• Payment Option – method of payment selected by a store customer in the order form:

• Cash – shipping cost is paid as cash upon shipment delivery.

• Account – shipping cost is billed to the account selected in Billing Account > Payment after

shipment delivery.

• Prepaid Stock – shipping cost was already paid (for example, within standard monthly payment

from your store to Aramex for a specific limit of shipments/month).

• Credit – shipping cost is paid online using a credit card.

• COD Amount – total amount to be paid by the shipment receiver. Currency for specifying the COD

amount is defined in the Currency field.

Important: You need to specify COD Amount if Service Type is Cash on Delivery.

• Custom Amount – cost of releasing the shipment from the customs for international shipping.

Currency for specifying customs COD amount is defined in the Currency field.

Important: You need to specify customs amount only for dutiable service types: Priority Parcel Express, Deferred Parcel

Express, and Ground Parcel Express.

• Currency – 3-letter currency code for one of the following:

• COD Amount (in case of domestic shipping). Use the same currency as for Items Price.

• Custom Amount (in case of international shipping). For example, INR for Indian Rupee, AED for

United Arab Emirates Dirham, and so on.

• Comment – any additional shipping instructions (for example, fragile material). This comment will be

added as a remark on the shipment level.

• Foreign Shipment No – additional number that can be used for tracking the shipment (besides

Aramex tracking number). Mostly used for international shipments.

• Filename – any documents important for shipping (for example, commercial invoice).

• Description – specifications of all ordered items (autofilled from the order form).

• Items Price – total cost of all ordered items (autofilled from the order form). Does not include any

additional changes (shipping charges, customs changes, or other). Currency depends on whether the

ordered items are domestic or international.

Next, you need to confirm shipment preparation.

Note: Select Notify Customer by email if you want the store customer to receive order confirmation.



aramex.com 21

7. RATE CALCULATION

After you prepare an Aramex shipment, you can use the Rate Calculator tool to determine the exact cost

of Aramex shipment delivery.

The shipping cost mainly depends on shipment origin and destination, weight, and other. Another thing

that may influence shipping cost is who pays for shipping – this is defined in Billing Account > Payment.

Note: The shipping rate – standard or calculated case by case – is also shown to a store customer during order checkout. For

information about rate calculation for order checkout, see Order checkout.

To calculate Aramex shipping rate:



3. Click Aramex Shipment, and then click Rate Calculator.

4. Edit the details autofilled based on the information that was entered during shipment preparation,

and fill in more details as needed.



aramex.com 22

Note: The changes that you make during rate calculation do not affect the data filled during shipment preparation.

5. Click Calculate.

You can view the cost of Aramex delivery billed to the shipment sender.

Important: If the Payment Option for the shipment is Cash, then in COD Amount, you need to enter the sum of Items Price

plus the calculated rate.



aramex.com 23

8. PICKUPS

After one or more Aramex shipments are prepared, you can notify Aramex that these shipments are

ready for pickup.

Depending on your plugin configuration, you may also have the option to schedule pickup of multiple

orders that need to be picked up at the same time and location and delivered to the same destination.

Important: You can schedule pickup for an order only if the Aramex shipment was created for this order (order status is

Processing). For more information, see Preparing Aramex shipment.

To schedule pickup:

1. Do one of the following:

Schedule pickup for one shipment:

a. In the OpenCart store admin panel,

go to Orders.

b. Next to the needed order, click View.

c. In the shipment details window, click

Aramex Shipment, and then click

Schedule Pickup.

Schedule pickup for multiple shipments:

a. In the OpenCart store admin panel, go to

Aramex Bulk Schedule Pickup.

b. Select the needed orders, and then

click Create.



aramex.com 24

2. Under Pickup Details, edit the details autofilled based on the information that was entered during

shipment preparation, and fill in more details as needed.

Important: If you selected Bulk Schedule Pickup in step 1, some of the pickup details are on top – Location, Date, Vehicle

Type, and Ready Time / Closing Time. This information needs to be the same for all selected orders.

Other pickup details – Reference 1, Product Group, etc. – can differ for every order.

• Location − exact spot where the Aramex courier can pick up shipments.

• Date − date when the Aramex courier should pick up the shipment (maximum 7 days from the

current date).

• Reference 1 − order number assigned by your store.

• Product Group – type of shipment:

• Domestic – country of shipment origin is the same as the country of shipment destination.

• International Express – country of shipment origin is different from the country of shipment

destination.

• Payment Type − method of payment (depends on the Billing Account > Payment value defined

during shipment preparation):




• Number of Pieces − quantity of shipped items.

• Vehicle Type − transportation method for the ordered items (select Medium or Large).

• Ready Time, Closing Time − time interval during which Aramex courier can pick up the shipment

(should be within the Aramex business hours).

• Status − defines if the shipment is ready for pickup at the moment (always select Ready).

• Product Type – preferred delivery method (corresponds to Service Type defined during

shipment preparation).

• Weight – total weight of all shipped items.

• Number of Shipments − number of iterations for pickup (for example, enter 1 if the courier can

pick up the shipments in one go; or, enter 2 if the courier needs to load the vehicle, deliver the

shipment, and then come back again to pick up the remaining items).

3. Under Shipment Destination, edit the details autofilled based on the information that was entered

during shipment preparation, and fill in more details as needed.



aramex.com 25

In Comments, add instructions for the Aramex courier.

Note: Select Notify Customer by email if you want the store customer to receive a notification about the pickup.

4. Click Submit.

After the pickup is submitted, you get an Aramex reference number that you and the store customer

can use to track shipment.



aramex.com 26

9. TRACKING SHIPMENTS

You can track the shipment delivery status on the store website by using the Aramex shipment number

(also called tracking number or reference number).

Aramex shipment number is also sent to the store customer, so they can track the shipment delivery

status on the Aramex website. Alternatively, the store customer can use the additional tracking number

that you entered during shipment creation (Foreign Shipment No).

To check shipment status:



3. Click Aramex Shipment.

4. Click Schedule Pickup, and then click Track this shipment.

Note: The tracking option is not available for orders with the Canceled status.



aramex.com 27

Tracking Description illustrates the shipment status.

This diagram illustrates the key shipment statuses.

your shipment is at the

shipper’s facility

picked up from shipper

record created shipment was registered in the

Aramex system

received at origin facility shipment arrived at the Aramex

warehouse

in transit

…

held in customs (for international shipments)

shipment is undergoing customs clearance

receiver’s address is incorrect/incomplete,

cannot contact the receiver, etc. on hold

out for delivery shipment is on the way to you

…

…

held for consignee pickup /

pickup scheduled at locker

shipment is waiting for you in an

Aramex outlet or locker of your choice

shipment was delivered / collected /

picked up

…



aramex.com 28

10. SHIPMENT LABEL

Shipment label contains shipment info (pickup date, shipper details, tracking number, and more) and is

sent to the store customer along with the airway bill number after shipment creation.

Labels for different shipments may look different and include different information depending on the

payment method (cash or prepaid), as well as other shipment details. For information on how to define

the label type, see Service configuration.

To download a shipment label:



3. Click Aramex Shipment, and then click Print Label.

The label is automatically downloaded in a PDF format.



aramex.com 29

Label example.



aramex.com 30

11. RETURN ORDERS

If a consignee decides to return an Aramex shipment, you need to create the corresponding request.


2. Next to the needed order, click View, and then click Aramex Shipment.

3. In the return details window, make sure that the following settings are configured.



aramex.com 31

• Payment is set to Consignee Account.

After this, the system automatically switches Shipper Details and Receiver Details (consignee

becomes the sender).

• Payment Type is set to Collect.

4. Complete the remaining shipment information.

5. Click Return Shipment.

The order status is changed to Processing, and a new reference number is generated.

The store customer who placed the order receives this tracking number by email and can use this

number to track the shipment on the Aramex website. For information on how to track an Aramex

shipment using the Aramex OpenCart Extension, see Tracking shipments.



aramex.com 32

12. FAQ

Here are the key questions about the Aramex OpenCart Extension.

Question Answer Related topics

What Methods and Service types

should I select?

This information is specified in the business agreement between

your store and Aramex.

Service configuration

Why is Total weight not specified

properly?

Aramex OpenCart Extension only accepts the KG and LB weight

units. If the item weight was specified in other weights units

during order checkout, make sure that during shipment

preparation, you convert that weight to KG or LB.

Shipment information

Return orders

What Payment Type do I need to

select?




What does ERR48 – Consignee

name is required error mean?

The Company field is required.

What does ERR48 – Invalid

combination selection for

services/product type for (COD,)

error mean?

If you specified the COD Amount, check that Additional Services

is set to Cash on Delivery.


ARAMEX OPENCART EXTENSION · Add items to cart and proceed to checkout 1 View the cost of delivery...

Documents

Transcript of ARAMEX OPENCART EXTENSION · Add items to cart and proceed to checkout 1 View the cost of delivery...