Add a SPL - Saudi Post Logistics account
This guide walks through setting up a SPL - Saudi Post Logistics account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field SPL - Saudi Post Logistics expects.
At a glance
Before you start
- A SPL - Saudi Post Logistics account in good standing, plus its API credentials. The required fields are listed in All SPL - Saudi Post Logistics 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 SPL - Saudi Post Logistics
In the carrier picker, search for SPL - Saudi Post Logistics and click Select. Carriyo creates a SPL - Saudi Post Logistics 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.
SPL - Saudi Post Logistics 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 SPL - Saudi Post Logistics account details
Enter the required SPL - Saudi Post Logistics account details, then click Next. Every field is documented in All SPL - Saudi Post Logistics settings below, with examples and accepted values.
Enter spl - saudi post logistics crm account id.
- 1SPL - Saudi Post Logistics CRM Account ID
Fill in the SPL - Saudi Post Logistics account details.
- 1Username
- 2Password
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
SPL - Saudi Post Logistics sends shipment status by webhook, but it has to be registered on SPL - Saudi Post Logistics's side. Copy the callback details from the account page and share them with your SPL - Saudi Post Logistics 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 SPL - Saudi Post Logistics settings
Every field SPL - Saudi Post Logistics 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 |
|---|---|---|
| UsernameRequired | Text | Enter the username for your SPL (Saudi Post / Logistics) API account, issued by SPL when your account is set up. Example: acme_api |
| PasswordRequired | Secret | Enter the password paired with your SPL API username. Used together with the username to authenticate every request. Example: C@ffj5eq#7b7! |
| CRM Account IDRequired | Text | Enter your SPL CRM credit-sale account ID. SPL sends this against every pickup/delivery request to identify and bill your account. Example: 86869899189 |
Account Details
2 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Default Branch IDOptional | Text | Enter the SPL branch ID used to handle pickups when a shipment's pickup location has no entry in the location mapping below. Example: 5 |
| SPL Branch ID Location MappingOptional | Text | Map each Carriyo pickup location to its SPL branch ID. Unmapped locations fall back to the Default Branch ID above. Example: {"NPPBHAG_p02s338r-r24q-9241-409… |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Reference IDOptional | Select | Choose which Carriyo reference is sent to SPL as the order reference. Defaults to the shipment reference when left blank. Example: Shipment Reference (Default) Order ReferenceShipment Reference |
Capability notes
Behavior that follows from SPL - Saudi Post Logistics's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but SPL - Saudi Post Logistics has to register it on their side. Share the callback details from the account page with your SPL - Saudi Post Logistics contact (see step 5) — a one-time setup.