Add a Shipa account

Required roles:

AdminAccount Manager

Updated June 20, 20263 min read MENAExpress shipa.com

This guide walks through setting up a Shipa account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Shipa 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 Shipa account in good standing, plus its API credentials. The required fields are listed in All Shipa 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.

Pick Shipa

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

Enter the basics

The first wizard page collects two fields:

Account name: A label that's meaningful to your team (e.g. Shipa United Arab Emirates). 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 Shipa account details

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

Select shipa api version.
1Shipa API Version

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.

Merchant access

On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab, then Save.

All Shipa settings

Every field Shipa 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.

Field	Type	What to enter
API KeyRequired	Secret	Secret API key that authenticates requests. Example: `zdlVKu3cckDAsYsgGlNaOqoTw08T3OWI`

Service Options

4 fields

Default service and product options applied to shipments.

Field	Type	What to enter
Shipa API VersionRequired	Select	Shipa API version to integrate with; controls which order-category options apply. Example: `V1` V1V2
Order CategoryOptional	Select	Default Shipa delivery service applied to shipments when using API Version 1. Example: Select order category (Version 1) On Demand (V1)Same Day (V1)Next Day (V1)Cross Border (V1)
Order CategoryOptional	Select	Default Shipa delivery service applied to shipments when using API Version 2. Example: Select order category (Version 2) On Demand (V2)Same Day (V2)Next Day (V2)Cross Border (V2)
Pass Preferred Delivery DateOptional	Toggle	Enable to send the shipment's preferred delivery date to Shipa for scheduling.

Label

1 field

Configure how your Shipa shipping labels will be generated and formatted for printing.

Field	Type	What to enter
Label TemplateOptional	Select	Label layout Shipa uses when generating shipment labels (e.g. standard, 6x4 sticker or international). Example: Choose a label template StandardSticker-6x4International

Reference Mappings

1 field

Map Carriyo fields to the reference values the carrier expects.

Field	Type	What to enter
Shipa Order ReferenceOptional	Select	Carriyo reference used to generate the Shipa shipment ID. Defaults to Order Reference. Example: Order Reference (Default) Order ReferenceShipment Reference

Capability notes

Behavior that follows from Shipa'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?