Help CenterGitHub

List your BYOCA carrier accounts

Lists the carrier accounts available to your organization. Two kinds are returned, distinguished by `account_type`: `system` — your account with atoship, one per carrier (USPS, FedEx, UPS, DHL). Every organization has these; you do not need to connect anything. `byoca` — your own carrier contract linked to atoship (e.g. your own FedEx or UPS business account), billed by the carrier directly to you. Each `id` returned here can be passed to `POST /v1/rates` as `carrier_account_ids` to quote on specific accounts only, and each rate comes back tagged with the `carrier_account_id` that produced it.

Parameters

Query Parameters

carrier string (USPS | FEDEX | UPS | DHL | CANADA_POST)
Filter by carrier type (L1 carriers only).
is_active boolean
Filter by active status.
page integer
Page number for pagination.
limit integer
Number of items per page.

Returns

200 Carrier accounts retrieved successfully
400 INVALID_CARRIER — the carrier filter is not one of the accepted values.
401 Authentication required

Related

Carrier Accounts
GET/api/v1/carrier-accounts