Skip to main content

Interface: CustomerAddressCreateInput

Defined in: type/CustomerAddressCreateInput.ts:7

Input object for CustomerAddressCreateInput

Properties​

city​

city: string

Defined in: type/CustomerAddressCreateInput.ts:27

Address city

code?​

optional code?: string

Defined in: type/CustomerAddressCreateInput.ts:39

Address code

company?​

optional company?: string

Defined in: type/CustomerAddressCreateInput.ts:17

User company the address applies to

country​

country: string

Defined in: type/CustomerAddressCreateInput.ts:31

Address country

customerId​

customerId: number

Defined in: type/CustomerAddressCreateInput.ts:47

Address customer primary identifier

email?​

optional email?: string

Defined in: type/CustomerAddressCreateInput.ts:37

Address email [valid email format required]

firstName?​

optional firstName?: string

Defined in: type/CustomerAddressCreateInput.ts:9

User first name the address applies to

gender?​

optional gender?: Gender

Defined in: type/CustomerAddressCreateInput.ts:15

User gender the address applies to

icp?​

optional icp?: YesNo

Defined in: type/CustomerAddressCreateInput.ts:45

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

isDefault?​

optional isDefault?: YesNo

Defined in: type/CustomerAddressCreateInput.ts:43

Indicates whether the address is default for its type

lastName?​

optional lastName?: string

Defined in: type/CustomerAddressCreateInput.ts:13

User last name the address applies to

middleName?​

optional middleName?: string

Defined in: type/CustomerAddressCreateInput.ts:11

User middle name the address applies to

mobile?​

optional mobile?: string

Defined in: type/CustomerAddressCreateInput.ts:35

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

notes?​

optional notes?: string

Defined in: type/CustomerAddressCreateInput.ts:41

Address delivery notes

number?​

optional number?: string

Defined in: type/CustomerAddressCreateInput.ts:21

User street number

numberExtension?​

optional numberExtension?: string

Defined in: type/CustomerAddressCreateInput.ts:23

User street number extension

phone?​

optional phone?: string

Defined in: type/CustomerAddressCreateInput.ts:33

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

postalCode​

postalCode: string

Defined in: type/CustomerAddressCreateInput.ts:25

Address postal code

region?​

optional region?: string

Defined in: type/CustomerAddressCreateInput.ts:29

Address region

street​

street: string

Defined in: type/CustomerAddressCreateInput.ts:19

User street address

type​

type: AddressType

Defined in: type/CustomerAddressCreateInput.ts:49

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