GOgoshippo
Carrier Accounts

Get Carrier Registration status

Changed on

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

get/carrier_accounts/reg-status

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/carrier_accounts/reg-status
  • Auth
    API key in header Authorization

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 API version guide.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts 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"
}

Changes