Add a AxiomX account
This guide walks through setting up a AxiomX account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field AxiomX expects.
At a glance
Before you start
- A AxiomX account in good standing, plus its API credentials. The required fields are listed in All AxiomX 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 AxiomX
In the carrier picker, search for AxiomX and click Select. Carriyo creates a AxiomX 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.
AxiomX 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 AxiomX account details
Enter the required AxiomX account details, then click Next. Every field is documented in All AxiomX settings below, with examples and accepted values.
Enter bearer token.
- 1Bearer Token
Enter business unit.
- 1Business Unit
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
AxiomX sends shipment status by webhook, but it has to be registered on AxiomX's side. Copy the callback details from the account page and share them with your AxiomX 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 AxiomX settings
Every field AxiomX 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 |
|---|---|---|
| Bearer TokenRequired | Secret | Axiom X (FarEye Connect) Bearer token sent as the Authorization header on every request. Example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx… |
Account Details
1 fieldAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Business UnitRequired | Text | FarEye business-unit identifier for this account. Required, and differs between test and live environments. Example: 69ce15475f38e9001cc2b9af |
Services
5 fields| Field | Type | What to enter |
|---|---|---|
| Service TypeOptional | Select | Default Axiom X service type sent on every consignment. Defaults to Standard when left unset. Example: Standard (Default) StandardExpress |
| Merchant Order TypeOptional | Select | Merchant order type sent to Axiom X as additional information on every consignment. Example: If left empty then no order type is sent Same DayNext Day1-4 HoursOnce a Week |
| Task TypeOptional | Select | Which legs Axiom X runs for the consignment. Pickup and Delivery when Axiom X collects the shipment and delivers it straight to the end customer; Delivery when the shipment is inbounded at the Axiom X warehouse in between. Left empty, Axiom X applies its own default. Example: DeliveryPickup and DeliveryDelivery |
| Package TypeOptional | Select | Default package type sent for every parcel. Defaults to Box when left unset. Example: Box (Default) BoxBagAmbient |
| Label FormatOptional | Select | Format of the shipping label returned by Axiom X. Defaults to PDF when left unset. Example: PDF (Default) PDFZPL |
Reference Mappings
1 fieldMap Carriyo fields to the reference values the carrier expects.
| Field | Type | What to enter |
|---|---|---|
| Consignment NumberOptional | Select | Which Carriyo reference is sent to Axiom X as the consignment number (should be unique). Defaults to the shipment reference when left unset. Example: Shipment Reference (Default) Order ReferenceShipment ReferenceAlternamr Reference |
Capability notes
Behavior that follows from AxiomX's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but AxiomX has to register it on their side. Share the callback details from the account page with your AxiomX contact (see step 5) — a one-time setup.