Add a Mylerz account
This guide walks through setting up a Mylerz account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Mylerz expects.
At a glance
Before you start
- A Mylerz account in good standing, plus its API credentials. The required fields are listed in All Mylerz 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 Mylerz
In the carrier picker, search for Mylerz and click Select. Carriyo creates a Mylerz 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.
Mylerz Egypt). 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 Mylerz account details
Enter the required Mylerz account details, then click Next. Every field is documented in All Mylerz settings below, with examples and accepted values.
Fill in the Mylerz account details.
- 1Username
- 2Password
Fill in the Mylerz account details.
- 1Default item category
- 2Service Type
- 3Service
- 4Default Warehouse Name
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 Mylerz settings
Every field Mylerz 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 |
|---|---|---|
| UsernameRequired | Text | Mylerz integration account username. Example: acme_api |
| PasswordRequired | Secret | Password for the Mylerz integration account. Example: Pneevlb@6789 |
Account Details
6 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Mylerz ReferenceOptional | Select | Which Carriyo reference is sent to Mylerz as the order reference. Defaults to the order reference when left unset. Example: Shipment Reference Order ReferenceShipment Reference |
| Default item categoryRequired | Select | Item category sent to Mylerz when a shipment item has no category of its own. Required by Mylerz for booking. Example: FoodFoodPhonesElectronicsHealthFashionComputing |
| Service TypeRequired | Select | Pickup and delivery handover mode applied to every Mylerz booking (e.g. door-to-door). Required by Mylerz. Example: Door to door Door to doorDoor to counterCounter to doorCounter to counter |
| ServiceRequired | Select | Delivery speed sent to Mylerz for each booking (same day or next day). Example: Next day Same dayNext day |
| Default Warehouse NameRequired | Text | Mylerz warehouse name used for pickup when a shipment location has no specific mapping below. Example: Main Warehouse |
| Mylerz Warehouse Name MappingsOptional | Text | Map each Carriyo pickup location to a Mylerz warehouse name; unmapped locations use the default warehouse. Example: Main Warehouse |
Capability notes
Behavior that follows from Mylerz's capabilities. Read these before you go live.