Help CenterGitHub

Connect your own carrier account (BYOCA)

Creates a new BYOCA (Bring Your Own Carrier Account) connection using your own carrier credentials. This allows you to use your existing carrier agreements and negotiated rates through atoship. After connecting, your BYOCA rates will automatically appear alongside system rates when requesting shipping rates via `POST /api/rates/unified`.

Parameters

Request Body

carrier string (USPS | FEDEX | UPS | DHL | CANADA_POST) Required
The carrier type.
account_name string Required
A friendly name for this account.
account_number string
Your carrier account number.
credentials object Required
Carrier-specific credentials (API keys, passwords, etc.).

Returns

201 Carrier account created successfully.
400 Invalid request parameters.
401 Authentication required.

Related

Carrier Accounts
POST/api/v1/carrier-accounts
atoship © 2026