Add a Evri account
This guide walks through setting up a Evri account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Evri expects.
At a glance
Before you start
- A Evri account in good standing, plus its API credentials. The required fields are listed in All Evri 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 Evri
In the carrier picker, search for Evri and click Select. Carriyo creates a Evri 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.
Evri 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 Evri account details
Enter the required Evri account details, then click Next. Every field is documented in All Evri settings below, with examples and accepted values.
Enter evri client id.
- 1Evri Client ID
Fill in the Evri account details.
- 1Booking Username
- 2Booking Password
- 3Tracking API Key
- 4Tracking Client ID
- 5Tracking Client Secret
Enter client name.
- 1Client Name
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 Evri settings
Every field Evri exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
5 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Booking UsernameRequired | Text | Username for the Evri Routing API. Evri issues separate credentials for the test and production systems. Example: carriyo-client |
| Booking PasswordRequired | Secret | Password paired with the Evri Routing API username. Example: xxxxxxxx-xxxx-xxxx |
| Tracking API KeyRequired | Secret | API key from your Evri credentials pack, sent as the apikey header on Client Tracking API calls. Example: xxxxxxxx-xxxx-xxxx |
| Tracking Client IDRequired | Text | OAuth2 client ID used to generate the Evri Client Tracking API authorisation token. Example: xxxxxxxx-xxxx-xxxx |
| Tracking Client SecretRequired | Secret | OAuth2 client secret paired with the tracking client ID. Example: xxxxxxxx-xxxx-xxxx |
Account Details
7 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Client IDRequired | Text | Evri client ID provided during onboarding. Sent on every routing request. Example: 1234 |
| Client NameRequired | Text | Evri client name provided during onboarding, sent alongside the client ID. Example: Example Retail Ltd |
| Child Client IDOptional | Text | Evri child client ID, only if Evri issued one for this account. Example: 001 |
| Child Client NameOptional | Text | Evri child client name, only if Evri issued one for this account. Example: Example Retail Brand |
| Service TypeOptional | Select | Delivery service requested on Evri shipments. Evri does not allow the signature services to be combined. Example: Next Day Next DaySignatureHousehold Signature |
| Product CodeOptional | Text | Evri product code identifying the shipment type. Set to 7 for the Food Service product. Example: 7 |
| Customer Alert GroupOptional | Text | Evri SMS alert group controlling which tracking events trigger an SMS and what branding is applied. Leave blank to disable Evri SMS alerts. Example: 0001 |
Label
1 fieldFormat of the shipping label returned by Evri in the booking response.
| Field | Type | What to enter |
|---|---|---|
| Evri Label FormatOptional | Select | Format of the label Evri returns. PDF is the Evri default; ZPL returns a 799x1199 ZPL label. Example: PDFPDFZPL |
Cross Border
4 fieldsTax identifiers Evri requires on cross-border shipments.
| Field | Type | What to enter |
|---|---|---|
| EORI NumberOptional | Text | Your Economic Operators Registration Identification number. Required for cross-border shipments unless already registered with Evri. Example: GB123456789012 |
| VAT NumberOptional | Text | Your VAT number. Required cross-border, and reduces customs delays for Channel Islands shipments. Example: GB123456789 |
| IOSS NumberOptional | Text | Your Import One-Stop Shop number, required for EU destinations if you have opted in to IOSS. Example: IM1234567891 |
| Reason for ExportOptional | Select | Reason for export sent on cross-border parcels. Example: Commercial Goods Commercial GoodsGiftsDocumentsCommercial SampleReturned GoodsClothing |
Returns
1 fieldHow consumers hand a return parcel back to Evri.
| Field | Type | What to enter |
|---|---|---|
| Return MethodOptional | Select | Choose how return parcels reach Evri. Drop-off issues a return label the customer takes to any ParcelShop or Locker, and Evri is not told to expect the parcel. Courier collection books an Evri courier to collect from the customer’s address, and must not be used for ParcelShop or Locker returns. Example: Drop-offDrop-off at ParcelShop or LockerCourier collection from customer |
Reference Mappings
2 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Customer Reference 1Optional | Select | Carriyo reference field sent as Evri customerReference1. Evri records this against the barcode and it can be used to look up tracking. Example: Order Reference Order ReferenceShipment ReferenceAlternate Reference |
| Customer Reference 2Optional | Select | Carriyo reference field sent as Evri customerReference2. Example: Shipment Reference Order ReferenceShipment ReferenceAlternate Reference |
Capability notes
Behavior that follows from Evri's capabilities. Read these before you go live.