Add a ROYAL MAIL account
This guide walks through setting up a ROYAL MAIL account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field ROYAL MAIL expects.
At a glance
Before you start
- A ROYAL MAIL account in good standing, plus its API credentials. The required fields are listed in All ROYAL MAIL 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 ROYAL MAIL
In the carrier picker, search for ROYAL MAIL and click Select. Carriyo creates a ROYAL MAIL 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.
ROYAL MAIL 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 ROYAL MAIL account details
Enter the required ROYAL MAIL account details, then click Next. Every field is documented in All ROYAL MAIL settings below, with examples and accepted values.
Fill in the ROYAL MAIL account details.
- 1Shipping Account Id (Required For Booking & Tracking)
- 2Shipping Location Id (Required For Booking & Tracking)
- 3Account Number (Required For Tracking)
Fill in the ROYAL MAIL account details.
- 1Content type
- 2Royal Mail Service 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 ROYAL MAIL settings
Every field ROYAL MAIL exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
3 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Shipping Account Id (Required For Booking & Tracking)Required | Text | Your Intersoft/Royal Mail shipping account ID, sent as the shipper on every booking. Found in your Intersoft account. Example: 9q92n66o-19s5-91nn-4npq-6266r848… |
| Shipping Location Id (Required For Booking & Tracking)Required | Text | The dispatch location ID under your Intersoft account, identifying where shipments are sent from. Example: pnn47296-8o7s-9810-noo8-n57q0rqo… |
| Account Number (Required For Tracking)Required | Text | Your Royal Mail carrier account (OBA) number, used when retrieving tracking. Example: 6789012345 |
Account Details
8 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Business transaction typeOptional | Select | Declares the commercial relationship of the shipment to Royal Mail, used for customs and reporting. B2CB2BD2CC2B |
| Content typeRequired | Select | Required classification of the parcel contents that Royal Mail uses for customs handling. Example: Non Documents Non DocumentsDocumentsNon Documents of High Value |
| Royal Mail Service CodeRequired | Select | The Royal Mail product/service used to ship the parcel. Must match a service enabled on your Royal Mail account. Example: Royal Mail 24 Standard/Signed For (Parcel - Daily Rate Service) (CRL1) DE Import Standard 24 (LL) (DEC)DE Import Standard 24 Parcel (DEA)DE Import Standard 24 Parcel (DEB)DE Import Standard 48 (LL) (DED)DE Import to EU Max Sort (LL) (DEG)DE Import to EU Max Sort Parcel (DEM) |
| The Royal Mail service level of the service specified in the Service Code.Optional | Text | Numeric service level (e.g. 01) required by some Royal Mail service codes. Leave blank if yours does not use one. Example: 56 |
| Service EnhancementsOptional | Multi | Optional Royal Mail add-ons applied to every shipment, e.g. Signed, SMS/Email notifications, Safeplace, or LocalCollect. Consequential Loss £1000Consequential Loss £2500Consequential Loss £5000SignedSMSEmail |
| Package TypeOptional | Select | Physical mail format declared to Royal Mail, which affects pricing and sortation. Example: ParcelParcelLetterLargeLetterPrintedPapers |
| Invoice terms of deliveryOptional | Select | Incoterm declared on the customs invoice, determining who pays duties and taxes (e.g. DDP = sender pays). DDUDDPDAPDAT |
| Export Reason (required for international shipping)Optional | Select | Customs reason for export sent on international shipments. Required for cross-border parcels. Example: Sale of Goods Sale of GoodsDocumentsReturn of GoodsMixed ContentGiftOther |
Label
1 fieldChoose the format for Royal Mail shipping labels. If not set, PDF is used by default.
| Field | Type | What to enter |
|---|---|---|
| Label FormatOptional | Select | File format Royal Mail returns the label in. Choose a ZPL option for thermal printers; defaults to PDF. PDFPDF4X3ZPL203DPIZPL300DPI |
Registration Numbers
4 fieldsEORI and VAT numbers for shipper and destination (used for customs and compliance).
| Field | Type | What to enter |
|---|---|---|
| Shipper EORI NumberOptional | Text | Your EORI number, sent on customs paperwork for international shipments. Issued by your customs authority. Example: e.g. GB123456789000 |
| Shipper VAT NumberOptional | Text | Your VAT registration number, included on the customs invoice when required. Example: e.g. GB123456789 |
| Destination EORI NumberOptional | Text | EORI number of the consignee/importer, when the destination country requires one for clearance. |
| Destination VAT NumberOptional | Text | VAT number of the consignee/importer, when required for destination customs. |
Reference Mappings
2 fieldsMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Reference 1Optional | Select | Carriyo reference sent as Royal Mail reference 1 (the primary reference on the shipment). Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name |
| Reference 2Optional | Select | Carriyo reference sent as Royal Mail reference 2 (a secondary reference on the shipment). Order ReferenceShipment ReferenceAlternate ReferenceMerchant IDMerchant Name |
Capability notes
Behavior that follows from ROYAL MAIL's capabilities. Read these before you go live.
shipped, in_transit, delivered…) reach Carriyo automatically. No polling, and nothing to set up on your side.