Storefront API Formulare

GET https://<ihr-shop>.de/api/v1/form/getAll

[
  {
    "email": {
      "fromAddress": "contact@myshop.de",
      "fromName": "myshop Versender",
      "merchantEmail": "dev-test@websale.de",
      "subject": "Ihre Kontaktanfrage wurde aufgenommen.",
      "template": "contact.htm"
    },
    "fields": [
      { "label": "Vorname", "name": "firstName", "required": false, "validations": [ { "name": "minLength", "type": "dataChecker" }, { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Nachname", "name": "lastName", "required": false, "validations": [ { "name": "minLength", "type": "dataChecker" }, { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Betreff", "name": "subject", "required": true,  "validations": [ { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Kundennummer", "name": "customerNumber", "required": false, "validations": [ { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Text", "name": "text", "required": true, "validations": [ { "name": "minLength", "type": "dataChecker" }, { "name": "maxLength", "type": "dataChecker" } ] }
    ],
    "name": "contact"
  },
  {
    "email": {
      "fromAddress": "contact@myshop.de",
      "fromName": "myshop Versender",
      "merchantEmail": "dev-test@websale.de",
      "subject": "Ihre Kontaktanfrage wurde aufgenommen.",
      "template": "contact.htm"
    },
    "fields": [
      { "label": "Vorname", "name": "firstName", "required": false, "validations": [ { "name": "minLength", "type": "dataChecker" }, { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Nachname", "name": "lastName", "required": false, "validations": [ { "name": "minLength", "type": "dataChecker" }, { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Betreff", "name": "subject", "required": true,  "validations": [ { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Kundennummer", "name": "customerNumber", "required": false, "validations": [ { "name": "maxLength", "type": "dataChecker" } ] },
      { "label": "Text", "name": "text", "required": true, "validations": [ { "name": "minLength", "type": "dataChecker" }, { "name": "maxLength", "type": "dataChecker" } ] }
    ],
    "name": "contact_friendlycaptcha"
  }
]

GET https://<ihr-shop>.de/api/v1/form/get?formId=contact

{
  "email": {
    "fromAddress": "contact@myshop.de",
    "fromName": "myshop Versender",
    "merchantEmail": "dev-test@websale.de",
    "subject": "Ihre Kontaktanfrage wurde aufgenommen.",
    "template": "contact.htm"
  },
  "fields": [
    {
      "label": "Vorname",
      "name": "firstName",
      "required": false,
      "validations": [
        { "name": "minLength", "type": "dataChecker" },
        { "name": "maxLength", "type": "dataChecker" }
      ]
    },
    {
      "label": "Nachname",
      "name": "lastName",
      "required": false,
      "validations": [
        { "name": "minLength", "type": "dataChecker" },
        { "name": "maxLength", "type": "dataChecker" }
      ]
    },
    {
      "label": "Betreff",
      "name": "subject",
      "required": true,
      "validations": [
        { "name": "maxLength", "type": "dataChecker" }
      ]
    },
    {
      "label": "Kundennummer",
      "name": "customerNumber",
      "required": false,
      "validations": [
        { "name": "maxLength", "type": "dataChecker" }
      ]
    },
    {
      "label": "Text",
      "name": "text",
      "required": true,
      "validations": [
        { "name": "minLength", "type": "dataChecker" },
        { "name": "maxLength", "type": "dataChecker" }
      ]
    }
  ],
  "name": "contact"
}

GET https://<ihr-shop>.de/api/v1/form/getField?formId=contact&fieldId=firstName

{
  "label": "Vorname",
  "name": "firstName",
  "required": false,
  "validations": [
    { "name": "minLength", "type": "dataChecker" },
    { "name": "maxLength", "type": "dataChecker" }
  ]
}

GET https://<ihr-shop>.de/api/v1/form/loadInquiry?inquiryId=7930f7e9fa7bb07b

{
  "createdAt": "2025-11-11T14:36:03Z",
  "form": {
    "customerNumber": { "label": "Kundennummer", "value": "" },
    "firstName":      { "label": "Vorname",      "value": "Eren" },
    "lastName":       { "label": "Nachname",     "value": "Jäger" },
    "subject":        { "label": "Betreff",      "value": "Wichtige Mitteilung" },
    "text":           { "label": "Text",         "value": "tatakae!" }
  },
  "formId": "contact",
  "id": "7930f7e9fa7bb07b",
  "submitter": {
    "email": "test@example.de",
    "ipAddress": "172.18.0.XXX",
    "sessionId": "4d1536fe...cd07d"
  }
}

POST https://<ihr-shop>.de/api/v1/form/send

{
  "formId": "contact",
  "email": "test@example.de",
  "form": {
    "firstName": "Eren",
    "lastName": "Jäger",
    "subject": "Wichtige Mitteilung",
    "text": "tatakae!"
  }
}

{
  "inquiryId": "7930f7e9fa7bb07b"
}