Add a Kwick Box account
This guide walks through setting up a Kwick Box account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Kwick Box expects.
At a glance
Before you start
- A Kwick Box account in good standing, plus its API credentials. The required fields are listed in All Kwick Box 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 Kwick Box
In the carrier picker, search for Kwick Box and click Select. Carriyo creates a Kwick Box 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.
Kwick Box 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 Kwick Box account details
Enter the required Kwick Box account details, then click Next. Every field is documented in All Kwick Box settings below, with examples and accepted values.
Enter api key.
- 1Api Key
Fill in the Kwick Box account details.
- 1Delivery Type
- 2Commercial Type
- 3Requirements
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
Kwick Box sends shipment status by webhook, but it has to be registered on Kwick Box's side. Copy the callback details from the account page and share them with your Kwick Box 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 Kwick Box settings
Every field Kwick Box 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 | Enter the API key KWICKBOX provided when your account was set up. Example: 697s44ospn349q4s34250nsn50p77q1n |
Reference Mappings
5 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| KWICKBOX Order ReferenceOptional | Select | Choose which Carriyo reference is sent to KWICKBOX as the order reference; defaults to Shipment Reference. Example: Order Reference Order ReferenceShipment Reference |
| Delivery TypeRequired | Select | How the parcel reaches the recipient: delivered to their door or collected from a pickup point. Example: DOOR_DELIVERYDOOR_DELIVERYPICKUP |
| Commercial TypeRequired | Select | Whether shipments are business-to-business (B2B) or business-to-consumer (B2C). Example: B2CB2BB2C |
| RequirementsRequired | Select | Proof KWICKBOX must capture on delivery, such as the recipient signature or an ID card image. Example: SIGNATUREID_CARD_IMAGESIGNATUREPERSON_IMAGEPROOF_OF_DELIVERY_DOCUMENT |
| Label SizeOptional | Select | Paper size for the shipping label returned by KWICKBOX. Example: A6A4A5A6 |
Capability notes
Behavior that follows from Kwick Box's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Kwick Box has to register it on their side. Share the callback details from the account page with your Kwick Box contact (see step 5) — a one-time setup.