Add a Onfleet account
This guide walks through setting up a Onfleet account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Onfleet expects.
At a glance
Before you start
- A Onfleet account in good standing, plus its API credentials. The required fields are listed in All Onfleet 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 Onfleet
In the carrier picker, search for Onfleet and click Select. Carriyo creates a Onfleet 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.
Onfleet your country). 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 Onfleet account details
Enter the required Onfleet account details, then click Next. Every field is documented in All Onfleet settings below, with examples and accepted values.
Enter auth token.
- 1Auth Token
Select create linked pickup & dropoff tasks.
- 1Create Linked Pickup & Dropoff Tasks
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
Onfleet sends shipment status by webhook, but it has to be registered on Onfleet's side. Copy the callback details from the account page and share them with your Onfleet 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 Onfleet settings
Every field Onfleet 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 |
|---|---|---|
| Auth TokenRequired | Secret | Onfleet API key used to authenticate all requests. Generate it under Settings > API in the Onfleet dashboard. Example: os573178965ons536o28s75qn641onqo |
Account Details
3 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Create Linked Pickup & Dropoff TasksRequired | Select | Choose Yes to create linked pickup and dropoff tasks, or No to create dropoff tasks only. Example: NoYesNo |
| Merchant IDOptional | Text | Onfleet organization ID whose branding is shown to recipients. Leave blank to use your own organization. Example: E.g. ABCD1234 |
| Executor IDOptional | Text | Onfleet organization ID that fulfils the deliveries. Set this when delegating to a connected third-party organization. Example: E.g. ABCD1234 |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Order Reference NumberOptional | Select | Carriyo reference field to include as the order number in the notes of Onfleet tasks. Example: Order Reference (Default) Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Onfleet's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Onfleet has to register it on their side. Share the callback details from the account page with your Onfleet contact (see step 5) — a one-time setup.