Address

Address object Address

export interface Address {
	'cellphone'?: string;
	'city'?: City;
	'cityDistrict'?: District;
	'companyName'?: string;
	'country'?: Country;
	'defaultAddress'?: boolean;
	'district'?: string;
	'email'?: string;
	'firstName': string;
	'formattedAddress'?: string;
	'id'?: string;
	'lastName': string;
	'line1': string;
	'line2'?: string;
	'phone'?: string;
	'postalCode': string;
	'region'?: Region;
	'shippingAddress'?: boolean;
	'title'?: string;
	'titleCode': string;
	'town': string;
	'visibleInAddressBook'?: boolean;
}

Properties

Name	Required	Type	Description
`cellphone`	Optional	`string`	Cellphone number {string} Address
`city`	Optional	`City`	{City} Address
`cityDistrict`	Optional	`District`	{District} Address
`companyName`	Optional	`string`	Company Name {string} Address
`country`	Optional	`Country`	{Country} Address
`defaultAddress`	Optional	`boolean`	Boolean flag if address is default {boolean} Address
`district`	Optional	`string`	District name {string} Address
`email`	Optional	`string`	Email address {string} Address
`firstName`	Required	`string`	First name of the address person {string} Address
`formattedAddress`	Optional	`string`	Boolean flag if address is formatted {string} Address
`id`	Optional	`string`	Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key {string} Address
`lastName`	Required	`string`	Last name of the address person {string} Address
`line1`	Required	`string`	First line of the address {string} Address
`line2`	Optional	`string`	Second line of the address {string} Address
`phone`	Optional	`string`	Phone number {string} Address
`postalCode`	Required	`string`	Postal code of the address {string} Address
`region`	Optional	`Region`	{Region} Address
`shippingAddress`	Optional	`boolean`	Boolean flag if address is for shipping {boolean} Address
`title`	Optional	`string`	Title of the address person {string} Address
`titleCode`	Required	`string`	Code of the title {string} Address
`town`	Required	`string`	Town, field required {string} Address
`visibleInAddressBook`	Optional	`boolean`	Boolean flag if address is visible in the Address Book {boolean} Address

Properties

Referenced Types

On this page