Add a BARQ account
This guide walks through setting up a BARQ account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field BARQ expects.
At a glance
Before you start
- A BARQ account in good standing, plus its API credentials. The required fields are listed in All BARQ 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 BARQ
In the carrier picker, search for BARQ and click Select. Carriyo creates a BARQ 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.
BARQ 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 BARQ account details
Enter the required BARQ account details, then click Next. Every field is documented in All BARQ settings below, with examples and accepted values.
Enter barq api auth token.
- 1BARQ API Auth Token
Select barq fleet shipment type.
- 1BARQ Fleet Shipment 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
BARQ sends shipment status by webhook, but it has to be registered on BARQ's side. Copy the callback details from the account page and share them with your BARQ 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 BARQ settings
Every field BARQ 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 |
|---|---|---|
| BARQ API Auth TokenRequired | Secret | Bearer token sent in the Authorization header on every BARQ request. Example: rlWuoTpvBvWVHmV6AvW4.rlW6p7IlK7y… |
Account Details
3 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| BARQ Fleet Shipment TypeRequired | Select | BARQ delivery speed applied to bookings: instant, same-day or next-day. Required. Example: instant_delivery (0) instant_delivery (0)same_day (1)next_day (2) |
| BARQ HUB Code Location MappingOptional | Text | Map each Carriyo location to its BARQ hub code. Unmapped locations fall back to the Default HUB Code. |
| Default HUB CodeOptional | Text | BARQ hub code used when a shipment location has no entry in the location mapping above. Example: 676 |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| BARQ Fleet Order ReferenceOptional | Select | Carriyo reference sent as the BARQ order reference. Defaults to Order Reference. Example: Order Reference Order ReferenceShipment Reference |
Capability notes
Behavior that follows from BARQ's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but BARQ has to register it on their side. Share the callback details from the account page with your BARQ contact (see step 5) — a one-time setup.