Add a WIMO account
This guide walks through setting up a WIMO account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field WIMO expects.
At a glance
Before you start
- A WIMO account in good standing, plus its API credentials. The required fields are listed in All WIMO 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 WIMO
In the carrier picker, search for WIMO and click Select. Carriyo creates a WIMO 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.
WIMO 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 WIMO account details
Enter the required WIMO account details, then click Next. Every field is documented in All WIMO settings below, with examples and accepted values.
Enter api key.
- 1Api key
Select enable/disable wimo create task api.
- 1Enable/disable Wimo create task API
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
WIMO sends shipment status by webhook, but it has to be registered on WIMO's side. Copy the callback details from the account page and share them with your WIMO 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 WIMO settings
Every field WIMO exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
1 fieldAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Api keyRequired | Text | Wimo API key, sent as the Authorization header on every request. Example: 9o29309rq884nq620q66qpqn106s6or1 |
Account Details
1 fieldAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Enable/disable Wimo create task APIRequired | Select | Set to Enable to have Carriyo call Wimo's create-task API when booking a shipment. Disable to skip task creation. Example: DisableEnableDisable |
Capability notes
Behavior that follows from WIMO's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but WIMO has to register it on their side. Share the callback details from the account page with your WIMO contact (see step 5) — a one-time setup.