Add a Beyond account
This guide walks through setting up a Beyond account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Beyond expects.
At a glance
Before you start
- A Beyond account in good standing, plus its API credentials. The required fields are listed in All Beyond 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 Beyond
In the carrier picker, search for Beyond and click Select. Carriyo creates a Beyond 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.
Beyond Kuwait). 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 Beyond account details
Enter the required Beyond account details, then click Next. Every field is documented in All Beyond settings below, with examples and accepted values.
Fill in the Beyond account details.
- 1Username
- 2Password
Select estimate volumetric weight.
- 1Estimate volumetric weight
Select courier type.
- 1Courier Type
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
Beyond sends shipment status by webhook, but it has to be registered on Beyond's side. Copy the callback details from the account page and share them with your Beyond 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 Beyond settings
Every field Beyond 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 |
|---|---|---|
| UsernameRequired | Text | Beyond (ShipOX) API username. Example: acme_api |
| PasswordRequired | Secret | Password for the Beyond (ShipOX) API username above. Example: Pneevlb.7576 |
Account Details
2 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Default item descriptionOptional | Text | Note sent to Beyond describing the shipment contents. Leave empty to auto-generate from the order item descriptions. Example: If left empty then combination of item's descriptions is used |
| Estimate volumetric weightRequired | Select | When Yes, Carriyo asks Beyond to factor parcel dimensions into the chargeable weight. Example: NoYesNo |
Package Type
4 fieldsSpecify the Package Type to be used with Carrier
| Field | Type | What to enter |
|---|---|---|
| Use Enhanced Package TypeOptional | Toggle | Turn on to book with a specific Beyond package type and price ID instead of a generic courier type. |
| Package Type IdRequired | Number | Numeric Beyond package type identifier sent on each order. Get it from your Beyond account configuration. Example: e.g. 1 |
| Package Price IdRequired | Number | Numeric Beyond price ID paired with the package type above. Get it from your Beyond account configuration. Example: e.g. 2 |
| Courier TypeRequired | Select | Generic Beyond courier/package type used when Enhanced Package Type is off. Example: Express Delivery Express DeliveryBullet Delivery |
Capability notes
Behavior that follows from Beyond's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Beyond has to register it on their side. Share the callback details from the account page with your Beyond contact (see step 5) — a one-time setup.