Storefront API Konfigurationen - WEBSALE Dokumentation

Die Konfiguration API liefert plattform- und subshopspezifische Einstellungen, die für Darstellung und Verhalten der Storefront relevant sind. Typische Inhalte sind globale Shop-Einstellungen (z. B. ShopID, Länderlisten, Anreden), Subshop-spezifische Werte (z. B. Sprache, Währung, Preisformatierung) sowie steuerrelevante Parameter wie Brutto-/Nettoanzeige oder Mehrwertsteuerkontext. Eine vollständige Übersicht aller verfügbaren Konfigurationseinstellungen der Shopplattform ist in der Dokumentation Konfiguration beschrieben.

Unterstützte Methoden

Angabe aller unterstützten Methoden.

Befehl	Endpunkte	GET	PUT	POST	DELETE
Konfigurierte Adresslisten abfragen	`config/adress_lists`
Konfigurierte Einwilligungsgruppen abfragen	`config/consent`
Konfigurierte Länder + ISO-Codes abfragen	`config/countries`
Konfigurierte Shop-Währungen abfragen	`config/currency`
Konfiguration für Direktbestellungen abfragen	`config/directOrder`
Aktive Passwortregeln des Shops abfragen	`config/password`
Verfügbare Zahlungsarten abfragen	`config/paymentMethods`
Konfigurierte Anreden abfragen	`config/salutation`
Verfügbare Versandarten abfragen	`config/shippingMethods`
Konfigurierte Titel für Kunden abfragen	`config/title`
Die aktuelle Subshop-ID abfragen	`subshop/current`
Verfügbare Subshops abfragen	`subshop/list`
Vollständige Subshop-URL abfragen	`subshop/url`

Methoden für die Konfiguration

Mithilfe dieser Methoden können zentrale Shop-Konfigurationen für die Storefront bereitgestellt werden. Sie liefern alle Auswahllisten und Stammdaten, die zum Aufbau von Formularen und Prozessen benötigt werden, darunter vordefinierte Auswahlfelder für Rechnungs- und Lieferadressen, Länder, Währungen, Anreden und Titel. Zudem können checkoutspezifische Einstellungen wie verfügbare Zahlungs- und Versandarten, Direktbestellparameter (Schnelleingabe per Artikelnummer) sowie Passwortregeln (Längenbeschränkungen, zusätzliche Prüfungen) ausgelesen und direkt in der UI berücksichtigt werden. Über die Consent-Konfiguration lassen sich Einwilligungsgruppen und -dienste (z. B. Captcha, Tracking, Medien, Service-E-Mails) samt aktuellem Zustimmungsstatus einsehen. Damit können Consent-Dialoge, Datenschutzeinstellungen und das Nachladen externer Dienste gesteuert werden.

GET config/addressLists

Der folgende Aufruf liefert die konfigurierten Auswahlfelder für Rechnungs- und Lieferadressen. Außerdem ist darin vermerkt, welcher Wert standardmäßig vorausgewählt ist. Die Konfiguration erfolgt unter general.addressListElements. Kann zum Aufbau der Adressformulare (Dropdowns/Radiobuttons inkl. Voreinstellung) bei Konto, Checkout und Adressverwaltung verwendet werden. Beispiel-Aufruf, der alle konfigurierten Auswahlfelder zurückliefert:

GET https://<ihr-shop>.de/api/v1/config/address_lists

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "bill": {
    "companyType": {
      "defaultValue": "1",
      "values": [
        { "name": "Privat", "value": "1" },
        { "name": "Firma",  "value": "2" }
      ]
    }
  },
  "delivery": {
    "addressType": {
      "defaultValue": "1",
      "values": [
        { "name": "Privat",      "value": "1" },
        { "name": "Packstation", "value": "3" }
      ]
    }
  }
}

Der folgende Aufruf liefert die im Shop definierten Einwilligungsgruppen (z. B. Captcha) samt der darin enthaltenen Dienste (z. B. Google reCAPTCHA). Jede Gruppe und jeder Dienst haben unter anderem ein Label, eine interne Kennung, eine Beschreibung sowie den aktuellen Zustimmungsstatus. Er kann verwendet werden, um den Consent-Dialog und die Datenschutzeinstellungen aufzubauen, Gruppen/Dienste anzuzeigen, aktuelle Zustimmungen zu lesen und UI-Schalter entsprechend vorzubelegen. Außerdem kann damit erreicht werden, dass Embeds/Tracker erst nach Einwilligung geladen werden. Beispiel-Aufruf, der alle im Shop definierten Einwilligungsgruppen lädt

GET https://<ihr-shop>.de/api/v1/config/consent

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "groups": [
    {
      "allowed": false,
      "description": "Sind Sie überhaupt ein Mensch?",
      "label": "Captcha",
      "name": "captcha",
      "services": [
        {
          "allowed": false,
          "description": "Google prüft gerne im Austausch Ihrer Daten ob Sie ein Mensch oder Roboter sind.",
          "label": "Google reCAPTCHA v3",
          "name": "recaptchav3"
        },
        {
          "allowed": false,
          "description": "Bist du ein Roboter? Wenn nein wird es nicht schwierig.",
          "label": "Friendly Captcha V1",
          "name": "friendlyCaptchaV1"
        }
      ]
    },
    {
      "allowed": false,
      "description": "Medien liegen uns am Herzen!",
      "label": "Medien",
      "name": "media",
      "services": [
        {
          "allowed": false,
          "description": "Wir haben ein Video auf Youtube über uns, das wir Ihnen gerne zeigen würden.",
          "label": "Youtube Videos",
          "name": "youtube"
        }
      ]
    },
    {
      "allowed": false,
      "description": "wir bieten verschiedene Dienstleistungen an",
      "label": "ShopService",
      "name": "shopService",
      "services": [
        {
          "allowed": false,
          "description": "Sind Sie damit einverstanden, eine E-Mail zur Bewertung der Bestellungen zu erhalten?",
          "label": "Rate Reminder",
          "name": "ratereminder"
        }
      ]
    },
    {
      "allowed": false,
      "description": "",
      "label": "Tracking",
      "name": "tracking",
      "services": [
        { "allowed": false, "description": "", "label": "Econda Analytics", "name": "econda" },
        { "allowed": false, "description": "", "label": "Google Analytics", "name": "google" }
      ]
    }
  ],
  "services": [
    { "allowed": false, "description": "", "label": "Econda Analytics", "name": "econda" },
    { "allowed": false, "description": "Bist du ein Roboter? Wenn nein wird es nicht schwierig.", "label": "Friendly Captcha V1", "name": "friendlyCaptchaV1" },
    { "allowed": false, "description": "", "label": "Google Analytics", "name": "google" },
    { "allowed": false, "description": "Sind Sie damit einverstanden, eine E-Mail zur Bewertung der Bestellungen zu erhalten?", "label": "Rate Reminder", "name": "ratereminder" },
    { "allowed": false, "description": "Google prüft gerne im Austausch Ihrer Daten ob Sie ein Mensch oder Roboter sind.", "label": "Google reCAPTCHA v3", "name": "recaptchav3" },
    { "allowed": false, "description": "Wir haben ein Video auf Youtube über uns, das wir Ihnen gerne zeigen würden.", "label": "Youtube Videos", "name": "youtube" }
  ]
}

GET config/countries

Der folgende Aufruf liefert die im Shop konfigurierten Länder inklusive ihrer ISO-Codes und Anzeigenamen. Er kann zur Befüllung von Länder-Dropdowns (Adresse, Checkout), für Validierungen sowie zur Filterung/Steuerung länderspezifischer Prozesse verwendet werden. Beispiel-Aufruf, der alle im Shop konfigurierten Länder auflistet:

GET https://<ihr-shop>.de/api/v1/config/countries

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "items": [
    { "isoAlpha2": "DE", "isoAlpha3": "DEU", "isoNum": "276", "name": "Deutschland" },
    { "isoAlpha2": "AT", "isoAlpha3": "AUT", "isoNum": "040", "name": "Österreich" },
    { "isoAlpha2": "CH", "isoAlpha3": "CHE", "isoNum": "756", "name": "Schweiz" },
    { "isoAlpha2": "BE", "isoAlpha3": "BEL", "isoNum": "056", "name": "Belgien" },
    { "isoAlpha2": "IT", "isoAlpha3": "ITA", "isoNum": "380", "name": "Italien" },
    { "isoAlpha2": "PL", "isoAlpha3": "POL", "isoNum": "616", "name": "Polen" },
    { "isoAlpha2": "NL", "isoAlpha3": "NLD", "isoNum": "528", "name": "Niederlande" }
  ]
}

GET config/currency

Der folgende Aufruf liefert die aktuell im Shop konfigurierte Währung inklusive ISO-Code, ISO-Nummer und Währungssymbol. Er kann für Preisformatierungen, die Anzeige im Warenkorb/Checkout und für Validierungen (z. B. bei Gutscheinen oder Versandkosten) verwendet werden.

GET https://<ihr-shop>.de/api/v1/config/currency

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "isoCode": "EUR",
  "isoNum": "978",
  "symbol": "€"
}

GET config/directOrder

Der folgende Aufruf liefert die Shop-Konfiguration für die Direktbestellung (Schnelleingabe per Artikelnummer). Beispielsweise wird festgelegt, wie viele Anzeigereihen initial angezeigt werden, wie eine Artikelnummer aufgebaut ist (Feld/Trenner) und welche Obergrenzen gelten. Er kann zum Aufbau der Direktbestell-Maske verwendet werden. Beispiel-Aufruf, der die Shop-Konfiguration für die Direktbestellung lädt

GET https://<ihr-shop>.de/api/v1/config/directOrder

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "initialNumber": 5,
  "itemNumberFields": [
    { "name": "firstField",  "required": true,  "type": "field" },
    { "sign": "-",           "type": "separator" },
    { "name": "secondField", "required": false, "type": "field" }
  ],
  "maximalNumber": 1000,
  "refreshedNumber": 5
}

GET config/password

Folgender Aufruf liefert die aktiven Passwortregeln des Shops (z. B. Mindest-/Maximallänge, zusätzliche Prüfungen). Diese Regeln stammen aus den konfigurierten Validierungs-Services (Validierungs- und Prüfservices). Er kann zur Anzeige und Prüfung bei Passwort-Formularen (Registrierung, Passwort ändern/zurücksetzen) verwendet werden, damit die Eingaben bereits clientseitig die Shop-Vorgaben erfüllen.

GET https://<ihr-shop>.de/api/v1/config/password

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "checkLoginID": true,
  "checkOldPassword": true,
  "passwordChecks": {
    "maxLength": { "len": 15 },
    "minLength": { "len": 3 }
  }
}

GET config/paymentMethods

Der folgende Aufruf liefert die im Shop verfügbaren Zahlungsarten als Liste (jeweils mit technischer ID und Anzeigenamen). Er kann zum Befüllen der Zahlungsarten-Auswahl im Checkout verwendet werden. Beispiel-Aufruf, der alle im Shop verfügbaren Zahlungsarten auflistet

GET https://<ihr-shop>.de/api/v1/config/paymentMethods

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "items": [
    { "id": "applepay", "name": "Apple Pay" },
    { "id": "bill", "name": "Rechnung" },
    { "id": "creditcard", "name": "Credit Card" },
    { "id": "googlepay", "name": "Google Pay" },
    { "id": "maxpayment", "name": "Max Rechnung" },
    { "id": "minpayment", "name": "Min Rechnung" },
    { "id": "paypalCheckout", "name": "PayPal Checkout" },
    { "id": "paypalCheckoutApplePay", "name": "PayPal Checkout (Apple Pay)" },
    { "id": "paypalCheckoutBanContact", "name": "PayPal Checkout (BanContact)" },
    { "id": "paypalCheckoutBlik", "name": "PayPal Checkout (Blik)" },
    { "id": "paypalCheckoutCreditCard", "name": "PayPal Checkout (Credit Card)" },
    { "id": "paypalCheckoutEps", "name": "PayPal Checkout (EPS)" },
    { "id": "paypalCheckoutGiroPay", "name": "PayPal Checkout (GiroPay)" },
    { "id": "paypalCheckoutGooglePay", "name": "PayPal Checkout (Google Pay)" },
    { "id": "paypalCheckoutIdeal", "name": "PayPal Checkout (Ideal)" },
    { "id": "paypalCheckoutInvoice", "name": "PayPal Checkout (Invoice)" },
    { "id": "paypalCheckoutMyBank", "name": "PayPal Checkout (MyBank)" },
    { "id": "paypalCheckoutPayLater", "name": "PayPal Checkout (PayLater)" },
    { "id": "paypalCheckoutPrzelewy24", "name": "PayPal Checkout (Przelewy24)" },
    { "id": "paypalCheckoutSepa", "name": "PayPal Checkout (SEPA)" },
    { "id": "paypalCheckoutSofort", "name": "PayPal Checkout (Sofort)" },
    { "id": "paypalPlus", "name": "PayPal Plus" },
    { "id": "prepayment", "name": "Vorauskasse" },
    { "id": "safepayment", "name": "Sichere Zahlungsart" },
    { "id": "stripe", "name": "Stripe" },
    { "id": "twint", "name": "Twint" }
  ]
}

GET config/salutation

Der folgende Aufruf liefert die im Shop konfigurierten Anreden (jeweils mit Code und Anzeigetext). Er kann zum Befüllen von Auswahllisten in Formularen verwendet werden. Beispiel-Aufruf, der die im Shop konfigurierten Anreden auflistet:

GET https://<ihr-shop>.de/api/v1/config/salutation

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "items": [
    { "code": "1", "text": "Herr" },
    { "code": "2", "text": "Frau" },
    { "code": "3", "text": "Familie" },
    { "code": "4", "text": "Firma" }
  ]
}

GET config/shippingMethods

Der folgende Aufruf liefert alle im Shop verfügbaren Versandarten mit technischer ID, Anzeigenamen und Typ. Er kann zum Befüllen der Versandarten-Auswahl im Checkout oder zur Anzeige verfügbarer Lieferoptionen auf Infoseiten verwendet werden. Beispiel-Aufruf, der alle im Shop verfügbaren Versandarten auflistet:

GET https://<ihr-shop>.de/api/v1/config/shippingMethods

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "items": [
    { "id": "pickup",  "name": "Click & Collect",   "type": "pickup"   },
    { "id": "dhl",     "name": "DHL",               "type": "standard" },
    { "id": "digital", "name": "Digitaler Versand", "type": "standard" },
    { "id": "hermes",  "name": "Hermes",            "type": "standard" }
  ]
}

GET config/title

Mit dem folgenden Aufruf werden die konfigurierten Titel (z. B. akademische Titel) für die Kunden- und Adressformulare geliefert. Er kann zum Befüllen von Titel-Auswahllisten in Formularen verwendet werden. Beispiel-Aufruf, der alle im Shop konfigurierten Titel auflistet

GET https://<ihr-shop>.de/api/v1/config/title

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "items": [
    { "code": "1", "text": "" },
    { "code": "2", "text": "Dr." },
    { "code": "3", "text": "Prof." }
  ]
}

Methoden der Subshop Konfigurationen

Mithilfe dieser Methoden kann die Konfiguration des Subshops im Storefront-Kontext verwaltet werden. Sie ermitteln die aktuell aktive Subshop-ID (z. B. für Sprache oder Land), listen alle verfügbaren Subshops auf und erzeugen für einen angegebenen Subshop eine vollständige Ziel-URL.

GET subshop/current

Mit dem folgenden Aufruf wird die aktuelle Subshop-ID zum Auslesen des aktiven Subshops für sprach-/land- oder themenspezifische Inhalte, URLs und Konfigurationen an die aufrufende Storefront zurückgegeben. Beispiel-Aufruf, der die aktuelle Subshop-ID der aufrufenden Storefront zurückgibt

GET https://<ihr-shop>.de/api/v1/subshop/current

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "id": "deutsch"
}

GET subshop/list

Der folgende Aufruf liefert eine Liste mit allen im Shop verfügbaren Subshops. Er kann zum Aufbauen von Sprach-/Länderauswahlen, zum Umschalten zwischen Subshops oder für das Routing/den Linkaufbau je Subshop verwendet werden. Beispiel-Aufruf, der eine Liste der verfügbaren Subshops liefert:

GET https://<ihr-shop>.de/api/v1/subshop/list

Parameterübersicht

Parameter	Typ	Beschreibung
—	—	Keine zusätzlichen Parameter.

Beispiel-Response

{
  "items": [
    "deutsch",
    "english"
  ]
}

GET subshop/url

Folgender Aufruf liefert die vollständige Shop-URL für einen angegebenen Subshop und übernimmt optional Zusatzparameter in die Query. Er kann für den Sprach-/Länderwechsel oder zum Generieren von Links (inkl. optionaler Parameter) verwendet werden. Beispiel-Aufruf, der einen Link für den Subshop mit der ID <ID>und hängt die zusätzlichen Parameter value1&param und value2 an.

GET https://<ihr-shop>.de/api/v1/subshop/url?subshopId=<ID>&param[key]=value

Parameterübersicht

Body-Parameter

Paramter	Typ	Beschreibung
`subshopId`	string	ID des Ziel-Subshops (z.b. `english`)
`param[…]`	string	Beispiel: `param[key1]=value1&param[key2]=value2`

Beispiel-Response

{
  "url": "https://en.<ihr-shop>.com/?key=value&foo=bar"
}

Schnittstellen

Admin Interface API

Storefront API

Weitere

Documentation Index

​Unterstützte Methoden

​Methoden für die Konfiguration

​GET config/addressLists

​Parameterübersicht

​Beispiel-Response

​GET config/consent

​Parameterübersicht

​Beispiel-Response

​GET config/countries

​Parameterübersicht

​Beispiel-Response

​GET config/currency

​Parameterübersicht

​Beispiel-Response

​GET config/directOrder

​Parameterübersicht

​Beispiel-Response

​GET config/password

​Parameterübersicht

​Beispiel-Response

​GET config/paymentMethods

​Parameterübersicht

​Beispiel-Response

​GET config/salutation

​Parameterübersicht

​Beispiel-Response

​GET config/shippingMethods

​Parameterübersicht

​Beispiel-Response

​GET config/title

​Parameterübersicht

​Beispiel-Response

​Methoden der Subshop Konfigurationen

​GET subshop/current

​Parameterübersicht

​Beispiel-Response

​GET subshop/list

​Parameterübersicht

​Beispiel-Response

​GET subshop/url

​Parameterübersicht

​Body-Parameter

​Beispiel-Response

Unterstützte Methoden

Methoden für die Konfiguration

GET config/addressLists

Parameterübersicht

Beispiel-Response

GET config/consent

Parameterübersicht

Beispiel-Response

GET config/countries

Parameterübersicht

Beispiel-Response

GET config/currency

Parameterübersicht

Beispiel-Response

GET config/directOrder

Parameterübersicht

Beispiel-Response

GET config/password

Parameterübersicht

Beispiel-Response

GET config/paymentMethods

Parameterübersicht

Beispiel-Response

GET config/salutation

Parameterübersicht

Beispiel-Response

GET config/shippingMethods

Parameterübersicht

Beispiel-Response

GET config/title

Parameterübersicht

Beispiel-Response

Methoden der Subshop Konfigurationen

GET subshop/current

Parameterübersicht

Beispiel-Response

GET subshop/list

Parameterübersicht

Beispiel-Response

GET subshop/url

Parameterübersicht

Body-Parameter

Beispiel-Response