shipstation-client
Version:
ShipStation V2 SDK
42 lines (34 loc) • 2.37 kB
Markdown
# ImporterOfRecords
importer of records address, anywhere in the world.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | The name of a contact person at this address. Either `name` or the `company_name` field should always be set. | [default to undefined]
**phone** | **string** | The phone number of a contact person at this address. The format of this phone number varies depending on the country. | [optional] [default to undefined]
**email** | **string** | Email for the address owner. | [optional] [default to undefined]
**company_name** | **string** | If this is a business address, then the company name should be specified here. Either `name` or the `company_name` field should always be set. | [optional] [default to undefined]
**address_line1** | **string** | The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines. | [default to undefined]
**address_line2** | **string** | The second line of the street address. For some addresses, this line may not be needed. | [optional] [default to undefined]
**address_line3** | **string** | The third line of the street address. For some addresses, this line may not be needed. | [optional] [default to undefined]
**city_locality** | **string** | The name of the city or locality | [default to undefined]
**state_province** | **string** | The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation. | [optional] [default to undefined]
**postal_code** | **string** | postal code | [default to undefined]
**country_code** | **string** | The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1) | [default to undefined]
## Example
```typescript
import { ImporterOfRecords } from 'shipstation-client';
const instance: ImporterOfRecords = {
name,
phone,
email,
company_name,
address_line1,
address_line2,
address_line3,
city_locality,
state_province,
postal_code,
country_code,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)