Docs
Sign in

Add a RedBox account

Required roles:
AdminAccount Manager
Updated June 20, 20263 min read MENAExpress redboxsa.com

This guide walks through setting up a RedBox account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field RedBox expects.

At a glance

Cross-border
Domestic only
Returns
Supported
Shipping rates
Not supported
Document upload
Not supported
Real-time status
Push · auto setup
Labels
PDF

Before you start

  • A RedBox account in good standing, plus its API credentials. The required fields are listed in All RedBox settings below.
  • Decide the account country and the default service and label format this account uses.
1

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

2

Pick RedBox

In the carrier picker, search for RedBox and click Select. Carriyo creates a RedBox account and opens the credential step.

Search for the carrier

3

Enter the basics

The first wizard page collects two fields:

Account name
A label that's meaningful to your team (e.g. RedBox 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.

  1. 1Account Name
  2. 2Account Country
4

Enter your RedBox account details

Enter the required RedBox account details, then click Next. Every field is documented in All RedBox settings below, with examples and accepted values.

Enter api key.

  1. 1API Key
5

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 RedBox settings

Every field RedBox exposes in the carrier account, grouped by section. Carriyo stores secrets encrypted and never shows them after saving.

Authentication

1 field

Account identifiers and API credentials used to connect to the carrier.

FieldTypeWhat to enter
API KeyRequiredSecretYour Redbox API key, sent on every request to authenticate your account.
Example: rlWuoTpvBvWVHmV6AvVfVaE0pPV1VxcK…

Shipping Locations

1 field
FieldTypeWhat to enter
Redbox Location MappingOptionalTextMap your shipping locations in Carriyo to Redbox locations.

Reference Mappings

1 field

Map Carriyo fields to the reference values the carrier expects.

FieldTypeWhat to enter
Order ReferenceOptionalSelectSelect which Carriyo reference is sent to Redbox to identify your shipments.
Example: Shipment Reference (Default)
Order ReferenceShipment Reference

Capability notes

Behavior that follows from RedBox's capabilities. Read these before you go live.

Real-time tracking
Shipment events (shipped, in_transit, delivered…) reach Carriyo automatically. No polling, and nothing to set up on your side.
No rate API
Carrier Shipping Rates has no effect here. Attach a costing profile to set the shipment cost.
Domestic only
Books domestic routes only. For cross-border lanes, assign a carrier with international coverage in your network profile.

Next steps

Manage account settingsLabels, services, and the Active toggle.Set up costing profilesOverride carrier rates with your own.Add a custom carrierConnect a private fleet or unlisted carrier.Browse all carriersCompare capabilities across the directory.
Was this page helpful?