Interface: AddressBulkItemInput

Defined in: type/AddressBulkItemInput.ts:7

Input object for AddressBulkItemInput

Properties

active?

optional active?: YesNo

Defined in: type/AddressBulkItemInput.ts:47

Indicates whether the address is active

---

city

city: string

Defined in: type/AddressBulkItemInput.ts:27

Address city

---

code?

optional code?: string

Defined in: type/AddressBulkItemInput.ts:39

Address code

---

company?

optional company?: string

Defined in: type/AddressBulkItemInput.ts:17

Company the address applies to

---

country

country: string

Defined in: type/AddressBulkItemInput.ts:31

Address country

---

email?

optional email?: string

Defined in: type/AddressBulkItemInput.ts:37

Address email [valid email format required]

---

firstName?

optional firstName?: string

Defined in: type/AddressBulkItemInput.ts:9

First name the address applies to

---

gender?

optional gender?: Gender

Defined in: type/AddressBulkItemInput.ts:15

Gender the address applies to

---

icp?

optional icp?: YesNo

Defined in: type/AddressBulkItemInput.ts:49

ICP address field defines whether tax should be applied to an order if the address is selected

---

id?

optional id?: number

Defined in: type/AddressBulkItemInput.ts:53

Address primary identifier

---

isDefault?

optional isDefault?: YesNo

Defined in: type/AddressBulkItemInput.ts:45

Indicates whether the address is default for its type

---

lastName?

optional lastName?: string

Defined in: type/AddressBulkItemInput.ts:13

Last name the address applies to

---

middleName?

optional middleName?: string

Defined in: type/AddressBulkItemInput.ts:11

Middle name the address applies to

---

mobile?

optional mobile?: string

Defined in: type/AddressBulkItemInput.ts:35

Address mobile number [min: 6, max: 30]

---

notes?

optional notes?: string

Defined in: type/AddressBulkItemInput.ts:41

Address delivery notes

---

number?

optional number?: string

Defined in: type/AddressBulkItemInput.ts:21

Street number

---

numberExtension?

optional numberExtension?: string

Defined in: type/AddressBulkItemInput.ts:23

Street number extension

---

phone?

optional phone?: string

Defined in: type/AddressBulkItemInput.ts:33

Address fixed phone number [min: 6, max: 30]

---

postalCode

postalCode: string

Defined in: type/AddressBulkItemInput.ts:25

Address postal code

---

region?

optional region?: string

Defined in: type/AddressBulkItemInput.ts:29

Address region

---

street

street: string

Defined in: type/AddressBulkItemInput.ts:19

Street address

---

type

type: AddressType

Defined in: type/AddressBulkItemInput.ts:51

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

---

url?

optional url?: string

Defined in: type/AddressBulkItemInput.ts:43

Company website URL