Add a Postage Express account
This guide walks through setting up a Postage Express account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Postage Express expects.
At a glance
Before you start
- A Postage Express account in good standing, plus its API credentials. The required fields are listed in All Postage Express 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 Postage Express
In the carrier picker, search for Postage Express and click Select. Carriyo creates a Postage Express 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.
Postage Express Saudi Arabia). 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 Postage Express account details
Enter the required Postage Express account details, then click Next. Every field is documented in All Postage Express settings below, with examples and accepted values.
Fill in the Postage Express account details.
- 1Username
- 2Password
- 3API Client Id
- 4API Client Secret Code
Fill in the Postage Express account details.
- 1Service Id
- 2Product Type Id
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
Postage Express sends shipment status by webhook, but it has to be registered on Postage Express's side. Copy the callback details from the account page and share them with your Postage Express 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 Postage Express settings
Every field Postage Express exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
4 fieldsAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| UsernameRequired | Text | Your Postage Express account username. Example: acme_api |
| PasswordRequired | Secret | The password paired with your Postage Express username. Example: 3K9A6gNdQrJ6T2IP57nvKMejbIjPLR3q… |
| API Client IdRequired | Text | The API client ID issued by Postage Express for API access. Example: 65 |
| API Client Secret CodeRequired | Secret | The API client secret paired with your client ID; keep this confidential. Example: 3K9A6gNdQrJ6T2IP57nvKMejbIjPLR3q… |
Account Details
2 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Service IdRequired | Select | Default Postage Express service to book shipments against. Example: Regular shipment Regular shipmentSame Day DeliveryReverse shipment |
| Product Type IdRequired | Select | Postage Express product type identifier to book shipments against. Example: 114114 |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| POSTAGE EXPRESS Order ReferenceOptional | Select | Which Carriyo reference to send as the Postage Express order reference. Example: Order Reference Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Postage Express's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Postage Express has to register it on their side. Share the callback details from the account page with your Postage Express contact (see step 5) — a one-time setup.