mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-09 20:57:44 +00:00
17 KiB
17 KiB
CarrierAccount
Fields
| 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 | ✔️ | Name of the carrier (as a token). Please check the carrier accounts tutorial page for all supported carriers. |
UPS |
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.UPSConnectExistingOwnAccountParameters] | ➖ | An array of additional parameters for the account, such as e.g. password or token. Please check the carrier accounts tutorial page for the parameters per carrier. To protect account information, this field will be masked in any API response. |
|
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. | bob+22@gmail.com |
test |
Optional[bool] | ➖ | Indicates whether the object has been created in test mode. | false |