Add a Careem Express account
This guide walks through setting up a Careem Express account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Careem Express expects.
At a glance
Before you start
- A Careem Express account in good standing, plus its API credentials. The required fields are listed in All Careem Express 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 Careem Express
In the carrier picker, search for Careem Express and click Select. Carriyo creates a Careem Express 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.
Careem Express 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 Careem Express account details
Enter the required Careem Express account details, then click Next. Every field is documented in All Careem Express settings below, with examples and accepted values.
Fill in the Careem Express account details.
- 1Client ID
- 2Client Secret
- 3Webhook Verification Token
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
Careem Express sends shipment status by webhook, but it has to be registered on Careem Express's side. Copy the callback details from the account page and share them with your Careem Express 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 Careem Express settings
Every field Careem Express 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 |
|---|---|---|
| Client IDRequired | Text | OAuth client ID for the Careem Express API. Example: 678 |
| Client SecretRequired | Secret | OAuth client secret paired with the Client ID, used to obtain an access token. Example: 678 |
| Webhook Verification TokenRequired | Secret | Shared secret used to verify the authenticity of status webhooks Careem sends to Carriyo. Example: 678 |
Service Options
2 fieldsDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Delivery ActionOptional | Select | Default instruction sent to the Careem captain when the customer cannot be reached at the doorstep. Example: Select delivery action Leave at DoorCall MerchantReturn |
| Delivery TypeOptional | Select | Default Careem service or vehicle profile applied to shipments booked on this account. Example: Select delivery type LMD (Food deliveries)LMD_DELIVERY (Non-Food deliveries)LMD_TIERED (Food deliveries, distance-based pricing)LMD_CAR (Car/Truck, multiple packages)LMD_SANDBOX (Sandbox credentials)LMD_SPECIAL (Special occasions) |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Order ReferenceOptional | Select | Choose which Carriyo reference is sent to Careem as the order reference. Defaults to the shipment reference. Example: Shipment Reference (Default) Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Careem Express's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Careem Express has to register it on their side. Share the callback details from the account page with your Careem Express contact (see step 5) — a one-time setup.