Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Carrier Accounts

List all carrier accounts

Returns a list of all carrier accounts connected to your Shippo account. These carrier accounts include both Shippo carrier accounts and your own carrier accounts that you have connected to your Shippo account.

Additionally, you can get information about the service levels associated with each carrier account by passing in the ?service_levels=true query parameter. Using it appends the property service_levels to each carrier account. By default, if the query parameter is omitted, the service_levels property will not be included in the response.

get/carrier_accounts

Query parameters

service_levelsboolean

Appends the property service_levels to each returned carrier account

carrier'airterra' | 'apc_postal' | 'apg' | 'aramex' | 'asendia_us' | 'australia_post' | 'axlehire' | 'better_trucks' | 'borderguru' | 'boxberry' | 'bring' | 'canada_post' | 'chronopost' | 'collect_plus' | 'correios_br' | 'correos_espana' | 'colissimo' | 'deutsche_post' | 'dhl_benelux' | 'dhl_ecommerce' | 'dhl_express' | 'dhl_germany_c2c' | 'dhl_germany' | 'dpd_de' | 'dpd_uk' | 'estafeta' | 'fastway_australia' | 'fedex' | 'globegistics' | 'gls_us' | 'gophr' | 'gso' | 'hermes_germany_b2c' | 'hermes_uk' | 'hongkong_post' | 'lasership' | 'lso' | 'mondial_relay' | 'new_zealand_post' | 'nippon_express' | 'ontrac' | 'parcelforce' | 'passport' | 'pcf' | 'poste_italiane' | 'posti' | 'purolator' | 'royal_mail' | 'royal_mail_sf' | 'rr_donnelley' | 'russian_post' | 'skypostal' | 'stuart' | 'swyft' | 'uds' | 'ups' | 'usps' | 'veho'
TokenCarrier name
airterraAirterra
apc_postalAPC Postal
apgAPG
aramexAramex
asendia_usAsendia US
australia_postAustralia Post (also used for Startrack)
axlehireJitsu
better_trucksBetterTrucks
borderguruBorderGuru
boxberryBoxberry
bringBring (also used for Posten Norge)
canada_postCanada Post
chronopostChronopost
collect_plusCollectPlus
correios_brCorreiosBR
correos_espanaCorreos España
colissimoColissimo
deutsche_postDeutsche Post
dhl_beneluxDHL Benelux
dhl_ecommerceDHL eCommerce
dhl_expressDHL Express
dhl_germany_c2cDHL Germany C2C
dhl_germanyDHL Germany
dpd_deDPD GERMANY
dpd_ukDPD UK
estafetaEstafeta
fastway_australiaAramex
fedexFedEx
globegisticsGlobegistics (now Asendia)
gls_usGLS US
gophrGophr
gsoGSO
hermes_germany_b2cHermes Germany B2C
hermes_ukEvri UK
hongkong_postHongkong Post
lasershipLaserShip
lsoLSO
mondial_relayMondial Relay
new_zealand_postNew Zealand Post (also used for Pace and CourierPost)
nippon_expressNippon Express
ontracOnTrac
parcelforceParcelforce
passportPassport
pcfPCF
poste_italianePoste Italiane
postiPosti
purolatorPurolator
royal_mailRoyal Mail
royal_mail_sfRoyal Mail Storefeeder
rr_donnelleyePost Global
russian_postRussian Post
skypostalSkyPostal
stuartStuart
swyftSwyft
udsUDS (United Delivery Service)
upsUPS
uspsUSPS
vehoVeho

Filter the response by the specified carrier

account_idstring

Filter the response by the specified carrier account Id

pageinteger

The page number you want to select

resultsinteger

The number of results to return per page (max 100, default 5)

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Response

Paginated list of carrier accounts

nextstring
previousstring

Example response

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    {
      "account_id": "****",
      "carrier": "usps",
      "parameters": {
        "verification_invoice_amount": "340",
        "verification_invoice_date": "2024-03-09",
        "verification_invoice_currency": "USD"
      },
      "carrier_name": "USPS",
      "object_id": "6aa34d5f6865448fbb1ee93636e98999",
      "object_owner": "bob+22@gmail.com",
      "service_levels": [
        {
          "name": "Priority Mail Express",
          "token": "usps_priority_express",
          "supports_return_labels": true
        }
      ]
    }
  ]
}