Files
speakeasy-playground/docs/models/components/carrieraccountupscreaterequestparameters.md
Mike Lueders 14c449163c generate sdk
2024-03-01 12:52:50 -06:00

25 lines
11 KiB
Markdown

# CarrierAccountUPSCreateRequestParameters
## Fields
| Field | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `billing_address_city` | *str* | :heavy_check_mark: | N/A | San Francisco |
| `billing_address_country_iso2` | *str* | :heavy_check_mark: | N/A | US |
| `billing_address_state` | *str* | :heavy_check_mark: | N/A | CA |
| `billing_address_street1` | *str* | :heavy_check_mark: | N/A | 731 Market St |
| `billing_address_zip` | *str* | :heavy_check_mark: | N/A | 94103 |
| `pickup_address_city` | *str* | :heavy_check_mark: | User's pickup address city. | San Francisco |
| `pickup_address_country_iso2` | *str* | :heavy_check_mark: | User's pickup street 1. | US |
| `pickup_address_state` | *str* | :heavy_check_mark: | User's pickup address state. | CA |
| `pickup_address_street1` | *str* | :heavy_check_mark: | User's pickup address street 1. | 731 Market St |
| `pickup_address_zip` | *str* | :heavy_check_mark: | User's pickup address zip code. | 94103 |
| `ups_agreements` | *bool* | :heavy_check_mark: | Whether the user agrees to the UPS terms and conditions or not. Error 400 will be returned if passed in as false | |
| `billing_address_street2` | *Optional[str]* | :heavy_minus_sign: | Empty string acceptable for billing_address_street2 | STE 200 |
| `company` | *Optional[str]* | :heavy_minus_sign: | Company name. Full name is acceptable in this field if the user has no company name | Shippo |
| `email` | *Optional[str]* | :heavy_minus_sign: | N/A | hippo@shippo.com |
| `full_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Shippo Meister |
| `phone` | *Optional[str]* | :heavy_minus_sign: | Needs to be a valid phone number and cannot be null | 1112223333 |
| `pickup_address_same_as_billing_address` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
| `pickup_address_street2` | *Optional[str]* | :heavy_minus_sign: | User's pickup street 2. | STE 200 |