Add a Starlinks account
This guide walks through setting up a Starlinks account in the Carriyo Dashboard. It covers the required roles, the credentials to collect, and every field Starlinks expects.
At a glance
Before you start
- A Starlinks account in good standing, plus its API credentials. The required fields are listed in All Starlinks 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 Starlinks
In the carrier picker, search for Starlinks and click Select. Carriyo creates a Starlinks 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.
Starlinks 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 Starlinks account details
Enter the required Starlinks account details, then click Next. Every field is documented in All Starlinks settings below, with examples and accepted values.
Enter starlinks customer code.
- 1Starlinks Customer Code
Enter api key.
- 1API Key
Select service type.
- 1Service 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
Starlinks sends shipment status by webhook, but it has to be registered on Starlinks's side. Copy the callback details from the account page and share them with your Starlinks 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 Starlinks settings
Every field Starlinks 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 |
|---|---|---|
| API KeyRequired | Secret | Enter the API key issued by Starlinks. Sent on every request to authenticate your account on the Shipsy platform. Example: 827s0o0391p6910406pr3n366n64qr |
| Customer CodeRequired | Text | Enter your Starlinks customer code. Identifies your account when booking consignments. Example: 0123 |
Account Details
3 fieldsAccount-level configuration and defaults applied to shipments.
| Field | Type | What to enter |
|---|---|---|
| Service TypeRequired | Select | Select the Starlinks delivery service applied to shipments booked through this account. Example: StandardStandardSame dayDomestic ReturnHeavy & Bulky |
| Label TypeOptional | Select | Choose the shipping label paper size returned by Starlinks. Defaults to A6 when left blank. A4 LabelA6 Label |
| Starlinks Customer ReferenceOptional | Select | Choose which Carriyo reference is sent to Starlinks as the customer reference. Defaults to the shipment reference when left blank. Example: Shipment Reference Order ReferenceShipment Reference |
Capability notes
Behavior that follows from Starlinks's capabilities. Read these before you go live.
shipped, in_transit, delivered…) arrive by webhook, but Starlinks has to register it on their side. Share the callback details from the account page with your Starlinks contact (see step 5) — a one-time setup.