Add a Flamingo account
This guide walks through setting up a Flamingo account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Flamingo expects.
At a glance
Before you start
- A Flamingo account in good standing, plus its API credentials. The required fields are listed in All Flamingo 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 Flamingo
In the carrier picker, search for Flamingo and click Select. Carriyo creates a Flamingo 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.
Flamingo 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 Flamingo account details
Enter the required Flamingo account details, then click Next. Every field is documented in All Flamingo settings below, with examples and accepted values.
Fill in the Flamingo account details.
- 1Username
- 2Password
Select estimate volumetric weight.
- 1Estimate volumetric weight
Select courier type.
- 1Courier Type
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
Flamingo sends shipment status by webhook, but it has to be registered on Flamingo's side. Copy the callback details from the account page and share them with your Flamingo 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 Flamingo settings
Every field Flamingo 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 | Flamingo API username. Example: acme_api |
| PasswordRequired | Secret | Password for the Flamingo API username above. Example: Nqzva678 |
Account Details
2 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Default item descriptionOptional | Text | Item description sent to Flamingo when a shipment has none. If left empty, the combined item descriptions are used. Example: If left empty then combination of item's descriptions is used |
| Estimate volumetric weightRequired | Select | Choose whether Flamingo estimates volumetric (dimensional) weight for rating. Example: YesYesNo |
Package Type
4 fieldsSpecify the Package Type to be used with Carrier
| Field | Type | What to enter |
|---|---|---|
| Use Enhanced Package TypeOptional | Toggle | Turn on to specify a Flamingo package type by numeric ID and price ID instead of selecting a courier type. |
| Package Type IdRequired | Number | Numeric Flamingo package type ID applied to shipments. Example: Package Type Id |
| Package Price IdRequired | Number | Numeric Flamingo package price ID paired with the package type ID. Example: Package Price Id |
| Courier TypeRequired | Select | Select the Flamingo courier (delivery) type applied to shipments. Example: Express Delivery Express DeliveryBullet Delivery |
Capability notes
Behavior that follows from Flamingo's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Flamingo has to register it on their side. Share the callback details from the account page with your Flamingo contact (see step 5) — a one-time setup.