Help CenterHelp Center / Shipping and couriers · How-to
Link your Aramex account so you can book parcels, print labels and track them from your orders.
Aramex supports live rates, labels, cash on delivery, pickup booking with a shipment, and tracking. It has no status webhook, pincode check, manifest or return pickup; see the courier comparison.
An Aramex parcel has no Cancel button: cancel the AWB with Aramex.
Ask your Aramex account manager or integration team for API access to your account number. A test account has its own credentials.
Go to Delivery › Couriers, select Add courier and choose Aramex.
| Field | What to enter |
|---|---|
| API username, API password, Account PIN | Required. Stored encrypted |
| Account number | Required. Shipments are billed to it |
| Account entity | Required. The 3-letter Aramex branch code |
| Account country code | Required. 2 letters |
| Environment | Live or Test (Aramex test system). Test credentials work only with Test |
| Currency | Required. 3-letter code of your shop's prices; used for COD amounts, customs values and rate quotes |
| Field | What to enter |
|---|---|
| Product group | Automatic (Domestic within the country, Express abroad), Always Domestic (DOM) or Always Express (EXP) |
| Domestic product type | Used for Domestic shipments |
| International product type | Used for Express shipments. Parcel types need a declared value for customs |
| Field | What to enter |
|---|---|
| Pickup contact name | Required. Printed on the label as the shipper |
| Pickup company name | Defaults to the contact name |
| Pickup phone | Required |
| Pickup address | Required. At least 4 characters |
| Pickup city | Required. As Aramex spells it |
| Pickup postcode | Leave empty where there are no postcodes. Needed for live rates |
| Pickup country code | Required. 2 letters. Shipments to the same country are Domestic, others Express |
| Pickup ready from, Pickup closing time | HH:MM, 24-hour. Default 10:00 and 18:00. Used when you request a pickup with a shipment. A pickup requested less than an hour before closing is booked for the next day |
| Default email | Required. The shipper email, and the email for customers who have none |
Set the shared options described in Couriers, select Add courier, then Test connection. A pass reads "Connected: Aramex accepted the login." It then tries a rate from your pickup address to itself, which proves the account number, PIN and entity.
More in Troubleshooting. COD payouts are recorded by hand or imported; see COD remittances.