Add a Swftbox account
This guide walks through setting up a Swftbox account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Swftbox expects.
At a glance
Before you start
- A Swftbox account in good standing, plus its API credentials. The required fields are listed in All Swftbox 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 Swftbox
In the carrier picker, search for Swftbox and click Select. Carriyo creates a Swftbox 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.
Swftbox 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 Swftbox account details
Enter the required Swftbox account details, then click Next. Every field is documented in All Swftbox settings below, with examples and accepted values.
Enter api key.
- 1API 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
Set up status callbacks
Swftbox sends shipment status by webhook, but it has to be registered on Swftbox's side. Copy the callback details from the account page and share them with your Swftbox 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 Swftbox settings
Every field Swftbox 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 | Secret | Enter the API key issued by Swftbox. Sent as a bearer token on every request. Example: zbpxrq_NCV |
Account Details
3 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Brand NameOptional | Select | Choose which Carriyo value Swftbox uses as the brand name shown to the recipient on tracking and notifications. Merchant IDContact Name |
| Profile NameOptional | Select | Select the Swftbox delivery profile (speed/time-slot service) applied to shipments booked through this account. Same DayNext DayExpress 2hExpress 4hTime Slots |
| Swftbox Pickup Location MappingOptional | Text | Map each Carriyo pickup location to the corresponding Swftbox location ID so shipments are collected from the right address. |
Capability notes
Behavior that follows from Swftbox's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Swftbox has to register it on their side. Share the callback details from the account page with your Swftbox contact (see step 5) — a one-time setup.