Add a Ajex account
This guide walks through setting up a Ajex account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Ajex expects.
At a glance
Before you start
- A Ajex account in good standing, plus its API credentials. The required fields are listed in All Ajex 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.
Open settings
Go to Carrier Accounts
Add a new carrier account
Pick Ajex
In the carrier picker, search for Ajex and click Select. Carriyo creates a Ajex account and opens the credential step.
Search for the carrier
Enter the basics
The first wizard page collects two fields:
- Account name
- A label that's meaningful to your team (e.g.
Ajex Saudi Arabia). 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 Ajex account details
Enter the required Ajex account details, then click Next. Every field is documented in All Ajex settings below, with examples and accepted values.
Fill in the Ajex account details.
- 1Customer Account
- 2Username
- 3Password
Fill in the Ajex account details.
- 1Express Type
- 2Pickup Method
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.
Go to the account page
View the account details
Set the default label format
Set up status callbacks
Ajex sends shipment status by webhook, but it has to be registered on Ajex's side. Copy the callback details from the account page and share them with your Ajex contact. This is a one-time setup.
Share callback settings with your carrier
Merchant access
On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.
Add merchants to this carrier account
All Ajex settings
Every field Ajex exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
3 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Customer AccountRequired | Text | Your AJEX customer account number, provided when your account is created. Example: NWF185606555507 |
| UsernameRequired | Text | Username for your AJEX API account. Example: acme_api |
| PasswordRequired | Secret | Password for your AJEX API account. Example: 678901 |
Account Details
3 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Express TypeRequired | Select | Select the AJEX service product used for your shipments. Example: Domestic e-Commerce Express - (AJEX DCE) Clearance to Door Express - (AJEX CCX)Domestic e-Commerce Express - (AJEX DCE)Domestic Express Service - (AJEX DES)International e-Commerce Express - (AJEX ICX)International Road Express - (AJEX IRX)International Express Service - (AJEX IXS) |
| Pickup MethodRequired | Select | Choose whether AJEX collects from your location or you drop off at an AJEX service centre. Example: Courier comes at sender location to pick the parcel. (PICKUP) Sender drops the parcel at AJEX Service Centers. (DROP_OFF)Courier comes at sender location to pick the parcel. (PICKUP) |
| IncotermsOptional | Select | Sets who pays duties and taxes on international shipments: consignee or shipper. Example: Consignee will pay duty charges. (DDU) Consignee will pay duty charges. (DDU)Shipper will pay the duty charges. (DDP) |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Ajex Order IdOptional | Select | Choose which Carriyo reference (order or shipment) is sent as the AJEX order ID. Example: Order Reference (Default) Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Ajex's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Ajex has to register it on their side. Share the callback details from the account page with your Ajex contact (see step 5) — a one-time setup.