Add a Aramex account

Required roles:

AdminAccount Manager

Updated June 20, 20264 min read MENAExpress aramex.com

This guide walks through setting up a Aramex account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Aramex expects.

At a glance

Cross-border

International

Returns

Supported

Shipping rates

Live carrier rates

Document upload

Not supported

Real-time status

Push · one-time setup

Labels

PDF

Before you start

A Aramex account in good standing, plus its API credentials. The required fields are listed in All Aramex settings below.
Decide the account country and the default service and label format this account uses.

Open the carrier accounts page

In the Carriyo Dashboard, open Settings in the left sidebar. Under Carrier Management, choose Carrier Accounts, then click the + add icon to start a new account.

Pick Aramex

In the carrier picker, search for Aramex and click Select. Carriyo creates a Aramex account and opens the credential step.

Enter the basics

The first wizard page collects two fields:

Account name: A label that's meaningful to your team (e.g. Aramex United Arab Emirates). Keep it short and unique.
Account country: The country this account ships from. Determines the routes and services available.

Fill in the account name and country.
1Account Name
2Account Country

Enter your Aramex account details

Enter the required Aramex account details, then click Next. Every field is documented in All Aramex settings below, with examples and accepted values.

Enter aramex account number.
1Aramex Account Number

Fill in the Aramex account details.
1Account Country Code
2Account Entity
3Product Type
4Payment Type

Configure the account

The new account opens on its detail page. General settings work the same way for every carrier: the Active toggle, default label and service, and currency. See Add a carrier account for the full reference to these shared settings — default label, merchant access, going live, and common mistakes.

Merchant access

On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.

All Aramex settings

Every field Aramex exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.

Authentication

2 fields

Account identifiers and API credentials used to connect to the carrier.

Field	Type	What to enter
Account NumberRequired	Number	Your Aramex shipper account number, found on your Aramex account documents or in the Aramex portal. Example: `90241`
Account PINRequired	Secret	The PIN paired with your Aramex account number, supplied by Aramex alongside your account. Example: `661761`

Account Details

12 fields

Account-level configuration and defaults applied to shipments.

Field	Type	What to enter
Account Country CodeRequired	Text	Two-letter ISO country code of your Aramex account (e.g. AE), supplied by Aramex. Example: `AE`
Account EntityRequired	Text	Aramex three-letter station/entity code for your account (e.g. DXB), supplied by Aramex. Example: `QKO` Ask your Aramex contact if you're unsure of your entity code.
Product TypeRequired	Select	Aramex product/service code applied to shipments on this account, setting features such as priority, time-sensitivity, and document vs non-document. Required. Example: Standard Service (CDS) Standard Service (CDS)Same Day Document (SMD)Same Day Parcel (SMP)Overnight Parcel (ONP)Overnight Document (OND)Priority Document Express (PDX) Aramex provides the product codes valid for your account.
Payment TypeRequired	Select	Who pays the Aramex freight charges: shipper, consignee or a third party. Required. Example: Payable by Shipper (P) Payable by Shipper (P)Payable by Consignee (C)Payable by 3rd Party (3) Determines which Payment Options apply.
Payment OptionsOptional	Select	The Aramex settlement method. Which values apply depends on the Payment Type. Example: Cash (CASH) Cash (CASH)Account (ACCT)Prepaid Stock (PPST)Credit (CRDT)Approve Receiver Collect Charge (ARCC)Approve Shipper Collect Charge (ASCC) For Payment Type Consignee (C), choose ASCC or ARCC. ASCC then requires the Shipper Account Number, and ARCC requires the Consignee Account Number. For Shipper (P), choose CASH, ACCT, or PPST.
Service CodesOptional	Multi	Optional Aramex value-added services (e.g. signature required, insurance) applied to every shipment. Example: Select a Service Codes First Delivery (FIRST)Free Domicile (FRDM)Hold for pick up (HFPU)Noon Delivery (NOON)Signature Required (SIG)Signature Required (SIGR)
Label TypeOptional	Select	Aramex label report ID setting the label size, format (PDF/PNG) and variant (COD, no-weight) returned. Leave blank to use the default label type configured in Aramex. Example: 9830 Label 4 * 6 (No Company Name) PDF 9201 Label 4 * 6 PDF9202 Label 4 * 6 (A4) PDF9203 Label 4 * 6 PNG9204 Label 4 * 6 (A4) PNG9205 Label 4 * 6 Horizontal Barcode PDF9206 Label 4 * 6 Horizontal Barcode PNG
Download Aramex Commercial Invoice (Cross Border Shipments)Optional	Select	For cross-border shipments, set to Yes so Carriyo includes the Aramex-generated commercial invoice with the label. Set to No if you generate the invoice yourself. Example: Download Aramex Invoice YesNo
Consignee EORI NumberOptional	Text	Default consignee EORI number for cross-border customs, used when the order has no EOR registration number.
Shipper EORI NumberOptional	Text	Default shipper EORI number for cross-border customs, used when the order has no EOR registration number.
Shipper VAT NumberOptional	Text	Default shipper VAT/tax registration number sent on cross-border shipments for customs.
Consignee VAT NumberOptional	Text	Default consignee VAT/tax registration number sent on cross-border shipments for customs.

Reference Mappings

7 fields

Map Carriyo fields to the reference values the carrier expects.

These carry your own references so you can reconcile Aramex transactions later.

Field	Type	What to enter
Shipment Reference 1Optional	Select	Choose one of: Example: Order Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name
Shipment Reference 2Optional	Select	Choose one of: Example: Shipment Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name
Shipper Reference 1Optional	Select	Choose one of: Example: Order Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name
Shipper Reference 2Optional	Select	Choose one of: Example: Shipment Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name
Consignee Reference 1Optional	Select	Choose one of: Example: Order Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name
Consignee Reference 2Optional	Select	Choose one of: Example: Shipment Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name
Invoice Number ReferenceOptional	Select	Choose one of: Example: Alternate Reference (Default) Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name

Capability notes

Behavior that follows from Aramex's capabilities. Read these before you go live.

Real-time tracking

Shipment events (shipped, in_transit, delivered…) reach Carriyo automatically. No polling, and nothing to set up on your side.

Next steps

Manage account settingsLabels, services, and the Active toggle.Set up costing profilesOverride carrier rates with your own.Add a custom carrierConnect a private fleet or unlisted carrier.Browse all carriersCompare capabilities across the directory.

Was this page helpful?