customer - Kundendaten - WEBSALE Dokumentation

Der Konfigurationsknoten customer bündelt alle Einstellungen rund um die Erfassung und Verarbeitung von Kundendaten im Onlineshop.
Er definiert, welche Informationen im Kundenkonto und im Checkout abgefragt werden, wie diese Felder benannt, gruppiert, validiert und als Pflichtangaben markiert sind – inklusive Steuerung des Speichertyps (im Konto, in der Bestellung oder beides).
Darüber hinaus ermöglicht er die Strukturierung der Formulare über Feldgruppen sowie globale Anzeige- und Speicherregeln für zusätzliche Kundendatenfelder.

`customer*` - Grundstruktur

Nachfolgend der Grundaufbau des Knotens customer

{
    "customer": {
      "customerDataField": {...},
      "customerDataFieldSettings": {...},
      "customerDataGroup": {...}
    }
}

Parameterübersicht

Parameter	Beschreibung
`customer`	Verwaltet Kundendaten und Kontofunktionen im Shop.
`customerDataField`	Konfigurierbares Kundendatenfeld.
`customerDataFieldSettings`	Einstellungen für Anzeige und Speicherung von Kundendatenfeldern.
`customerDataGroup`	Fasst mehrere Kundendatenfelder zu einem Abschnitt zusammen.

`customer.customerDataField` - Kundendatenfelder

Definiert frei konfigurierbare Felder für Kundendaten – inklusive Label, Pflichtstatus und Speicherort. Unterstützt verschiedene Feldtypen (Text, Zahl mit Einheiten, Datum, Checkbox, Auswahl) mit Defaults, Wertebereichen und Validierungen. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/customer.customerDataField (Deeplink-Übersicht)

Beispielkonfiguration

{
  "name": "companyName",
  "label": "<Textbaustein>",
  "required": true,
  "uniqueValue": false,
  "storageStrategy": "account",
  "type": {
    "text": {
      "default": ""
    }
  },
  "validations": [
    { "service": "dataChecker.minLength", "options": { "len": 2 } },
    { "service": "dataChecker.maxLength", "options": { "len": 80 } }
  ]
}

Parameterübersicht

Parameter	Typ	Beschreibung
`name`	string (unique)	Technischer Name des Feldes. Muss eindeutig sein und ist selbst wählbar.
`label`	string	Anzeigename auf der Benutzeroberfläche. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`required`	bool	Markiert das Feld als Pflichtfeld. Default: false
`uniqueValue`	bool	Legt fest, ob der Wert des Feldes shopweit eindeutig sein muss (`true`). Ist die Option aktiv, wird das Feld bei der Duplettenprüfung (`accounts.account` → `duplicate`, siehe accounts - Benutzerkonten) herangezogen – z.B. für die USt-IdNr. Default: false
`accountMemberField`	bool	Bestimmt, ob das Feld beim Firmenkonto oder bei Mitarbeiterkonten gespeichert wird.
`storageStrategy`	enum	Speicherort der Werte - im Konto, nur in der Bestellung oder beides. Mögliche Werte: - `account` - `order` - `hybrid` Default: account
`type`	oneOf	Feldtyp für Detailkonfigurationen.
`text`	object	Texteingabefeld
`default`	string	Vorbelegung des Textfelds. (optional)
`number`	object	Numerisches Eingabefeld.
`default`	int	Vorbelegung des Eingabefelds (optional).
`min`	int	Minimal zulässiger Wert. (optional)
`max`	int	Maximal zulässiger Wert. (optional)
`step`	int	Schrittweite des Wertes bei Eingabe Default: 1
`numDecimals`	int	Anzahl der Nachkommastellen. Default: 0
`unit`	oneOf	Einheitsdefinition (optional)
`constant`	object	Feste, nicht veränderbare Einheit.
`name`	string	Technischer Name der Einheit.
`label`	string	Anzeige-Label der Einheit. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`dynamic`	object	Basiseinheit + auswählbare Einheit.
`baseUnitName`	string	Name der Basiseinheit.
`unitOptions`	list (object)	Liste verfügbarer Einheiten.
`name`	string	Technischer Name der Einheit.
`label`	string	Anzeige-Label der Einheit. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`factor`	float	Umrechnungsfaktor.
`converter`	singleService	Service für die Umrechnung des Werts beim Wechsel der Einheit (optional). Aktuell gibt es hier nur den `unitConverter.orderOfMagnitude`. Er rechnet über die Faktoren aus `unitOptions`. Ohne Eintrag bleibt der Wert beim Wechsel der Einheit unverändert. Mehr unter Validierungs- und Prüfservices
`freeSelection`	object	Freie Auswahl an festen Optionen.
`unitOptions`	list (object)	Wählbare Einheiten.
`name`	string	Technischer Name.
`label`	string	Anzeige-Label. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`defaultOptionName`	string	Vorbelegung der Einheit.
`date`	object	Datumsfeld.
`default`	string	Vorbelegung (optional).
`checkbox`	object	Checkbox.
`default`	bool	Vorbelegung der Checkbox. Default: false
`select`	object	Auswahlliste (Dropdown).
`options`	list (object)	Verfügbare Auswahlwerte.
`value`	string	Technischer Wert einer Option.
`label`	string	Anzeige-Label der Option. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`default`	string	Vorbelegte Option (optional)
`validations`	multiService	Liste von Validierungsregeln. Beispiel: - `minLength` - `maxLength` - mehr unter Validierungs- und Prüfservices Target: `dataChecker`

`customer.customerDataFieldSettings` - Feldkonfiguration

Steuert, wie zusätzliche Kundendatenfelder im Shop angezeigt und gespeichert werden. Ungruppierte Felder können optional eingeblendet werden, und Kontofelder lassen sich zusätzlich in der Bestellungen speichern. Darüber hinaus wird hier festgelegt, welche Felder bei der Neu- bzw. Bestandskundenregistrierung abgefragt werden. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/customer.customerDataFieldSettings (Deeplink-Übersicht)

Beispielkonfiguration

{
  "showUngroupedFields": true,
  "storeAccountFieldsInOrder": false,
  "newCustomerFields": [
    "customer.customerDataField.neukundenfeld1",
    "customer.customerDataField.neukundenfeld2"
  ],
  "existingCustomerFields": [
    "customer.customerDataField.bestandskundenfeld1",
    "customer.customerDataField.bestandsfeld2"
  ]
}

Parameterübersicht

Parameter	Typ	Beschreibung
`showUngroupedFields`	bool	Zeigt ungruppierte Kundendatenfelder im Formular an. Default: true
`storeAccountFieldsInOrder`	bool	Speichert Kontofelder zusätzlich in der Bestellung. Default: false
`newCustomerFields`	multiAssoc	Liste der Kundendatenfelder, die bei der Neukundenregistrierung abgefragt werden. Target: `customer.customerDataField`
`existingCustomerFields`	multiAssoc	Liste der Kundendatenfelder, die bei der Bestandskundenregistrierung abgefragt werden. Target: `customer.customerDataField`

`customer.customerDataGroup` - Gruppierung

Gruppiert frei definierte Kundendatenfelder zu einem Abschnitt (z.B. Rechnungsadresse, Unternehmensangaben). Jede Gruppe hat einen technischen Namen, ein sichtbares Label und verweist auf die enthaltenen Felder. Die Einstellung kann über folgenden Link direkt im Admin-Interface geöffnet werden: https://<shop-domain>/admin/config/customer.customerDataGroup (Deeplink-Übersicht)

Beispielkonfiguration

{
  "name": "company_data",
  "label": "<Textbaustein>",
  "fields": [
    "customer.customerDataField.company",
    "customer.customerDataField.vatId",
    "customer.customerDataField.phone"
  ]
}

Parameterübersicht

Parameter	Typ	Beschreibung
`name`	string	Technischer Name der Gruppe. Selbst wählbar.
`label`	string	Anzeigename der Gruppe im Formular. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`fields`	multiAssoc	Liste der zugeordneten Kundendatenfelder, die in dieser Gruppe angezeigt werden sollen. Target: `customer.customerDataField`

​customer* - Grundstruktur

​Parameterübersicht

​customer.customerDataField - Kundendatenfelder

​Beispielkonfiguration

​Parameterübersicht

​customer.customerDataFieldSettings - Feldkonfiguration

​Beispielkonfiguration

​Parameterübersicht

​customer.customerDataGroup - Gruppierung

​Beispielkonfiguration

​Parameterübersicht

`customer*` - Grundstruktur

Parameterübersicht

`customer.customerDataField` - Kundendatenfelder

Beispielkonfiguration

Parameterübersicht

`customer.customerDataFieldSettings` - Feldkonfiguration

Beispielkonfiguration

Parameterübersicht

`customer.customerDataGroup` - Gruppierung

Beispielkonfiguration

Parameterübersicht