mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-10 12:47:46 +00:00
16 lines
17 KiB
Markdown
16 lines
17 KiB
Markdown
# CarrierAccount
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `account_id` | *str* | :heavy_check_mark: | Unique identifier of the account. Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> <br/>page for the `account_id` per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | **** |
|
|
| `carrier` | *str* | :heavy_check_mark: | Name of the carrier (as a token). <br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for all supported carriers. | UPS |
|
|
| `active` | *Optional[bool]* | :heavy_minus_sign: | Determines whether the account is active. When creating a shipment, if no `carrier_accounts` are explicitly <br/>passed Shippo will query all carrier accounts that have this field set. By default, this is set to True. | |
|
|
| `parameters` | [Optional[components.UPSConnectExistingOwnAccountParameters]](../../models/components/upsconnectexistingownaccountparameters.md) | :heavy_minus_sign: | An array of additional parameters for the account, such as e.g. password or token.<br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for the parameters per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | |
|
|
| `is_shippo_account` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
|
| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
|
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the carrier account object. | 6aa34d5f6865448fbb1ee93636e98999 |
|
|
| `object_owner` | *Optional[str]* | :heavy_minus_sign: | Username of the user who created the carrier account object. | bob+22@gmail.com |
|
|
| `test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | false | |