Add a Mirsal account
This guide walks through setting up a Mirsal account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Mirsal expects.
At a glance
Before you start
- A Mirsal account in good standing, plus its API credentials. The required fields are listed in All Mirsal 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 Mirsal
In the carrier picker, search for Mirsal and click Select. Carriyo creates a Mirsal 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.
Mirsal 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 Mirsal account details
Enter the required Mirsal account details, then click Next. Every field is documented in All Mirsal settings below, with examples and accepted values.
Fill in the Mirsal account details.
- 1Access key
- 2Secret key
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
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 Mirsal settings
Every field Mirsal exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
2 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Access keyRequired | Text | Mirsal API access key sent with every request. Example: BQ54OKZ0A292 |
| Secret keyRequired | Text | Mirsal API secret paired with the access key. Example: JNM84ZUCGNG3R6LY |
Account Details
1 fieldAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Name of Custom attribute for DriverOptional | Text | Carriyo custom attribute holding the driver ID, sent to Mirsal as the assigned driver; leave empty to skip. Example: If left empty then driver info not passed to Mirsal |
Capability notes
Behavior that follows from Mirsal's capabilities. Read these before you go live.