Der Knoten inquiry steuert shopseitige Formulare (z. B. Kontakt, Widerruf, Retoure, Katalogbestellung).

Die Konfiguration von Formularen erfolgt im Admin Interface unter dem Service Anfragen.

Jedes Formular wird als eigener Unternode unter inquiry.form.<name> definiert.

Inhaltsverzeichnis

1 1. inquiry* - Grundstruktur
2 2. inquiry.form - Formular-Konfiguration
3 3. inquiry.fieldPreset - Globale Felddefinitionen

1. `inquiry*` - Grundstruktur

Nachfolgend der Grundaufbau des Knotens inquiry:

{
  "inquiry": {
    "form": {
      "catalogue": { ... },
      "contact": { ... },
      "productQuestion": { ... },
      "returnInquiry": { ... }
    }
  }
}

Parameterbeschreibung

Parameter	Beschreibung

Parameter

Beschreibung

form

Container für alle Formular-Definitionen unterhalb von inquiry. Die direkten Keys innerhalb von form sind die technischen Formularnamen.

<name>

Platzhalter für einen konkreten Formular-Knoten (z. B. catalogue, contact, productQuestion, returnInquiry).

Das zugehörige Objekt enthält die vollständige Konfiguration dieses Formulars (z. B. Felder, Validierungen, E-Mail-Einstellungen).

2. `inquiry.form` - Formular-Konfiguration

Jedes Formular unterhalb von inquiry.form enthält die vollständige Konfiguration für ein bestimmtes Anfrageformular (z. B. Kontakt, Kataloganforderung, Produktfrage, Retoure).

Hier werden die Formularfelder, Validierungen, optionale Captcha-Prüfungen sowie die E-Mail-Parameter definiert, über die die Anfrage weitergeleitet oder bestätigt wird.

Beispielkonfiguration für ein Kontaktformular (`inquiry.form.contact`)

{
  "captcha": {
    "service": "captchaCheck.recaptchav3"
  },
  "fieldPresets": null,
  "fields": [
    {
      "label": "Betreff",
      "name": "subject",
      "required": true,
      "validations": [
        {
          "options": { "len": 1 },
          "service": "dataChecker.minLength"
        },
        {
          "options": { "len": 200 },
          "service": "dataChecker.maxLength"
        }
      ]
    },
    {
      "label": "Ihre Nachricht",
      "name": "comment",
      "required": true,
      "validations": [
        {
          "options": { "len": 1 },
          "service": "dataChecker.minLength"
        },
        {
          "options": { "len": 10000 },
          "service": "dataChecker.maxLength"
        }
      ]
    }
  ],
  "inquiryEmail": {
    "fromAddress": "noreply@websale.de",
    "fromName": "Mustershop",
    "merchantEmail": "noreply@websale.de",
    "subject": "Ihre Kontaktanfrage",
    "template": "contact.htm"
  },
  "name": "contact"
}

Parameterbeschreibung

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`name`	string	Technischer Name des Formulars. Ist frei wählbar, muss aber eindeutig sein.
`fieldPresets`	multiAssoc	Verweist auf vordefinierte Feldgruppen (globale Formularfelder), die zentral unter `inquiry.fieldPreset` definiert sind. Dadurch können gemeinsam genutzte Felder (z. B. Name, E-Mail-Adresse) in mehreren Formularen wiederverwendet werden. Die Zuweisung erfolgt über eine Liste von Referenzen auf die jeweiligen Preset-Knoten, z. B.: `"fieldPresets": [ "inquiry.fieldPreset.firstName", "inquiry.fieldPreset.lastName" ]` Wenn keine globalen Feldvorgaben verwendet werden sollen, ist der Wert `null` zu setzen.
`fields`	list (object)	Liste der Eingabefelder, die im Formular abgefragt werden sollen
`name`	string	Technischer Feldname (Key).
`label`	string	Anzeigename im Formular.
`required`	bool	Pflichtfeldkennzeichen (`true`/`false`). Default: `false`
`validations`	multiService	Liste von Validierungsregeln für das Feld. Optional. target: `InputValidation`
`service`	--	Validierungsdienst, z. B. `dataChecker.minLength`, `dataChecker.maxLength`. Jeder Eintrag verweist auf einen Knoten unter `dataChecker` Übersicht der verfügbaren Validierungs- und Prüfregeln für Formularfelder finden Sie hier.
`options`	--	Optionsobjekt zur Regelkonfiguration, z. B. `{ "len": 200 }`.
`captcha`	singleService	Objekt für die Captcha-Konfiguration (Spam-/Bot-Schutz). Optional.
`service`	--	Enthält den Service-Namen, z. B. `captchaCheck.recaptchav3`. Jeder Eintrag verweist auf einen Knoten unter `captcha`.
`inquiryEmail`	object	Objekt für den E-Mail-Versand der Anfrage.
`fromAddress`	string	Absender-E-Mailadresse.
`fromName`	string	Absender-Anzeigename.
`merchantEmail`	string	Interne Ziel-E-Mail-Adresse (Händler/Service).
`subject`	string	Betreffzeile der ausgehenden Nachricht.
`template`	string	Name der HTML-Datei für das E-Mail-Template, z. B. `contact.htm`.

3. `inquiry.fieldPreset` - Globale Felddefinitionen

Der Knoten inquiry.fieldPreset dient zur zentralen Definition von wiederverwendbaren Formularfeldern.

Über diese globalen Feldvorgaben können standardisierte Felder (z. B. Vorname, Nachname, E-Mail-Adresse, Telefonnummer) einmalig definiert und anschließend in mehreren Formularen eingebunden werden.

Ein einzelner Preset-Knoten unterhalb von inquiry.fieldPreset enthält die vollständige Felddefinition analog zu den Feldobjekten innerhalb der jeweiligen Formular-Konfiguration (inquiry.form.<name>.fields).

Die Einbindung erfolgt über den Parameter fieldPresets im entsprechenden Formular, indem auf die Preset-Namen verwiesen wird.

Beispielkonfiguration für alle `inquiry.fieldPreset`

{
      "firstName": {
        "label": "Vorname",
        "name": "firstName",
        "required": true,
        "validations": [
          {
            "service": "dataChecker.minLength",
            "options": { "len": 1 }
          },
          {
            "service": "dataChecker.maxLength",
            "options": { "len": 50 }
          }
        ]
      },
      "lastName": {
        "label": "Nachname",
        "name": "lastName",
        "required": true,
        "validations": [
          {
            "service": "dataChecker.minLength",
            "options": { "len": 1 }
          },
          {
            "service": "dataChecker.maxLength",
            "options": { "len": 50 }
          }
        ]
      }
    }

Parameterübersicht

Parameter	Typ	Beschreibung

Parameter	Typ	Beschreibung
`label`	string	Anzeigename des Feldes im Formular.
`name`	string	Technischer Feldname (Key) – wird für Datenübergabe und E-Mail-Ausgabe verwendet.
`required`	bool	Pflichtfeldkennzeichen (`true`/`false`). default: `false`
`validations`	multiService	Liste der Validierungsregeln für das Feld. Optional.
`service`	--	Name des Validierungsdienstes, z. B. `dataChecker.minLength`, `dataChecker.maxLength`. Übersicht der verfügbaren Validierungs- und Prüfregeln für Formularfelder finden Sie hier.
`options`	--	Parameterobjekt zur Definition der Regel, z. B. `{ "len": 50 }`.

inquiry - Formulare

Inhaltsverzeichnis

1. inquiry* - Grundstruktur

Parameterbeschreibung

2. inquiry.form - Formular-Konfiguration

Beispielkonfiguration für ein Kontaktformular (inquiry.form.contact)

Parameterbeschreibung

3. inquiry.fieldPreset - Globale Felddefinitionen

Beispielkonfiguration für alle inquiry.fieldPreset

Parameterübersicht

1. `inquiry*` - Grundstruktur

2. `inquiry.form` - Formular-Konfiguration

Beispielkonfiguration für ein Kontaktformular (`inquiry.form.contact`)

3. `inquiry.fieldPreset` - Globale Felddefinitionen

Beispielkonfiguration für alle `inquiry.fieldPreset`