Overview
Aramex is a major Middle East courier with global reach via partner networks. The Automize Aramex connector covers shipment creation, tracking, rate calculation, pickup scheduling, and country/location lookups.
- Regions: HQ'd in UAE; strong in MENA region + global delivery. SA pickups + delivery through Aramex SA.
- Plans: Aramex business accounts. API access via account application.
Setting up the connection
Auth type: API Key.
- Apply for API access via aramex.com/developers.
- Receive Username + Password + Account Number + Account PIN + Account Entity.
- In Automize, open Settings → Connectors → Aramex → Add connection. Paste all credentials – connector passes them as ClientInfo on each request.
Find your credentials at https://www.aramex.com/developers/.
Rate limits
Aramex enforces conservative per-account limits – typically 1-5 TPS. Connector retries with backoff. Heavy operations should be batched via the bulk endpoints.
Data model
Shipping primitives:
Account ─── Shipments ── Tracking Events
Pickup Schedules
Locations (country + city lists for shipping)Available operations
7 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Calculate Rate | General | Calculate shipping rate |
| Cancel Pickup | General | Cancel a scheduled pickup |
| Create Shipment | General | Create a new shipment |
| Fetch Countries | General | Fetch supported countries |
| List Locations | General | List cities for a country |
| Schedule Pickup | General | Schedule a courier pickup |
| Track Shipment | General | Track a shipment |
Operations
Calculate Rate
Calculate shipping rate
| Parameter | Required | Type | Description |
|---|---|---|---|
Originaddress OriginAddress | Yes | text | |
Destinationaddress DestinationAddress | Yes | text | |
Shipmentdetails ShipmentDetails | Yes | text | |
Clientinfo ClientInfo | Yes | text |
Tips
- OriginAddress + DestinationAddress + ShipmentDetails (weight + dimensions).
- Returns rate in account currency + transit time estimate.
Cancel Pickup
Cancel a scheduled pickup
| Parameter | Required | Type | Description |
|---|---|---|---|
Pickupguid PickupGUID | Yes | text | |
Clientinfo ClientInfo | Yes | text |
Tips
- PickupGUID from Schedule response.
Create Shipment
Create a new shipment
| Parameter | Required | Type | Description |
|---|---|---|---|
Shipments Shipments | Yes | text | |
Clientinfo ClientInfo | Yes | text | |
Transaction Transaction | Yes | text | |
Labelinfo LabelInfo | Yes | text |
Tips
- Shipments[]: array – supports bulk creation.
- Transaction for client reference.
- LabelInfo: {ReportID, ReportType} for label format.
- Returns shipment ID + waybill number + base64 label.
Fetch Countries
Fetch supported countries
| Parameter | Required | Type | Description |
|---|---|---|---|
Clientinfo ClientInfo | Yes | text |
Tips
- Returns countries Aramex serves. Use for shipping country lookup.
List Locations
List cities for a country
| Parameter | Required | Type | Description |
|---|---|---|---|
Clientinfo ClientInfo | Yes | text | |
Countrycode CountryCode | Yes | text |
Tips
- CountryCode (ISO-2). Returns cities + postal codes for that country.
Schedule Pickup
Schedule a courier pickup
| Parameter | Required | Type | Description |
|---|---|---|---|
Pickup Pickup | Yes | text | |
Clientinfo ClientInfo | Yes | text | |
Transaction Transaction | Yes | text | |
Labelinfo LabelInfo | Yes | text |
Tips
- Pickup details + ClientInfo. Returns PickupGUID for cancellation.
Track Shipment
Track a shipment
| Parameter | Required | Type | Description |
|---|---|---|---|
Shipments Shipments | Yes | text | |
Clientinfo ClientInfo | Yes | text |
Tips
- Shipments[]: array of waybill numbers. Bulk track.
FAQ
- Test environment?
- Aramex provides UAT credentials separately. Test waybill numbers don't generate real shipments. Get UAT access via your account manager.
- Bulk shipments?
- Create Shipment accepts an array – up to 50 shipments per call. Each gets its own waybill in the response.
- International vs domestic – what changes?
- International needs customs declaration on shipment + HS codes. Domestic skips that. Aramex routes international via partner couriers (UPS, etc.) for some country pairs.