Add a Ajeek account
This guide walks through setting up a Ajeek account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Ajeek expects.
At a glance
Before you start
- A Ajeek account in good standing, plus its API credentials. The required fields are listed in All Ajeek 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 Ajeek
In the carrier picker, search for Ajeek and click Select. Carriyo creates a Ajeek 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.
Ajeek 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 Ajeek account details
Enter the required Ajeek account details, then click Next. Every field is documented in All Ajeek settings below, with examples and accepted values.
Fill in the Ajeek account details.
- 1API key
- 2User ID
- 3Vendor ID
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
Ajeek sends shipment status by webhook, but it has to be registered on Ajeek's side. Copy the callback details from the account page and share them with your Ajeek 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 Ajeek settings
Every field Ajeek 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 |
|---|---|---|
| API keyRequired | Secret | API key issued by Ajeek to authenticate requests. Example: 678 |
| User IDRequired | Text | Your numeric Ajeek user ID, provided when your account is created. Example: 678 |
| Vendor IDRequired | Text | Your numeric Ajeek vendor ID, provided when your account is created. Example: 678 |
Account Details
1 fieldAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Destinations & Branch CodesOptional | Text | Map each destination city to the Ajeek branch ID that handles it; the branch is selected per shipment from the drop-off city. Example: {"WRQQNU":"8640","EVLNQU":"8640"… |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Ajeek Billing Reference NumberOptional | Select | Choose which Carriyo reference (order or shipment) is sent as the Ajeek billing reference number. Example: Order Reference (Default) Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Ajeek's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Ajeek has to register it on their side. Share the callback details from the account page with your Ajeek contact (see step 5) — a one-time setup.