Add a Swiss Post account
This guide walks through setting up a Swiss Post account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Swiss Post expects.
At a glance
Before you start
- A Swiss Post account in good standing, plus its API credentials. The required fields are listed in All Swiss Post 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 Swiss Post
In the carrier picker, search for Swiss Post and click Select. Carriyo creates a Swiss Post 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.
Swiss Post Switzerland). 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 Swiss Post account details
Enter the required Swiss Post account details, then click Next. Every field is documented in All Swiss Post settings below, with examples and accepted values.
Fill in the Swiss Post account details.
- 1Client ID
- 2Client Secret
Fill in the Swiss Post account details.
- 1Franking License Number
- 2Service 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 Swiss Post settings
Every field Swiss Post exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
2 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| Client IDRequired | Text | OAuth client ID used to obtain an access token from the Swiss Post API. Issued when your Swiss Post developer account is set up. Example: 58on6s69pppp0r87nor669r0sn580o36 |
| Client SecretRequired | Secret | OAuth client secret paired with the Client ID to authenticate with the Swiss Post API. Keep it secret. Example: s6qs353q6r1r7spop8n400p12n9897p1 |
Service Options
4 fieldsDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Franking License NumberRequired | Text | Swiss Post franking licence (billing) number printed on labels for postage settlement. Provided with your Swiss Post contract. Example: 15680547 |
| Customer SystemOptional | Text | Optional name identifying the sending system, used by Swiss Post for reporting. Leave blank unless instructed otherwise. Example: e.g., ABC4567 |
| Service CodeRequired | Multi | Default Swiss Post product/additional-service codes applied to shipments. Select one or more services to match your contract. Example: PostPac Priority PostPac EconomyPostPac PrioritySmallPac EconomySmallPac PriorityBulky goods EconomyBulky goods Priority |
| Notify Delivery by TelephoneOptional | Toggle | Enable to ask Swiss Post to notify the recipient of delivery by phone using the consignee's contact number. |
Label
2 fieldsConfigure how your Swiss Post shipping labels will be generated and formatted for printing.
| Field | Type | What to enter |
|---|---|---|
| Label FormatOptional | Select | File format Swiss Post returns the label in. Defaults to PDF; choose ZPL2 for thermal label printers. Example: PDFPDFsPDFZPL2EPS |
| Label LayoutOptional | Select | Paper size of the generated label. Defaults to A7. Example: A7A5A6A7 |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Item NumberOptional | Select | Carriyo reference used as the item number that builds the unique Swiss Post ident code for tracking. Example: Shipment Reference Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Swiss Post's capabilities. Read these before you go live.