Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

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":{...}
    }
}
Parameterbeschreibungen
ParameterBeschreibung
customerVerwaltet Kundendaten und Kontofunktionen im Shop.
customerDataFieldKonfigurierbares Kundendatenfeld.
customerDataFieldSettingsEinstellungen für Anzeige und Speicherung von Kundendatenfeldern.
customerDataGroupFasst 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. Beispielkonfiguration
{
  "name": "companyName",
  "label": "Firma",
  "required": true,
  "storageStrategy": "account",
  "type": {
    "text": {
      "default": ""
    }
  },
  "validations": [
    { "service": "inputValidation.minLength", "options": { "len": 2 } },
    { "service": "inputValidation.maxLength", "options": { "len": 80 } }
  ]
}
Parameterbeschreibungen
ParameterTypBeschreibung
namestring (unique)Technischer Name des Feldes. Muss eindeutig sein und ist selbst wählbar.
labelstringAnzeigename auf der Benutzeroberfläche.
requiredboolMarkiert das Feld als Pflichtfeld.
Default: false
accountMemberFieldboolBestimmt, ob das Feld beim Firmenkonto oder bei Mitarbeiterkonten gespeichert wird.
storageStrategyenumSpeicherort der Werte - im Konto, nur in der Bestellung oder beides.
Mögliche Werte:
- account
- order
- hybrid
Default: account
typeoneOfFeldtyp für Detailkonfigurationen.
textobjectTexteingabefeld
defaultstringVorbelegung des Textfelds. (optional)
numberobjectNumerisches Eingabefeld.
defaultintVorbelegung des Eingabefelds (optional).
minintMinimal zulässiger Wert. (optional)
maxintMaximal zulässiger Wert. (optional)
stepintSchrittweite des Wertes bei Eingabe
Default: 1
numDecimalsintAnzahl der Nachkommastellen.
Default: 0
unitoneOfEinheitsdefinition (optional)
constantobjectFeste, nicht veränderbare Einheit.
namestringTechnischer Name der Einheit.
labelstringAnzeige-Label der Einheit.
dynamicobjectBasiseinheit + auswählbare Einheit.
baseUnitNamestringName der Basiseinheit.
unitOptionslist (object)Liste verfügbarer Einheiten.
namestringTechnischer Name der Einheit.
labelstringAnzeige-Label der Einheit.
factorfloatUmrechnungsfaktor.
convertersingleServiceExterner Konverter für die Umrechnung (optional).
Aktuell gibt es hier nur den unitConverter.orderOfMagnitude.
freeSelectionobjectFreie Auswahl an festen Optionen.
unitOptionslist (object)Wählbare Einheiten.
namestringTechnischer Name.
labelstringAnzeige-Label.
defaultOptionNamestringVorbelegung der Einheit.
dateobjectDatumsfeld.
defaultstringVorbelegung (optional).
checkboxobjectCheckbox.
defaultboolVorbelegung der Checkbox.
Default: false
selectobjectAuswahlliste (Dropdown).
optionslist (object)Verfügbare Auswahlwerte.
valuestringTechnischer Wert einer Option.
labelstringAnzeige-Label der Option.
defaultstringVorbelegte Option (optional)
validationsmultiServiceListe von Validierungsregeln.
Beispiel: - minLength - maxLength - mehr unter Validierungs- und Prüfservices
Target: inputValidation

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. Beispielkonfiguration
{
  "showUngroupedFields": true,
  "storeAccountFieldsInOrder": false,
  "newCustomerFields": [
    "customer.customerDataField.neukundenfeld1",
    "customer.customerDataField.neukundenfeld2"
  ],
  "existingCustomerFields": [
    "customer.customerDataField.bestandskundenfeld1",
    "customer.customerDataField.bestandsfeld2"
  ]
}
Parameterbeschreibungen
ParameterTypBeschreibung
showUngroupedFieldsboolZeigt ungruppierte Kundendatenfelder im Formular an.
Default: true
storeAccountFieldsInOrderboolSpeichert Kontofelder zusätzlich in der Bestellung.
Default: false
newCustomerFieldsmultiAssocListe der Kundendatenfelder, die bei der Neukundenregistrierung abgefragt werden.
Target: customer.customerDataField
existingCustomerFieldsmultiAssocListe 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. Beispielkonfiguration
{
  "name": "company_data",
  "label": "Unternehmensangaben",
  "fields": [
    "customer.customerDataField.company",
    "customer.customerDataField.vatId",
    "customer.customerDataField.phone"
  ]
}
Parameterbeschreibungen
ParameterTypBeschreibung
namestringTechnischer Name der Gruppe. Selbst wählbar.
labelstringAnzeigename der Gruppe im Formular.
fieldsmultiAssocListe der zugeordneten Kundendatenfelder, die in dieser Gruppe anzeigt werden sollen.
Target: customer.customerDataField