Skip to main content

Interface: Address

Defined in: type/Address.ts:7

Object class for Address

Properties​

active?​

optional active?: YesNo

Defined in: type/Address.ts:55

Indicates whether the address is active

city​

city: string

Defined in: type/Address.ts:29

Address city

code?​

optional code?: string

Defined in: type/Address.ts:43

Address code

company?​

optional company?: string

Defined in: type/Address.ts:19

Company the address applies to

country​

country: string

Defined in: type/Address.ts:33

Address country

email?​

optional email?: string

Defined in: type/Address.ts:39

Email that applies to this address [valid email format needed]

fax?​

optional fax?: string

Defined in: type/Address.ts:41

Fax number that applies to this address [min: 6, max: 30]

firstName?​

optional firstName?: string

Defined in: type/Address.ts:11

First name the address applies to

gender?​

optional gender?: Gender

Defined in: type/Address.ts:17

Address gender

icp?​

optional icp?: YesNo

Defined in: type/Address.ts:51

ICP address field defines whether tax should be applied to an order if the address is selected as a delivery address. Used when shipping b2b order abroad

id​

id: number

Defined in: type/Address.ts:9

Address primary identifier

isDefault​

isDefault: YesNo

Defined in: type/Address.ts:47

Indicates whether the address is default for its type

lastName?​

optional lastName?: string

Defined in: type/Address.ts:15

Last name the address applies to

middleName?​

optional middleName?: string

Defined in: type/Address.ts:13

Middle name the address applies to

mobile?​

optional mobile?: string

Defined in: type/Address.ts:37

Mobile phone number that applies to this address [min: 6, max: 30]

name?​

optional name?: string

Defined in: type/Address.ts:57

Address friendly descriptive name

notes?​

optional notes?: string

Defined in: type/Address.ts:45

Address delivery notes

number?​

optional number?: string

Defined in: type/Address.ts:23

Address street number

numberExtension?​

optional numberExtension?: string

Defined in: type/Address.ts:25

Address street number extension

phone?​

optional phone?: string

Defined in: type/Address.ts:35

Fixed phone number that applies to this address [min: 6, max: 30]

postalCode​

postalCode: string

Defined in: type/Address.ts:27

Address postal code

region?​

optional region?: string

Defined in: type/Address.ts:31

Address region

street​

street: string

Defined in: type/Address.ts:21

Address street

type​

type: AddressType

Defined in: type/Address.ts:49

Address type [one of 'home', 'delivery', 'invoice']

url?​

optional url?: string

Defined in: type/Address.ts:53

Address company domain url