PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / userAddressGetters

Variable: userAddressGetters ​

const userAddressGetters: object

Defined in: getters/userAddressGetters.ts:123

Type Declaration ​

getAddresses() ​

getAddresses: (addresses, criteria?) => Address[]

Parameters ​

addresses ​

Address[]

criteria? ​

unknown

Returns ​

Address[]

getAddressWithoutId() ​

getAddressWithoutId: (address) => Address

Parameters ​

address ​

Address

Returns ​

Address

getApartmentNumber() ​

getApartmentNumber: (address) => string | number

Parameters ​

address ​

Address

Returns ​

string | number

getBirthday() ​

getBirthday: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getCity() ​

getCity: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getCompanyName() ​

getCompanyName: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getCountryId() ​

getCountryId: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getCountryName() ​

getCountryName: (address, countries) => string

Parameters ​

address ​

Address

countries ​

Country[]

Returns ​

string

getDefault() ​

getDefault: (addresses) => Address | null

Parameters ​

addresses ​

Address[]

Returns ​

Address | null

getEmail() ​

getEmail: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getFirstName() ​

getFirstName: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getId() ​

getId: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getLastName() ​

getLastName: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getPhone() ​

getPhone: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getPostCode() ​

getPostCode: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getPostNumber() ​

getPostNumber: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getProvince() ​

getProvince: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getStateId() ​

getStateId: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getStateName() ​

getStateName: (address, countries) => string

Parameters ​

address ​

Address

countries ​

Country[]

Returns ​

string

getStreetName() ​

getStreetName: (address) => string

Parameters ​

address ​

Address

Returns ​

string

getStreetNumber() ​

getStreetNumber: (address) => string | number

Parameters ​

address ​

Address

Returns ​

string | number

getTotal() ​

getTotal: (addresses) => number

Parameters ​

addresses ​

Address[]

Returns ​

number

getVatNumber() ​

getVatNumber: (address) => string

Parameters ​

address ​

Address

Returns ​

string

isDefault() ​

isDefault: (address) => boolean

Parameters ​

address ​

Address

Returns ​

boolean