Add an Aramex account

This page walks through the Aramex-specific steps. The setup steps common to every carrier (sidebar navigation, general settings, save) are described once on Add a carrier account. Open that page if you want the full walkthrough.

Before you start

• Aramex sandbox or live credentials. From Aramex you need: account number, account PIN, account country code, and account entity. You also need the product type and payment type that match the contract Aramex agreed with you.
• Decision: live or sandbox. A new carrier account can run against Aramex's sandbox before you flip it to live. Smoke-test in sandbox first, then turn on Live Connector.

1. Open the carrier accounts page

In the Carriyo Dashboard, open Settings in the left sidebar.

Under Carrier Management, click Carrier Accounts to open the list of existing accounts.

Click the + add icon in the top-right corner to start a new account.

2. Pick Aramex

Type aramex into the carrier picker's search field, then click Select on the Aramex result.

3. Enter the basics

Account name. A label that's meaningful to your ops team. Conventional patterns: aramex-uae, aramex-ksa. Keep it short and unique within the tenant.

Account country. The country the account operates from.

Click Next.

4. Enter your Aramex credentials

The next two screens collect the credentials Aramex issued for your account. Each appears on its own page; click Next after each.

Account number. The account number Aramex provides when you sign the contract. Aramex uses this number to identify the account on every API call.

Account PIN. A key tied to the account number. Aramex uses it to validate your identity for booking shipments and generating labels.

5. Set the account basics

The final wizard page collects four fields that describe how the account behaves with Aramex:

• Account country code. 2-letter ISO country code for the account (AE for UAE, SA for Saudi Arabia, etc.).
• Account entity. Identification code for the transmitting party. Aramex provides this value alongside the account credentials.
• Product type. Specifies the delivery features (priority, time sensitivity, whether the shipment is a document or non-document). Pick the product Aramex set up on your account.
• Payment type. How the shipment is paid for (typically Payable by Shipper or Payable by Consignee).

Click Next, then Go to Account to land on the configured account.

6. Configure the account

The newly created account opens on its detail page.

The general settings (active toggle, country, currency, sandbox/live) are configured the same way for every carrier. See Add a carrier account → General settings for the full walkthrough.

Default label

Aramex supports its own PDF label format. Pick Use Aramex PDF Label in the Default Label dropdown to use it as the default for shipments booked with this account.

Merchant access

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

Click Save in the top-right corner.

Aramex-specific concepts

Service Codes

Specify the Aramex service type used during delivery. Configure on the account detail page once you've picked the Product Type. Aramex provides the list of codes valid for your account.

Payment options

Based on Payment Type:

• C: Charge to account. Requires the relevant account number: ASCC for Shipper Account, ARCC for Consignee Account.
• P: Prepaid. One of CASH, ACCT (account), or PPST (prepaid stock).

Label Type

The template and format Aramex uses to generate the shipping label. Configure on the account detail page; defaults are usually appropriate.

Download Aramex Commercial Invoice

For cross-border shipments, set this to Yes so Carriyo includes Aramex's commercial invoice alongside the label. Set to No if you generate the invoice on your own side.

EORI and VAT numbers

For cross-border shipments, configure these on the account detail page:

• Consignee/Shipper EORI Number. Economic Operators Registration and Identification number.
• Consignee/Shipper VAT Number. Value Added Tax number.

These help Aramex with customs clearance.

Aramex references

Aramex uses two reference fields each for shipment, shipper, and consignee, plus one for the invoice number. Configure them on the account detail page so you can trace transactions back to Aramex's systems.

Callback registration

Aramex uses one-time callback setup. Carriyo registers the status-update webhook automatically when the account is created. No manual configuration needed on Aramex's side.