Field | Type | Required | Description | Example |
---|---|---|---|---|
account_id |
str | ✔️ | Unique identifier of the account. Please check the carrier accounts tutorial page for the account_id per carrier.To protect account information, this field will be masked in any API response. |
**** |
carrier |
str | ✔️ | Carrier token, see Carriers Please check the carrier accounts tutorial page for all supported carriers. |
usps |
active |
Optional[bool] | ➖ | Determines whether the account is active. When creating a shipment, if no carrier_accounts are explicitly passed Shippo will query all carrier accounts that have this field set. By default, this is set to True. |
|
parameters |
Optional[components.CarrierAccountParameters] | ➖ | N/A | |
carrier_name |
Optional[Any] | ➖ | Carrier name, see Carriers |
USPS |
is_shippo_account |
Optional[bool] | ➖ | N/A | false |
metadata |
Optional[str] | ➖ | N/A | |
object_id |
Optional[str] | ➖ | Unique identifier of the carrier account object. | 6aa34d5f6865448fbb1ee93636e98999 |
object_owner |
Optional[str] | ➖ | Username of the user who created the carrier account object. | [email protected] |
service_levels |
List[components.CarrierAccountServiceLevel] | ➖ | N/A | |
test |
Optional[bool] | ➖ | Indicates whether the object has been created in test mode. | false |