Add a Parcel account
This guide walks through setting up a Parcel account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Parcel expects.
At a glance
Before you start
- A Parcel account in good standing, plus its API credentials. The required fields are listed in All Parcel 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 Parcel
In the carrier picker, search for Parcel and click Select. Carriyo creates a Parcel 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.
Parcel Bahrain). 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 Parcel account details
Enter the required Parcel account details, then click Next. Every field is documented in All Parcel settings below, with examples and accepted values.
Enter api key.
- 1API Key
Enter parcel branch.
- 1Parcel Branch
Fill in the Parcel account details.
- 1Vehicle
- 2Order 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
Parcel sends shipment status by webhook, but it has to be registered on Parcel's side. Copy the callback details from the account page and share them with your Parcel 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 Parcel settings
Every field Parcel 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 | Parcel API key, provided when your Parcel account is set up. Example: a1b2c3d4-e5f6-7890-abcd-ef123456… |
Account Details
1 fieldAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Parcel BranchRequired | Text | The Parcel branch ID that shipments booked on this account are raised against. Example: BR-5556 |
Service Options
5 fieldsDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| VehicleRequired | Select | Select the vehicle type Parcel dispatches for shipments booked on this account. Example: CarCarBikeVanChiller |
| Order TypeRequired | Select | Select the Parcel delivery service applied to shipments booked on this account. Example: Same Day Delivery Instant DeliverySame Day DeliveryNext Day Delivery |
| Next Day Delivery – Pickup SlotOptional | Select | Pickup time slot requested from Parcel on Next Day Delivery shipments. 0612 |
| Next Day Delivery – Delivery SlotOptional | Select | Delivery time slot requested from Parcel on Next Day Delivery shipments. 0816 |
| Next Day Delivery – Deliver Same Day?Optional | Select | Whether Parcel delivers the next day after pickup on Next Day Delivery shipments. YesNo |
Capability notes
Behavior that follows from Parcel's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Parcel has to register it on their side. Share the callback details from the account page with your Parcel contact (see step 5) — a one-time setup.