Add a Bosta account
This guide walks through setting up a Bosta account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Bosta expects.
At a glance
Before you start
- A Bosta account in good standing, plus its API credentials. The required fields are listed in All Bosta 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 Bosta
In the carrier picker, search for Bosta and click Select. Carriyo creates a Bosta 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.
Bosta 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 Bosta account details
Enter the required Bosta account details, then click Next. Every field is documented in All Bosta settings below, with examples and accepted values.
Fill in the Bosta account details.
- 1Admin User Name
- 2Admin User Email
- 3Admin User Phone
- 4Account Country
- 5Merchant Name
- 6Merchant website
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
Bosta sends shipment status by webhook, but it has to be registered on Bosta's side. Copy the callback details from the account page and share them with your Bosta 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 Bosta settings
Every field Bosta exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Account Details
6 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Admin User NameRequired | Text | Name of the primary contact on your Bosta account. Example: acme_api |
| Admin User EmailRequired | Text | Email of the primary contact on your Bosta account. Example: ops@example.com |
| Admin User PhoneRequired | Text | Phone number of the primary contact on your Bosta account. Example: +971500000000 |
| Account CountryRequired | Select | Country your Bosta account operates in. SAEG |
| Merchant NameRequired | Text | Your business name as registered with Bosta. Example: Acme Inc |
| Merchant websiteRequired | Text | Your store or business website shared with Bosta. Example: https://example.com |
Capability notes
Behavior that follows from Bosta's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Bosta has to register it on their side. Share the callback details from the account page with your Bosta contact (see step 5) — a one-time setup.