Add a AtUrHome account
This guide walks through setting up a AtUrHome account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field AtUrHome expects.
At a glance
Before you start
- A AtUrHome account in good standing, plus its API credentials. The required fields are listed in All AtUrHome 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 AtUrHome
In the carrier picker, search for AtUrHome and click Select. Carriyo creates a AtUrHome 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.
AtUrHome 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 AtUrHome account details
Enter the required AtUrHome account details, then click Next. Every field is documented in All AtUrHome settings below, with examples and accepted values.
Fill in the AtUrHome account details.
- 1AtUrHome Customer
- 2API Key
Select aturhome service type.
- 1AtUrHome Service 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
AtUrHome sends shipment status by webhook, but it has to be registered on AtUrHome's side. Copy the callback details from the account page and share them with your AtUrHome 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 AtUrHome settings
Every field AtUrHome 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 |
|---|---|---|
| AtUrHome CustomerRequired | Text | Your AtUrHome customer ID. |
| API KeyRequired | Secret | The API key issued by AtUrHome to authenticate your account. |
Service Options
1 fieldDefault service and product options applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| AtUrHome Service TypeRequired | Select | Select the AtUrHome delivery service applied to shipments booked on this account. Dry Delivery |
Capability notes
Behavior that follows from AtUrHome's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but AtUrHome has to register it on their side. Share the callback details from the account page with your AtUrHome contact (see step 5) — a one-time setup.