Add a Gophr account
This guide walks through setting up a Gophr account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Gophr expects.
At a glance
Before you start
- A Gophr account in good standing, plus its API credentials. The required fields are listed in All Gophr 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 Gophr
In the carrier picker, search for Gophr and click Select. Carriyo creates a Gophr 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.
Gophr United Kingdom). 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 Gophr account details
Enter the required Gophr account details, then click Next. Every field is documented in All Gophr settings below, with examples and accepted values.
Enter api key.
- 1API Key
Select vehicle type.
- 1Vehicle 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
Gophr sends shipment status by webhook, but it has to be registered on Gophr's side. Copy the callback details from the account page and share them with your Gophr 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 Gophr settings
Every field Gophr 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 |
|---|---|---|
| API KeyRequired | Text | Live or sandbox API key from your Gophr account. Sent on every request to authenticate with the Gophr Commercial API. Example: live-a1b2c3d4-e5f6-7890-abcd-ef1… |
Account Details
3 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Vehicle TypeRequired | Select | Default Gophr vehicle class used when booking a courier. Larger classes carry more weight and volume but cost more; choose the smallest that fits a typical parcel. BikeCargo BikeMotorbikeCarSmall VanLarge Van |
| Pickup Proof RequiredOptional | Select | Whether the courier must capture proof at pickup. "Not Required" skips proof, "Photo" stores an image of the parcel, and "Signature" requires the sender to sign on the courier app. Example: Default (Not Required) Not RequiredPhotoSignature |
| Dropoff Proof RequiredOptional | Select | Whether the courier must capture proof at dropoff. "Not Required" skips proof, "Photo" stores an image of the delivered parcel, and "Signature" requires the recipient to sign on the courier app. Example: Default (Not Required) Not RequiredPhotoSignature |
Capability notes
Behavior that follows from Gophr's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Gophr has to register it on their side. Share the callback details from the account page with your Gophr contact (see step 5) — a one-time setup.