Add a YODEL account
This guide walks through setting up a YODEL account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field YODEL expects.
At a glance
Before you start
- A YODEL account in good standing, plus its API credentials. The required fields are listed in All YODEL 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 YODEL
In the carrier picker, search for YODEL and click Select. Carriyo creates a YODEL 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.
YODEL United Kingdom). 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 YODEL account details
Enter the required YODEL account details, then click Next. Every field is documented in All YODEL settings below, with examples and accepted values.
Enter yodel account id.
- 1YODEL Account ID
Fill in the YODEL account details.
- 1Identity
- 2Password
- 3Company name
- 4Application name
- 5Tracking API Client ID
- 6Tracking API Client Secret
Enter tariff code.
- 1Tariff code
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
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 YODEL settings
Every field YODEL exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
7 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| IdentityRequired | Text | Username for the Yodel NetDespatch despatch API. Example: pneevl |
| PasswordRequired | Secret | Password paired with the Identity for the Yodel NetDespatch despatch API. Example: G80g@pp5haG |
| Account IDRequired | Text | Your Yodel despatch account ID, applied to every job. Example: 000654111165 |
| Company nameRequired | Text | Your company name registered with Yodel; combined with Application name as the API Referer header. Example: Acme Inc |
| Application nameRequired | Text | Integration name agreed with Yodel; combined with Company name as the API Referer header. Example: Pneevlb Grfg |
| Tracking API Client IDRequired | Text | Client ID for the Yodel tracking-events API, sent as the X-IBM-Client-ID header. Example: 85qo7882n459pr69p7no43rs4srnr776 |
| Tracking API Client SecretRequired | Secret | Secret paired with the Tracking API Client ID to obtain OAuth tokens for tracking events. Example: 1q27sor26951s639s770p197r644s433 |
Reference Mappings
5 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Shipment Reference 1Optional | Select | Carriyo field to send as the Yodel job reference. Defaults to Order Reference. Example: Order Reference Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name |
| Shipment Reference 2Optional | Select | Carriyo field to send as the Yodel job cost centre. Defaults to Shipment Reference. Example: Shipment Reference Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name |
| Tariff codeRequired | Text | Yodel tariff (service) code applied to every job, setting the despatch service. Example: RCF |
| Consignee VAT numberOptional | Text | Consignee VAT number sent on cross-border jobs for customs clearance. Leave blank for domestic. Example: 678678 |
| Shipper EORI numberOptional | Text | Your EORI number sent on cross-border jobs for customs clearance. Leave blank for domestic. Example: 678678 |
Capability notes
Behavior that follows from YODEL's capabilities. Read these before you go live.