Skip to main content
GET
/
carrier_accounts
/
reg-status
Python
import shippo
from shippo.models import operations

s = shippo.Shippo(
    api_key_header='ShippoToken <API_TOKEN>',
    shippo_api_version='2018-02-08',
)


res = s.carrier_accounts.get_registration_status(carrier=operations.Carrier.USPS)

if res is not None:
    # handle response
    pass
{
  "carrier_account": "99dc410d295b4a168993cc38809cb123",
  "object_created": "2023-11-07T05:31:56Z",
  "object_owner": "tom@gmail.com",
  "object_updated": "2023-11-07T05:31:56Z",
  "status": "PENDING_TERMS"
}

Authorizations

​
Authorization
string
header
default:ShippoToken shippo_test_d41a6f04796998570c521a50828eae8e3cccf0eb
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

​
SHIPPO-API-VERSION
string
default:2018-02-08

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

Example:

"2018-02-08"

Query Parameters

​
carrier
enum<string>
required

filter by specific carrier

Available options:
ups,
usps,
canada_post

Response

Carrier account registration status

​
carrier_account
string
Example:

"99dc410d295b4a168993cc38809cb123"

​
object_created
string<date-time>
​
object_owner
string
Example:

"tom@gmail.com"

​
object_updated
string<date-time>
​
status
string
Example:

"PENDING_TERMS"