Add a SMSA Express account
This guide walks through setting up a SMSA Express account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field SMSA Express expects.
At a glance
Before you start
- A SMSA Express account in good standing, plus its API credentials. The required fields are listed in All SMSA 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 SMSA Express
In the carrier picker, search for SMSA Express and click Select. Carriyo creates a SMSA 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.
SMSA 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 SMSA Express account details
Enter the required SMSA Express account details, then click Next. Every field is documented in All SMSA Express settings below, with examples and accepted values.
Enter restful api key.
- 1RESTful API Key
Select shipment type api.
- 1Shipment type API
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
SMSA Express sends shipment status by webhook, but it has to be registered on SMSA Express's side. Copy the callback details from the account page and share them with your SMSA 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 SMSA Express settings
Every field SMSA Express exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.
Authentication
1 fieldAccount identifiers and API credentials used to connect to the carrier.
| Field | Type | What to enter |
|---|---|---|
| RESTful API KeyRequired | Text | Sent as the apikey header on every SMSA eCom REST API call. Example: sq0op5rpr4n694p539q37s6q0rns4n39 |
Account Details
4 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Shipment type APIRequired | Select | SMSA flow used to book shipments: forward delivery (B2C), pickup return (C2B), or both (OMNI). Example: B2C Shipment B2C ShipmentC2B (Pickup Return) ShipmentOMNI Shipment |
| Service CodeOptional | Select | SMSA service used to ship parcels (domestic/international, lite/heavy, return, etc.). Example: ECOM Delivery Lite (EDDL) ECOM Delivery Lite (EDDL)ECOM Delivery Heavy (EDDH)ECOM International Delivery Lite (EIDL)ECOM International Economy Delivery (EIED)ECOM Domestic Same Day Delivery (EDSD)ECOM Domestic HAL (Hold At Location) Delivery (EDHD) |
| Duty paidOptional | Toggle | Enable if customs duty is prepaid by the merchant rather than collected from the recipient. |
| VAT paidOptional | Toggle | Enable if VAT is prepaid by the merchant rather than collected from the recipient. |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| SMSA Order NumberOptional | Select | Carriyo reference field sent as the SMSA order number on shipments. Defaults to Order Reference. Example: Order Reference (Default) Order ReferenceShipment Reference |
Capability notes
Behavior that follows from SMSA Express's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but SMSA Express has to register it on their side. Share the callback details from the account page with your SMSA Express contact (see step 5) — a one-time setup.