Skip to main content

Interface: OrderAddress

Defined in: type/OrderAddress.ts:7

Object class for OrderAddress

Properties​

city​

city: string

Defined in: type/OrderAddress.ts:35

Address city

code?​

optional code?: string

Defined in: type/OrderAddress.ts:47

Address code

company?​

optional company?: string

Defined in: type/OrderAddress.ts:25

Company the address applies to

country​

country: string

Defined in: type/OrderAddress.ts:39

Address country

createdAt​

createdAt: string

Defined in: type/OrderAddress.ts:13

Creation date

email?​

optional email?: string

Defined in: type/OrderAddress.ts:45

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

firstName?​

optional firstName?: string

Defined in: type/OrderAddress.ts:17

First name the address applies to

gender​

gender: Gender

Defined in: type/OrderAddress.ts:23

Gender the address applies to

icp​

icp: YesNo

Defined in: type/OrderAddress.ts:53

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/OrderAddress.ts:9

Address primary identifier

lastModifiedAt​

lastModifiedAt: string

Defined in: type/OrderAddress.ts:15

Last modified date

lastName?​

optional lastName?: string

Defined in: type/OrderAddress.ts:21

Last name the address applies to

middleName?​

optional middleName?: string

Defined in: type/OrderAddress.ts:19

Middle name the address applies to

mobile?​

optional mobile?: string

Defined in: type/OrderAddress.ts:43

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

name?​

optional name?: string

Defined in: type/OrderAddress.ts:57

Address friendly descriptive name

notes?​

optional notes?: string

Defined in: type/OrderAddress.ts:49

Address delivery notes

number?​

optional number?: string

Defined in: type/OrderAddress.ts:29

Address street number

numberExtension?​

optional numberExtension?: string

Defined in: type/OrderAddress.ts:31

Address street number extension

orderId​

orderId: number

Defined in: type/OrderAddress.ts:11

The ID of the Order the address belongs to

phone?​

optional phone?: string

Defined in: type/OrderAddress.ts:41

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

postalCode​

postalCode: string

Defined in: type/OrderAddress.ts:33

Address postal code

region?​

optional region?: string

Defined in: type/OrderAddress.ts:37

Address region

street​

street: string

Defined in: type/OrderAddress.ts:27

Address street

type​

type: AddressType

Defined in: type/OrderAddress.ts:51

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

url?​

optional url?: string

Defined in: type/OrderAddress.ts:55

Address company domain url