$wsAccount - Account & address data - WEBSALE Dokumentation

With the $wsAccount module, you read the account and address data of the currently logged-in customer and display it in the template. This page is exclusively about reading and displaying existing account and address data. Everything that changes data (create, edit, or delete an address, change a password) is described under Actions → Account, because the triggering actions and their parameters are documented there.

Most values of $wsAccount are only filled if the customer is logged in. Therefore, check with $wsAccount.isLoggedIn whether a customer is logged in before accessing them, otherwise you will read empty values and unintentionally display empty fields.

Basic concept

Working with $wsAccount always follows the same flow:
check the login state → read customer data → react. Before you read customer data, you need to know whether a customer is logged in at all. Only the logged-in state fills the variables with values. Then you read the desired data (e.g. the display name or an address) and react to it, for example with a personal greeting or by displaying the address book. When the data is available
If no customer is logged in, the account queries return empty values. That is why almost every example on this page starts with an isLoggedIn check.

Module overview

Example / excerpt of $wsAccount

{{= $wsAccount | json }}

JSON output

{
  "addressFields": [...],
  "addresses": [...],
  "autoLogInRestriction": "...",
  "backInStockList": [...],
  "customerData": { ... },
  "defaultBillAddress": { ... },
  "defaultDeliveryAddress": { ... },
  "displayName": "...",
  "email": "...",
  "id": "...",
  "isAccountVerified": true,
  "isAutoLogInRestricted": true,
  "isAutoLoggedIn": true,
  "isLoggedIn": true,
  "isPasswordResetRequired": true,
  "lastLogin": "...",
  "loadAddress": "ƒ()",
  "hasPaymentVault": false,
  "loginRequired": "ƒ()",
  "pseudoCreditCards": [...],
  "typeSeparation": { ... }
}

Note: "ƒ()" denotes a function (method). Variables overview

Name	Return type	Description
`addressFields`	array	List of all available address fields with their configuration.
`addresses`	array	List of all stored addresses of the customer.
`autoLogInRestriction`	string	Status of the auto-login restriction.
`backInStockList`	array	Products for which the customer has requested an availability notification.
`customerData`	map	Customer-specific fields (e.g. label, type, value).
`defaultBillAddress`	map	Main billing address as an address map.
`defaultDeliveryAddress`	map	Default shipping address as an address map.
`displayName`	string	Display name of the customer.
`email`	string	Email address of the customer account.
`id`	string	User ID of the customer account.
`isAccountVerified`	bool	Checks whether the customer account has been verified.
`isAutoLoggedIn`	bool	Checks whether the user was logged in automatically.
`isAutoLogInRestricted`	bool	Checks whether not all shop functions are available during an automatic login.
`isLoggedIn`	bool	Checks whether the user is logged in.
`isPasswordResetRequired`	bool	Checks whether the password must be reset.
`lastLogin`	string	Date of the last login.
`pseudoCreditCards`	array	Stored credit cards (pseudonymized).
`typeSeparation`	map	Information about address type separation.

Methods overview

Method	Return type	Description
`loadAddress()`	map	Loads an address by its ID.
`hasPaymentVault()`	bool	Checks whether a link to the payment provider exists for a payment method.
`loginRequired()`	bool	Returns whether a specific action requires a login.

Templates

The data of a logged-in customer can be loaded and displayed on any template. In the standard delivery shop, the templates for the customer account pages are located in the views/account directory. They serve as a basis for displaying and editing customer data. However, you can also use this data in other templates. The prerequisite is that the customer is logged in (see Basic concept).

Variables

$wsAccount.isLoggedIn

Returns whether the user is logged in. This check stands at the beginning of almost every account evaluation, because all other variables only return meaningful values when the user is logged in.

{{ if $wsAccount.isLoggedIn }}
  <!-- Customer is logged in -->
{{ else }}
  <!-- Customer is not logged in -->
{{ /if }}

$wsAccount.email

Returns the email address of the customer account. At checkout, a customer can also order as a guest. In that case, no account email is available, but a guest email address from the checkout. The following example therefore covers both cases so that the appropriate address is always displayed:

{{ if $wsCheckout.guestMail }}
  {{= $wsCheckout.guestMail }}
{{ else }}
  {{= $wsAccount.email }}
{{ /if }}

$wsCheckout.guestMail comes from the $wsCheckout module and is only filled during the order process.

$wsAccount.id

Returns the user ID of the customer account. Use it to uniquely identify a customer, for example for tracking.

{{ if $wsAccount.isLoggedIn }}
  User ID: {{= $wsAccount.id }}
{{ /if }}

$wsAccount.isAccountVerified

Returns whether the customer account has been verified. Evaluate this if certain features should only be unlocked after verification.

{{ if $wsAccount.isAccountVerified }}
  <!-- Account is verified -->
{{ /if }}

$wsAccount.isAutoLoggedIn

Returns whether the user was logged in automatically (via “Stay signed in”). This is relevant because an automatic login can be restricted (see isAutoLogInRestricted).

{{ if $wsAccount.isAutoLoggedIn }}
  <!-- User was logged in automatically -->
{{ /if }}

$wsAccount.isAutoLogInRestricted

Returns whether not all shop functions are available during an automatic login. Evaluate this before offering security-relevant actions (e.g. changing an address) to an automatically logged-in customer, since these may require a new sign-in.
More on this in the configuration.

{{ if $wsAccount.isAutoLogInRestricted }}
  <!-- Not all shop functions available – offer a fresh login if necessary -->
{{ /if }}

$wsAccount.autoLogInRestriction

Returns the status of the auto-login restriction as a string. More on this in the configuration.

{{ if $wsAccount.autoLogInRestriction }}
  <!-- Auto-login restriction is active -->
{{ /if }}

$wsAccount.lastLogin

Returns the date of the last login as a string.

{{ if $wsAccount.lastLogin }}
  Last login: {{= $wsAccount.lastLogin }}
{{ /if }}

$wsAccount.isPasswordResetRequired

Returns whether the password must be reset. Evaluate this to guide the customer specifically to change their password.
More on this in the configuration.

{{ if $wsAccount.isPasswordResetRequired }}
  Please reset your password.
{{ /if }}

$wsAccount.customerData

Returns customer-specific fields as a map (e.g. label, type, and value). Use this variable to display additionally configured customer fields without having to know each field individually.
More on this in the configuration.

{{ foreach $field in $wsAccount.customerData }}
  {{= $field.value }}
{{ /foreach }}

$wsAccount.addressFields

Returns a list of all available address fields with their configuration. Each element is an object with the properties name (field name, e.g. firstName), label (configured label, may be empty), and dataId. This list can be used to build address forms dynamically from the configuration. Each entry additionally contains the field nodeId, the ID of the configuration node, which can be used as a second parameter for $wsOptions.get(name, nodeId) (see Options).

{{ foreach $field in $wsAccount.addressFields }}
  {{= $field.name }} – {{= $field.label }}
{{ /foreach }}

$wsAccount.backInStockList

Returns the products for which the customer has requested a back-in-stock notification. Display the list in the customer account, for example, so that the customer can see and manage their pre-noted products.

{{ foreach $product in $wsAccount.backInStockList }}
  {{= $product }}
{{ /foreach }}

$wsAccount.pseudoCreditCards

Returns the stored credit cards in pseudonymized form. The pseudonymization is intentional, because full card data must not be displayed in the frontend for security and data protection reasons.

{{ foreach $card in $wsAccount.pseudoCreditCards }}
  {{= $card }}
{{ /foreach }}

$wsAccount.typeSeparation

Returns information about address type separation. Via this map, you can check whether billing and shipping addresses are managed separately and which restrictions apply.

Properties of `$wsAccount.typeSeparation`

Property	Return type	Description
`enabled`	bool	Checks whether address type separation is active.
`canCreateBillAddress`	bool	Checks whether another billing address can still be created.
`maxBillAddresses`	int	Maximum number of allowed billing addresses. `0` = unlimited `-1` = separation disabled.
`defaultBillAddressReadonly`	bool	Checks whether the main billing address is read-only.

{{ if $wsAccount.typeSeparation.enabled }}
  {{ if $wsAccount.typeSeparation.canCreateBillAddress }}
    <!-- A new billing address can be created -->
  {{ else }}
    <!-- Maximum number of billing addresses reached -->
  {{ /if }}
{{ /if }}

$wsAccount.defaultBillAddress

Returns the customer’s main billing address as an address map (including id), provided one is marked as default. Use it when you specifically need the main billing address. The available properties correspond to those of $wsAccount.addresses.

{{ if $wsAccount.defaultBillAddress }}
  First name: {{= $wsAccount.defaultBillAddress.firstName }}
  Last name: {{= $wsAccount.defaultBillAddress.lastName }}
{{ /if }}

$wsAccount.defaultDeliveryAddress

Returns the customer’s default shipping address as an address map (including id), provided one is marked as default. Use it when you specifically need the default shipping address. The available properties correspond to those of $wsAccount.addresses.

{{ if $wsAccount.defaultDeliveryAddress }}
  First name: {{= $wsAccount.defaultDeliveryAddress.firstName }}
  Last name: {{= $wsAccount.defaultDeliveryAddress.lastName }}
{{ /if }}

$wsAccount.addresses

Returns the list of all stored addresses of the customer. Use it for an address book or when you want to iterate over all addresses.

{{ foreach $address in $wsAccount.addresses }}
  {{= $address.firstName }} {{= $address.lastName }}
{{ /foreach }}

Each address from $wsAccount.addresses (and also from defaultBillAddress, defaultDeliveryAddress, and loadAddress()) provides the following properties.

Properties of `$wsAccount.addresses`

Property	Return type	Description
`id`	string	Address ID
`salutationCode`	string	Salutation code
`titleCode`	string	Title code (e.g. Dr., Prof.)
`firstName`	string	First name
`lastName`	string	Last name
`company`	string	Company name
`department`	string	Department
`street`	string	Street
`streetNumber`	string	House number
`additionalInfo`	string	Additional address information
`zip`	string	Postal code
`city`	string	City
`state`	string	State / region
`country`	string	Country
`phone`	string	Phone number
`mobilePhone`	string	Mobile phone number
`fax`	string	Fax number
`businessPhone`	string	Business phone number
`businessFax`	string	Business fax number
`dateOfBirth`	string	Date of birth
`taxId`	string	Tax ID
`addressType`	string	Type of the address
`addressOwnerMemberId`	string	ID of the customer who owns the address
`custom`	map	Custom address fields
`isBillAddress`	bool	Checks whether the address can be used as a billing address.
`isDeliveryAddress`	bool	Checks whether the address can be used as a shipping address.
`isDefaultBillAddress`	bool	Checks whether it is the main billing address.
`isDefaultDeliveryAddress`	bool	Checks whether it is the default shipping address.
`isReadonly`	bool	Checks whether the address is read-only.
`type`	string	Type of the address (`"bill"` or `"delivery"`).

$address.customLabel()

Returns the custom label for a specific address field, depending on the address type. Use the method to take form labels from the configuration instead of hard-coding them in the template. Signature $address.customLabel(fieldName, addressType) Returns string – the configured label for the field. Parameters

Name	Type	Required	Description
`fieldName`	string	yes	Name of the address field (e.g. `"firstName"`).
`addressType`	string	yes	Address type: `"bill"` (billing), `"delivery"` (shipping), or `"both"` (both).

First name label: {{= $address.customLabel("firstName", "bill") }}

$address.defaultValue()

Returns the configured default value for a specific address field, depending on the address type. Use the method to prefill fields with meaningful defaults. Signature $address.defaultValue(fieldName, addressType) Returns string – the configured default value for the field. Parameters

Name	Type	Required	Description
`fieldName`	string	yes	Name of the address field (e.g. `"company"`).
`addressType`	string	yes	Address type: `"bill"` (billing), `"delivery"` (shipping), or `"both"` (both).

{{= $address.defaultValue("company", "delivery") }}

Note: The methods customLabel() and defaultValue() currently only take effect in the checkout, once the customer has selected an address. In the customer account, they do not yet distinguish between shipping and billing address. This is planned for a future version.

Methods

$wsAccount.loginRequired()

Returns whether the user must be logged in for a specific action. Evaluate this before offering an action so that you guide a non-logged-in customer to the login beforehand, instead of letting them run into a rejected action. More on this in the configuration. Signature $wsAccount.loginRequired(actionName) Returns bool – true if a login is required, otherwise false. Parameters

Name	Type	Required	Description
`actionName`	string	yes	Name of the action for which it is checked whether a login is required (e.g. `"EmailUpdate"`).

{{ if $wsAccount.loginRequired("EmailUpdate") }}
  <!-- Login required before the email address can be changed -->
{{ /if }}

$wsAccount.loadAddress()

Loads a single address by its ID and returns it as an address map. Use the method in the checkout to output the billing or shipping address chosen by the customer. Signature $wsAccount.loadAddress(addressId) Returns map – the loaded address with the properties from $wsAccount.addresses. Parameters

Name	Type	Required	Description
`addressId`	string	yes	ID of the address to load (e.g. the billing address chosen in the checkout).

{{ var $billAddress = $wsAccount.loadAddress($wsCheckout.selectedBillAddress) }}
{{= $billAddress.firstName }} {{= $billAddress.lastName }}

$wsCheckout.selectedBillAddress comes from the $wsCheckout module and returns the ID of the billing address chosen during the order process.

$wsAccount.hasPaymentVault()

Checks whether the logged-in customer has a link to the payment provider of the specified payment method. Call the method on a page in the customer account to either show the existing link with an option to remove it, or to display the offer to link the account. The link is not assigned to the payment method itself, but to the payment provider and its merchant ID. Multiple payment methods that use the same payment provider with the same merchant ID therefore share the same link. Signature $wsAccount.hasPaymentVault(paymentId) Returns bool – true if a link exists, false if none exists. null is returned if no check is possible, for example if no or an empty paymentID value was passed, if the paymentId is unknown, or if the payment method does not support linking at all. Parameters

Name	Type	Required	Description
`paymentId`	string	yes	ID of the payment method to check.

Example that manages the link in the customer account. The distinction using == true or == false is deliberately chosen here so that the null case does not fall into either branch.

{{ var $hasVault = $wsAccount.hasPaymentVault("paypal") }}
{{ if $hasVault == true }}
  <!-- Link exists: offer option to unlink -->
{{ elseif $hasVault == false }}
  <!-- No link: offer option to link -->
{{ /if }}

Without being logged in, the method returns false, not null – therefore, first check $wsAccount.isLoggedIn before you conclude from false that the customer has not yet created a link.

Within the order process, use $wsCheckout.hasPaymentVault() – this method checks without parameters against the payment method chosen in the checkout and always returns a boolean.

Actions

$wsAccount itself only reads data. Actions that change data (create, edit, or delete an address, change password or email) are documented separately: Actions → Account.

Examples

The following examples are ordered by use case: from the simple state check to a personal greeting to address resolution in the checkout. All examples require a logged-in customer and check for that at the beginning. The trigger is the login state. Depending on whether a customer is logged in, you display different content.

{{ if $wsAccount.isLoggedIn }}
  <!-- Customer is logged in: e.g. greeting and links to the customer account -->
{{ else }}
  <!-- Customer is not logged in: e.g. offer login form -->
{{ /if }}

Result
Logged-in customers see the personal area, non-logged-in visitors see the login offer.

Personal greeting for a logged-in customer

The trigger is the login state. If a customer is logged in, address them with the first and last name from their billing address. The if check on the address prevents empty greetings if no address has been stored yet.

{{ if $wsAccount.isLoggedIn }}
  {{ var $address = $wsAccount.defaultBillAddress }}
  {{ if $address }}
    Welcome, {{= $address.firstName }} {{= $address.lastName }}!
  {{ /if }}
{{ /if }}

Result
Logged-in customers with a stored billing address are greeted by name.

Link to the customer account overview

The trigger is the login state. For logged-in customers, you generate a link to the overview page. The URL is built via $wsViews.viewUrl() so that the path to the template is resolved correctly.

{{ if $wsAccount.isLoggedIn }}
  <a href="{{= $wsViews.viewUrl('account/overview.htm') }}">
    To your customer account overview
  </a>
{{ /if }}

Result
Logged-in customers receive a link that reliably points to the overview page.

Display the billing address

The trigger is the login state. You read the main billing address and display it with an edit link. The link passes the address id so that the action edits the correct address.

{{ if $wsAccount.isLoggedIn }}
  {{ var $address = $wsAccount.defaultBillAddress }}
  {{ if $address }}
    Your billing address
    {{= $address.firstName }} {{= $address.lastName }}
    {{= $address.street }} {{= $address.streetNumber }}
    {{= $address.zip }} {{= $address.city }}
    {{= $address.country }}

    <a href="{{= $wsViews.viewUrl('account/address.htm', {type: 'change', addressId: $address.id}) }}">
      Edit
    </a>
  {{ /if }}
{{ /if }}

Result
The billing address is displayed and the edit link leads to the correct address.

Address book: iterate over all addresses

The trigger is the login state. You iterate over all stored addresses and show an edit link for each address. The loop variable ($address) is used consistently so that the link targets exactly the address of the current iteration.

{{ if $wsAccount.isLoggedIn }}
  {{ foreach $address in $wsAccount.addresses }}
    <p>Address ID: {{= $address.id }}</p>
    <a href="{{= $wsViews.viewUrl('account/address.htm'}}">
      Edit
    </a>
  {{ /foreach }}
{{ /if }}

Result
Each stored address is listed with an edit link that redirects to the address overview page.

Further links

Actions → Account - change addresses and account (create, edit, delete), because $wsAccount itself only reads.
$wsCheckout - provides the address IDs chosen in the order process (selectedBillAddress, selectedShippingAddress) and the guest email address used in the examples.
Configuration: Accounts / user accounts - controls auto-login, verification, and address fields that several variables refer to.

​Basic concept

​Module overview

​Templates

​Variables

​$wsAccount.isLoggedIn

​$wsAccount.email

​$wsAccount.id

​$wsAccount.isAccountVerified

​$wsAccount.isAutoLoggedIn

​$wsAccount.isAutoLogInRestricted

​$wsAccount.autoLogInRestriction

​$wsAccount.lastLogin

​$wsAccount.isPasswordResetRequired

​$wsAccount.customerData

​$wsAccount.addressFields

​$wsAccount.backInStockList

​$wsAccount.pseudoCreditCards

​$wsAccount.typeSeparation

​Properties of $wsAccount.typeSeparation

​$wsAccount.defaultBillAddress

​$wsAccount.defaultDeliveryAddress

​$wsAccount.addresses

​Properties of $wsAccount.addresses

​$address.customLabel()

​$address.defaultValue()

​Methods

​$wsAccount.loginRequired()

​$wsAccount.loadAddress()

​$wsAccount.hasPaymentVault()

​Actions

​Examples

​Check the login state and differentiate content

​Personal greeting for a logged-in customer

​Link to the customer account overview

​Display the billing address

​Address book: iterate over all addresses

​Further links

Basic concept

Module overview

Templates

Variables

$wsAccount.isLoggedIn

$wsAccount.email

$wsAccount.id

$wsAccount.isAccountVerified

$wsAccount.isAutoLoggedIn

$wsAccount.isAutoLogInRestricted

$wsAccount.autoLogInRestriction

$wsAccount.lastLogin

$wsAccount.isPasswordResetRequired

$wsAccount.customerData

$wsAccount.addressFields

$wsAccount.backInStockList

$wsAccount.pseudoCreditCards

$wsAccount.typeSeparation

Properties of `$wsAccount.typeSeparation`

$wsAccount.defaultBillAddress

$wsAccount.defaultDeliveryAddress

$wsAccount.addresses

Properties of `$wsAccount.addresses`

$address.customLabel()

$address.defaultValue()

Methods

$wsAccount.loginRequired()

$wsAccount.loadAddress()

$wsAccount.hasPaymentVault()

Actions

Examples

Check the login state and differentiate content

Personal greeting for a logged-in customer

Link to the customer account overview

Display the billing address

Address book: iterate over all addresses

Further links