Address Object
Each address corresponds to an address type, when creating the very first address within its address type, it will automatically become the primary address within that address type, the provided primary will be ignored in that case.
When setting an address as primary, any addresses within the same address type will lose their primary state.
addressToken
string
addressToken
1 validation + required
primary
boolean
Specifies if the address is primary within the address type of the address.
required
type
integer
| Code | Description |
|---|---|
| 100 | Other Address |
| 101 | Residential Address |
| 102 | Billing Address |
| 103 | Office Address |
| 104 | Shipping Address |
required
floor
string
apartment
string
house
string
street
string
city
string
county
string
state
string
postcode
string
country
string
ISO-3166-1 alpha-2 country code
summary
object
Provides information on how to display the address information