v1

latestOpenAPI 3.1.02026-07-1270243932.3 KB

Carrier Accounts

Get Carrier Registration status

Returns the registration status for the given account for the given carrier

get/carrier_accounts/reg-status

Query parameters

carrier'ups' | 'usps' | 'canada_post' required

filter by specific carrier

Headers

SHIPPO-API-VERSIONstring

Example:2018-02-08

Optional string used to pick a non-default API version to use. See our <a href="https://docs.goshippo.com/docs/api_concepts/apiversioning/">API version</a> guide.

Response

Carrier account registration status

carrier_accountstring

object_createdstring date-time

object_ownerstring

object_updatedstring date-time

statusstring

Example response

{
  "carrier_account": "99dc410d295b4a168993cc38809cb123",
  "object_owner": "tom@gmail.com",
  "status": "PENDING_TERMS"
}