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 Endpunkt inquiries/ ermöglicht es, Anfrage-Daten abzufragen sowie zu löschen und ihren Status zu aktualisieren.

​
Unterstützte Methoden

Angabe aller unterstützten Methoden.
Befehl/InfoEndpunkteGETPOSTPUTDELETE
Anfrageninquiries/

​
Datenfelder

NameTypBedeutung
idStringEindeutige ID der Anfrage
subshopIdStringAngabe des Subshops, in dem die Anfrage eingegangen ist (z. B. „deutsch“)
processingStatusINTBearbeitungsstatus der Anfrage: - 0 = New (neu eingegangen) - 1 = Read (gelesen) - 2 = Answered (beantwortet) - 3 = Closed (abgeschlossen)
dataObjektEnthält Formularfelder und zusätzliche Meta-Daten der Anfrage als JSON-Objekt
data.fieldsArrayEnthält den technischen Namen des Feldes, sein Label (Bezeichnung) und den übergebenen Wert
data.inquiryConfigIdStringID der Konfiguration, über die das Anfrageformular erstellt wurde
data.inquiryIdStringEindeutige ID der Anfrage
data.shopIdStringTechnischer Name des Shops
data.submitterObjektEnthält die E-Mail-Adresse, die IP-Adresse und die ID der Session des Einsenders
data.subshopIdStringAngabe des Subshops, in dem die Anfrage eingegangen ist (z. B. „deutsch“)
createdAtStringDatum und Uhrzeit der Erstellung der Anfrage (im ISO 8601-Format, UTC)
updatedAtStringDatum und Uhrzeit der letzten Änderung der Anfrage (im ISO 8601-Format, UTC)

​
Beispiel

{
    "createdAt": "2024-10-11T12:03:48Z",
    "data": {
        "fields": [
            {
                "label": "Vorname",
                "name": "firstName",
                "value": "Foo"
            },
            {
                "label": "Nachname",
                "name": "lastName",
                "value": "Bar"
            },
            {
                "label": "Betreff",
                "name": "subject",
                "value": "mySubject"
            },
            {
                "label": "Kundennummer",
                "name": "customerNumber",
                "value": "11"
            },
            {
                "label": "Text",
                "name": "text",
                "value": "myMessage"
            }
        ],
        "inquiryConfigId": "contact",
        "inquiryId": "4dea07ff679aa8b4",
        "shopId": "myshop",
        "submitter": {
            "emailAddress": "email@email.com",
            "ipAddress": "172.18.0.XXX",
            "sessionId": "cf41e72fadae3eaeb0aeca63d..."
        },
        "subshopId": "deutsch"
    },
    "id": "4dea07ff679aa8b4",
    "processingStatus": 0,
    "subshopId": "deutsch",
    "updatedAt": "2024-10-11T12:03:48Z"
}

​
Verwendung der Methoden

​
GET inquiries

Ruft eine Liste aller vorhandenen Anfragen ab – mit Filter- und Sortiermöglichkeiten.

​
Beispiel

https://www.<ihr-shop>.de/admin/api/v1/inquiries

​
Antwort

{
    "endReached": true,
    "items": [
        {
            "createdAt": "2024-10-11T12:03:48Z",
            "data": {
                "fields": [
                    {
                        "label": "Vorname",
                        "name": "firstName",
                        "value": "Foo"
                    },
                    ...
                ],
                "inquiryConfigId": "contact",
                "inquiryId": "4dea07ff679aa8b4",
                "shopId": "myshop",
                "submitter": {
                    "emailAddress": "email@email.com",
                    "ipAddress": "172.18.0.XXX",
                    "sessionId": "cf41e72fadae3eaeb0aeca63d..."
                },
                "subshopId": "deutsch"
            },
            "id": "4dea07ff679aa8b4",
            "processingStatus": 0,
            "subshopId": "deutsch",
            "updatedAt": "2024-10-11T12:03:48Z"
        },
        ...
    ],
    "nextPageToken": "NQ",
    "totalCount": 6
}

​
Filterfelder

createdAt, updatedAt, id, subshopId, processingStatus, inquiryConfigId

​
Sortierfelder

createdAt, updatedAt, id, subshopId, processingStatus

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Anfragen.
400 Bad Request”invalidValue”size ∉ [1;300]pageToken ist keine Zahl oder kleiner als 0.
400 Bad Request”unknownDataField”Ein Filter- oder Sortierfeld ist ungültig.
400 Bad Request”unknownOperation”Ein Filtertyp ist ungültig.
400 Bad Request”invalidCharacters”size ist keine Ganzzahl.
Ein Filterwert ist ungültig.
400 Bad Request”syntaxError”sort enthält mehr als einen oder keinen ”:“.
503 Service Unavailable”internalError”Nicht alle Anfragen konnten entschlüsselt werden.

​
GET inquiries/

Ruft die Details einer einzelnen Anfrage anhand ihrer ID ab.

​
Beispiel

https://www.<ihr-shop>.de/admin/api/v1/inquiries/4dea07ff679aa8b4

​
Antwort

{
    "createdAt": "2024-10-11T12:03:48Z",
    "data": {
        "fields": [
            {
                "label": "Vorname",
                "name": "firstName",
                "value": "Foo"
            },
            {
                "label": "Nachname",
                "name": "lastName",
                "value": "Bar"
            },
            {
                "label": "Betreff",
                "name": "subject",
                "value": "mySubject"
            },
            {
                "label": "Kundennummer",
                "name": "customerNumber",
                "value": "11"
            },
            {
                "label": "Text",
                "name": "text",
                "value": "myMessage"
            }
        ],
        "inquiryConfigId": "contact",
        "inquiryId": "4dea07ff679aa8b4",
        "shopId": "myshop",
        "submitter": {
            "emailAddress": "email@email.com",
            "ipAddress": "172.18.0.XXX",
            "sessionId": "cf41e72fadae3eaeb0aeca63d..."
        },
        "subshopId": "deutsch"
    },
    "id": "4dea07ff679aa8b4",
    "processingStatus": 0,
    "subshopId": "deutsch",
    "updatedAt": "2024-10-11T12:03:48Z"
}

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Anfragen.
404 Not FoundDie Anfrage wurde nicht gefunden.
503 Service Unavailable”internalError”Die Anfrage konnte nicht entschlüsselt werden.

​
GET inquiries/open

Dieser Endpunkt liefert eine Übersicht über die Anzahl offener Anfragen, gruppiert nach Anfragekonfigurationen. Die Antwort enthält eine Liste von Objekten, wobei jedes Objekt die Anzahl offener Anfragen (count) sowie die zugehörige Anfragekonfiguration (inquiryConfigId) angibt.

​
Beispiel

https://www.<ihr-shop>.de/admin/api/v1/inquiries/open

​
Antwort

{
    "items": [
        {
            "count": 3,
            "inquiryConfigId": "catalogue"
        },
        {
            "count": 15,
            "inquiryConfigId": "contact"
        },
        {
            "count": 1,
            "inquiryConfigId": "productQuestion"
        },
        {
            "count": 1,
            "inquiryConfigId": "returnInquiry"
        }
    ]
}

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Lesen von Anfragen.
503 Service Unavailable”internalError”Anfragen konnten nicht geladen werden.

​
PUT inquiries/

Aktualisiert den Bearbeitungsstatus einer bestimmten Anfrage. Mögliche Werte für processingStatus:
  • 0 = New
  • 1 = Read
  • 2 = Answered
  • 3 = Closed

​
Beispiel

https://www.<ihr-shop>.de/admin/api/v1/inquiries/bda4c9c28ebc6920

​
Request Body

{
    "processingStatus": 1
}

​
Antwort

{
    "createdAt": "2024-10-11T12:03:48Z",
    "data": {
        "fields": [
            {
                "label": "Vorname",
                "name": "firstName",
                "value": "Foo"
            }
        ],
        "inquiryConfigId": "contact",
        "inquiryId": "bda4c9c28ebc6920",
        "shopId": "myshop",
        "submitter": {
            "emailAddress": "email@email.com",
            "ipAddress": "172.18.0.XXX",
            "sessionId": "cf41e72fadae3eaeb0aeca63d..."
        },
        "subshopId": "deutsch"
    },
    "id": "bda4c9c28ebc6920",
    "processingStatus": 1,
    "subshopId": "deutsch",
    "updatedAt": "2024-10-11T12:05:00Z"
}

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Schreiben von Anfragen.
400 Bad RequestRequest-Body konnte nicht als JSON geladen werden.
Das Aktualisieren ist fehlgeschlagen.
400 Bad Request”missing”processingStatus wurde nicht übergeben.
400 Bad Request”unknownDataField”Es wird versucht, ein unbekanntes Feld zu übergeben. Nur processingStatus ist erlaubt.
400 Bad Request”invalidFormat”processingStatus ist keine Zahl.
400 Bad Request”invalidValue”processingStatus ist außerhalb des gültigen Bereichs (0–3).
404 Not FoundDie Anfrage wurde nicht gefunden.
503 Service Unavailable”internalError”Die Anfrage konnte nicht entschlüsselt werden.

​
DELETE inquiries/

Löscht eine bestimmte Anfrage dauerhaft.

​
Beispiel

https://www.<ihr-shop>.de/admin/api/v1/inquiries/bda4c9c28ebc6920

​
Antwort

{
    "success": true
}

​
Fehlercodes

FehlerTypGrund
401 UnauthorizedNicht autorisiert: Sie sind nicht angemeldet oder verfügen nicht über die erforderlichen Rechte zum Löschen von Anfragen.
404 Not FoundDie Anfrage wurde nicht gefunden.

​
Support

Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum Kundenportal Bitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.