menu

SFRA / Server-side JS / Namespace: Address

Address

Methods

(static) Base/Address-AddAddress()

Address-AddAddress : A link to a page to create a new address

Parameters:
Type Description
middleware

csrfProtection.generateToken

middleware

consentTracking.consent

middleware

userLoggedIn.validateLoggedIn

category

sensitive

renders

isml

serverfunction

get

Source:

(static) Base/Address-DeleteAddress()

Address-DeleteAddress : Delete an existing address

Parameters:
Type Description
middleware

userLoggedIn.validateLoggedInAjax

querystringparameter

addressId - a string used to identify the address record

querystringparameter

isDefault - true if this is the default address. false otherwise

category

sensitive

returns

json

serverfunction

get

Source:

(static) Base/Address-EditAddress()

Address-EditAddress : A link to edit and existing address

Parameters:
Type Description
middleware

csrfProtection.generateToken

middleware

userLoggedIn.validateLoggedIn

middleware

consentTracking.consent

querystringparameter

addressId - a string used to identify the address record

category

sensitive

renders

isml

serverfunction

get

Source:

(static) Base/Address-Header()

Address-Header : The endpoint Address-Header renders an isml

Parameters:
Type Description
middleware

server.middleware.include

category

sensitive

renders

isml

serverfunction

get

Source:

(static) Base/Address-List()

Address-List : Used to show a list of address created by a registered shopper

Parameters:
Type Description
middleware

userLoggedIn.validateLoggedIn

middleware

consentTracking.consent

category

sensitive

renders

isml

serverfunction

get

Source:

(static) Base/Address-SaveAddress()

Address-SaveAddress : Save a new or existing address

Parameters:
Type Description
middleware

csrfProtection.validateAjaxRequest

querystringparameter

addressId - a string used to identify the address record

httpparameter

dwfrm_address_addressId - An existing address id (unless new record)

httpparameter

dwfrm_address_firstName - A person’s first name

httpparameter

dwfrm_address_lastName - A person’s last name

httpparameter

dwfrm_address_address1 - A person’s street name

httpparameter

dwfrm_address_address2 - A person’s apartment number

httpparameter

dwfrm_address_country - A person’s country

httpparameter

dwfrm_address_states_stateCode - A person’s state

httpparameter

dwfrm_address_city - A person’s city

httpparameter

dwfrm_address_postalCode - A person’s united states postel code

httpparameter

dwfrm_address_phone - A person’s phone number

httpparameter

csrf_token - hidden input field CSRF token

category

sensitive

returns

json

serverfunction

post

Source:

(static) Base/Address-SetDefault()

Address-SetDefault : Set an address the be the default address

Parameters:
Type Description
middleware

userLoggedIn.validateLoggedIn

querystringparameter

addressId - a string used to identify the address record

category

sensitive

serverfunction

get

Source: