$wsConfig - Configuration - WEBSALE Dokumentation

With the $wsConfig module, you read the shop’s configuration data in the frontend, for example the available countries, the currency, the payment and shipping methods, and the configured salutations and titles. This page is about reading the configuration. The configuration itself is maintained in the admin interface or via code, not through this module.

Basic concept

$wsConfig is a read-only module. It reflects the configuration stored in the shop at the time the page is built. The values change only when the configuration is changed and not as a result of a customer action. The variables can be grouped as follows:

Lists for forms – countries, salutation, title, listElements: populate, e.g., select fields in address and login forms.
Checkout options – payments, shippingMethods: the available payment and shipping methods.
Display – currency: currency symbol and codes.
Behavior and security – passwordChecks, passwordReset, directOrder, redirects, emails.
Insert codes – inserts: settings for insert codes (active, separator, position, default code).

Format currency

The currency filter (| currency) outputs an amount with the currency symbol already included (e.g. 1,500.00 €). For this reason, do not use currency.symbol in addition to | currency – otherwise the symbol will appear twice. You only need currency.symbol if you format a value yourself or display the symbol on its own.

Module overview

Example / excerpt of $wsConfig

{{= $wsConfig | json }}

JSON output

{
  "countries": [ { "isoAlpha2": "...", "isoAlpha3": "...", "isoNum": "...", "name": "..." } ],
  "currency": { "symbol": "...", "isoCode": "...", "isoNum": "..." },
  "directOrder": { "initialNumber": 0, "maximalNumber": 0, "refreshedNumber": 0, "itemNumberFields": [...] },
  "emails": [...],
  "inserts": { "enabled": false, "separator": "...", "position": "...", "defaultInsertCode": "..." },
  "listElements": { "bill": { }, "delivery": { }, "<name>": { } },
  "passwordChecks": { "maxLength": { "len": 0 }, "minLength": { "len": 0 } },
  "passwordReset": { "checkLoginID": false, "checkOldPassword": false },
  "payments": [ { "id": "...", "name": "...", "description": "...", "image": "..." } ],
  "redirects": [...],
  "salutation": { "codeList": [ { "code": "...", "text": "..." } ] },
  "shippingMethods": [ { "id": "...", "name": "...", "description": "...", "image": "...", "link": "...", "type": "...", "group": "..." } ],
  "shippingMethodGroups": [ { "id": "...", "name": "...", "description": "...", "image": "...", "link": "..." } ],
  "title": { "codeList": [ { "code": "...", "text": "..." } ] }
}

Variables overview

Variable	Type	Description
`countries`	array	Configured countries (structure see below).
`currency`	map	Currency data (symbol, codes).
`salutation`	map	Configured salutations (under `codeList`).
`title`	map	Configured titles (under `codeList`).
`payments`	array	Configured payment methods (structure see below).
`shippingMethods`	array	Configured shipping methods (structure see below).
`shippingMethodGroups`	array	Groups of shipping methods (structure see below).
`listElements`	map	Configured address lists for forms, grouped by `bill` and `delivery`; lists without an `addressType` sit directly below.
`passwordChecks`	map	Password length rules.
`passwordReset`	map	Password reset settings.
`directOrder`	map	Direct order settings.
`emails`	array	Email configurations.
`redirects`	array	Redirect configurations.
`inserts`	map	Settings for insert codes (active, separator, position, default code).
`b2bSubAccounts`	map	B2B sub-account settings (`subAccountsEnabled`, `adminCanEditMemberAddresses`).

Templates

The configuration data can be used on any page. Typical use cases: forms (country and salutation selection), checkout (payment and shipping methods), and price display (currency).

Variables

$wsConfig.countries

Returns the configured countries. Use the list, for example, to populate a country select field in an address form.

{{ foreach $country in $wsConfig.countries }}
  {{= $country.name }} ({{= $country.isoAlpha2 }})
{{ /foreach }}

Properties of a country

Property	Type	Description
`name`	string	Name of the country.
`isoAlpha2`	string	ISO-2 country code (e.g. `"DE"`, `"AT"`).
`isoAlpha3`	string	ISO-3 country code (e.g. `"DEU"`, `"AUT"`).
`isoNum`	string	ISO numeric code (e.g. `"276"`, `"040"`).

$wsConfig.currency

Returns the currency data. To display an amount, you generally use the currency filter (see Format currency).

Properties of `$wsConfig.currency`

Property	Type	Description
`symbol`	string	Currency symbol (e.g. `€`).
`isoCode`	string	ISO currency code (e.g. `"EUR"`).
`isoNum`	string	ISO numeric code of the currency (e.g. `"978"`).

Currency: {{= $wsConfig.currency.isoCode }} ({{= $wsConfig.currency.symbol }})

$wsConfig.salutation

Returns the configured salutations. The actual list is found under salutation.codeList. Use it, for example, to populate a salutation select field.

{{ foreach $salutation in $wsConfig.salutation.codeList }}
  {{= $salutation.text }}
{{ /foreach }}

Properties of an entry in `salutation.codeList`

Property	Type	Description
`code`	string	Salutation code (e.g. `"1"`, `"2"`).
`text`	string	Display text (e.g. `"Mr."`, `"Mrs."`, `"Family"`, `"Company"`).

$wsConfig.title

Returns the configured titles. The list is found under title.codeList. The structure is analogous to salutation.

{{ foreach $title in $wsConfig.title.codeList }}
  {{= $title.text }}
{{ /foreach }}

Properties of an entry in `title.codeList`

Property	Type	Description
`code`	string	Title code (e.g. `"1"`).
`text`	string	Display text (e.g. `"Dr."`, `"Prof."`; can be empty).

$wsConfig.payments

Returns the configured payment methods. Use it to display the available payment methods.

{{ foreach $payment in $wsConfig.payments }}
  {{= $payment.name }}: {{= $payment.description }}
{{ /foreach }}

Properties of a payment method

Property	Type	Description
`id`	string	ID of the payment method (for example `"paypalCheckout"` or `"stripe"`).
`nodeId`	string	ID of the configuration node of this payment method, as the second parameter for `$wsOptions.get(name, nodeId)`. Not to be confused with `id`.
`name`	string	Name of the payment method.
`description`	string	Description of the payment method.
`longDescription`	string	Longer description of the payment method (long variant of `description`), maintained under `payment.payment`.
`image`	string	Image URL of the payment method.
`discount`	float	Discount of the payment method.
`provider`	string	Provider of the payment method.
`type`	string	Type of the payment method.
`labels`	array	Labels of the payment method.
`displayInfo`	array	Additional display information (see note).
`fields`	array	Currently visible additional fields of the payment method, for example the date of birth for purchase on invoice. See Additional fields of a payment method.

displayInfo is only populated if the displayedPaymentTypes parameter has been configured for the payment method. Each entry contains name, description and image.

{{ foreach $payment in $wsConfig.payments }}
  {{ foreach $info in $payment.displayInfo }}
    {{= $info.name }}: {{= $info.description }}
  {{ /foreach }}
{{ /foreach }}

Additional fields of a payment method (`fields`)

fields contains the additional fields assigned to the payment method under additionalFields. Only fields whose display conditions are currently met are listed. The entries are saved with the CheckoutSetPaymentFields action, where you can also find a complete form example.

{
    "value": "",
    "rememberedValue": "2000-01-01",
    "rememberInput": true,
    "required": true,
    "label": "Geburtstag",
    "type": "date",
    "infoText": "",
    "name": "bday"
}

Property	Type	Description
`name`	string	Technical name of the field. The value is passed to `CheckoutSetPaymentFields` under this name (`paymentFields.<name>`).
`label`	string	Label of the field, already translated.
`infoText`	string	Info text for the field, already translated. Empty if none is configured.
`type`	string	Field type: `text`, `checkbox`, `select` or `date`.
`required`	bool	`true` if the field is a required field.
`value`	string / bool	Current value from the ongoing checkout. A Boolean for checkboxes, otherwise a string. Empty as long as nothing has been saved.
`rememberInput`	bool	`true` if the value is remembered in the customer account after the order.
`rememberedValue`	string / bool	Value remembered in the customer account from a previous order. A Boolean for checkboxes. Empty for guests and for fields without `rememberInput`. The shop does not insert this value itself; the template can use it to prefill the field.
`options`	array	Only for `type` `select`: list of options, each with `value` and `label`.

$wsConfig.shippingMethods

Returns the configured shipping methods.

{{ foreach $shipping in $wsConfig.shippingMethods }}
  {{= $shipping.name }} ({{= $shipping.type }})
{{ /foreach }}

Properties of a shipping method

Property	Type	Description
`id`	string	ID of the shipping method (e.g. `"dhl"`).
`name`	string	Name of the shipping method.
`description`	string	Description of the shipping method.
`image`	string	Image URL of the shipping method.
`link`	string	Link to the shipping method (e.g. tracking page).
`type`	string	Type of the shipping method (e.g. `"standard"`).
`group`	string	Assigned shipping method group (can be `null`).

The shipping costs are not part of the configuration. They depend on the basket and are determined via $wsCheckout.getShippingCost(shippingMethodId).

$wsConfig.shippingMethodGroups

Returns the configured shipping method groups. A group can bundle several shipping methods (e.g. by provider or delivery type). Which group a shipping method is assigned to is indicated in the group field of the respective shipping method (see Properties of a shipping method).

{{ foreach $group in $wsConfig.shippingMethodGroups }}
  {{= $group.name }}: {{= $group.description }}
{{ /foreach }}

Properties of a group

Property	Type	Description
`id`	string	ID of the group configuration.
`nodeId`	string	ID of the configuration node of this group, as the second parameter for `$wsOptions.get(name, nodeId)`.
`name`	string	Name of the group.
`description`	string	Description of the group.
`image`	string	Image URL (link) of the group.
`link`	string	Link of the group.

$wsConfig.listElements

Returns the configured address lists for forms, for example private / company / parcel station. Use them to populate select fields in address forms. Each list is accessible under its configured name. The path it sits under is determined by the list’s addressType parameter:

`addressType` in the configuration	Path in the template
`"bill"`	`$wsConfig.listElements.bill.<name>`
`"delivery"`	`$wsConfig.listElements.delivery.<name>`
`"both"`	`$wsConfig.listElements.bill.<name>` and `$wsConfig.listElements.delivery.<name>` (the same list, under both paths)
not set	`$wsConfig.listElements.<name>` (directly, not under `bill`/`delivery`)

The key is the list’s name, not its dataId. If the two are maintained differently, the list is accessible in the template exclusively via name. The dataId, by contrast, is referenced in the field validation.

Properties of an entry in `listElements`

Property	Type	Description
`nodeId`	string	ID of the configuration node of this list, as the second parameter for `$wsOptions.get(name, nodeId)`.
`defaultValue`	string	Preselected value (e.g. `"1"`). Empty if no default value is set in the configuration.
`values`	array	Selectable options in display order, each `{ name, value }`.
`values[].name`	string	Display name of the option (e.g. `"Private"`).
`values[].value`	string	Technical value of the option (e.g. `"1"`).

values only contains options with permitted values. Options whose value contains special characters or whose name is empty are skipped when the page is built and are missing here without any error message – see general.addressListElements. If an expected option is missing from the form, check its value first.

Example that outputs the billing address list billAddressType as a select field. The value already saved for the address being edited ($myAddress) is preselected, otherwise the configured defaultValue.

{{ var $myList = $wsConfig.listElements.bill.billAddressType }}

<select name="addressType">
  {{ foreach $myOption in $myList.values }}
    <option value="{{= $myOption.value }}"
      {{ if $myAddress.addressType }}
        {{ if $myOption.value == $myAddress.addressType }} selected{{ /if }}
      {{ else }}
        {{ if $myOption.value == $myList.defaultValue }} selected{{ /if }}
      {{ /if }}>
      {{= $myOption.name }}
    </option>
  {{ /foreach }}
</select>

Result
A select field with all configured options of the list. When editing an existing address, the saved value is preselected; when creating a new address, the default value.

In the example, $myAddress stands for the address being edited in the form – for instance an address from $wsAccount.addresses or an address loaded via $wsAccount.loadAddress(). When creating a new address, the variable is empty and the else branch applies.

If you want to output all lists of an address type dynamically, iterate over the map. Use a separate field name per list so the values remain distinguishable on submit.

{{ foreach $myListName, $myList in $wsConfig.listElements.bill }}
  <select name="{{= $myListName }}">
    {{ foreach $myOption in $myList.values }}
      <option value="{{= $myOption.value }}"{{ if $myOption.value == $myList.defaultValue }} selected{{ /if }}>
        {{= $myOption.name }}
      </option>
    {{ /foreach }}
  </select>
{{ /foreach }}

$wsConfig.passwordChecks

Returns the length rules for passwords. Use them, for example, to display the allowed length in a registration or password form, or to validate client-side.

Password length: {{= $wsConfig.passwordChecks.minLength.len }} to {{= $wsConfig.passwordChecks.maxLength.len }} characters

Properties of `$wsConfig.passwordChecks`

Property	Type	Description
`minLength.len`	int	Minimum password length.
`maxLength.len`	int	Maximum password length.

$wsConfig.passwordReset

Returns the password reset settings.

{{ if $wsConfig.passwordReset.checkOldPassword }}
  <!-- Old password required when resetting -->
{{ /if }}

Properties of `$wsConfig.passwordReset`

Property	Type	Description
`checkLoginID`	bool	Whether the login ID is checked on reset.
`checkOldPassword`	bool	Whether changing the password additionally requires entering the current password, which is then checked for correctness.

$wsConfig.directOrder

Returns the direct order settings from the checkout.directOrder configuration, for example how many input lines are displayed.

Initial lines: {{= $wsConfig.directOrder.initialNumber }}
Max. lines: {{= $wsConfig.directOrder.maximalNumber }}

Properties of `$wsConfig.directOrder`

Property	Type	Description
`initialNumber`	int	Number of initially displayed lines.
`maximalNumber`	int	Maximum number of lines.
`refreshedNumber`	int	Number of lines that `DirectOrderAddLines` adds and `DirectOrderDeleteLines` removes.
`itemNumberFields`	array	Item number fields and separators of the direct order (structure see below). The template generates the input fields from this list.

Properties of an entry in `itemNumberFields`

Property	Type	Description
`type`	string	`field` or `separator`. Always present.
`name`	string	Name of the input field. Only for `type: field`.
`required`	bool	Required field. Only for `type: field`.
`sign`	string	Separator. Only for `type: separator`.

{{ foreach $field in $wsConfig.directOrder.itemNumberFields }}
  {{ if $field.type == "field" }}
    <input type="text" name="{{= $field.name }}">
  {{ elseif $field.type == "separator" }}
    {{= $field.sign }}
  {{ /if }}
{{ /foreach }}

The itemNumberChecks function is not available to the template because the checks run on the server. The fields and saveCountInSession properties are not part of $wsConfig.directOrder either, even though they belong to the checkout.directOrder configuration.

$wsConfig.inserts

Returns the settings for insert codes. In particular, use enabled to only show output related to insert codes when the feature is active in the shop.

{{ if $wsConfig.inserts.enabled }}
  <!-- Output related to the insert code -->
{{ /if }}

Properties of `$wsConfig.inserts`

Property	Type	Description
`enabled`	bool	Whether insert codes are active in the shop. Only then are codes captured, resolved, and output.
`separator`	string	Separator between product number and code (e.g. `-`).
`position`	string	Position of the code relative to the product number: `before` or `after`.
`defaultInsertCode`	string	Default code that applies when no code or an invalid code has been captured. Can be empty.

$wsConfig.emails

Returns the email configurations.

{{= $wsConfig.emails | json }}

$wsConfig.redirects

Returns the redirect configurations.

{{= $wsConfig.redirects | json }}

Methods

No methods are available for $wsConfig.

Actions

No actions are available for $wsConfig.

Examples

Country select field

<select name="country">
  {{ foreach $country in $wsConfig.countries }}
    <option value="{{= $country.isoAlpha2 }}">{{= $country.name }}</option>
  {{ /foreach }}
</select>

Result
A select field with all configured countries. The value is the ISO-2 code.

Salutation select field

<select name="salutation">
  {{ foreach $salutation in $wsConfig.salutation.codeList }}
    <option value="{{= $salutation.code }}">{{= $salutation.text }}</option>
  {{ /foreach }}
</select>

Result
A select field with all configured salutations.

List payment methods

{{ foreach $payment in $wsConfig.payments }}
  <p>{{= $payment.name }} – {{= $payment.description }}</p>
{{ /foreach }}

Result
All configured payment methods with name and description.

Display the currency correctly

Subtotal: {{= $wsBasket.totalGross | currency }}

Result
The amount is output with the currency symbol (e.g. 1,500.00 €).

Configuration – where the values read here are maintained.
Configuration via code – configuration directly in the template.
$wsCheckout – determines, among other things, the shipping costs per shipping method.
Insert code – overview of insert codes, whose settings are provided by $wsConfig.inserts.
ISO 3166-1 code list – meaning of the country codes.

​Basic concept

​Format currency

​Module overview

​Templates

​Variables

​$wsConfig.countries

​Properties of a country

​$wsConfig.currency

​Properties of $wsConfig.currency

​$wsConfig.salutation

​Properties of an entry in salutation.codeList

​$wsConfig.title

​Properties of an entry in title.codeList

​$wsConfig.payments

​Properties of a payment method

​Additional fields of a payment method (fields)

​$wsConfig.shippingMethods

​Properties of a shipping method

​$wsConfig.shippingMethodGroups

​Properties of a group

​$wsConfig.listElements

​Properties of an entry in listElements

​$wsConfig.passwordChecks

​Properties of $wsConfig.passwordChecks

​$wsConfig.passwordReset

​Properties of $wsConfig.passwordReset

​$wsConfig.directOrder

​Properties of $wsConfig.directOrder

​Properties of an entry in itemNumberFields

​$wsConfig.inserts

​Properties of $wsConfig.inserts

​$wsConfig.emails

​$wsConfig.redirects

​Methods

​Actions

​Examples

​Country select field

​Salutation select field

​List payment methods

​Display the currency correctly

​Related links

Basic concept

Format currency

Module overview

Templates

Variables

$wsConfig.countries

Properties of a country

$wsConfig.currency

Properties of `$wsConfig.currency`

$wsConfig.salutation

Properties of an entry in `salutation.codeList`

$wsConfig.title

Properties of an entry in `title.codeList`

$wsConfig.payments

Properties of a payment method

Additional fields of a payment method (`fields`)

$wsConfig.shippingMethods

Properties of a shipping method

$wsConfig.shippingMethodGroups

Properties of a group

$wsConfig.listElements

Properties of an entry in `listElements`

$wsConfig.passwordChecks

Properties of `$wsConfig.passwordChecks`

$wsConfig.passwordReset

Properties of `$wsConfig.passwordReset`

$wsConfig.directOrder

Properties of `$wsConfig.directOrder`

Properties of an entry in `itemNumberFields`

$wsConfig.inserts

Properties of `$wsConfig.inserts`

$wsConfig.emails

$wsConfig.redirects

Methods

Actions

Examples

Country select field

Salutation select field

List payment methods

Display the currency correctly

Related links