⚠️ Hinweis:
Dieser Endpunkt ist aktuell nur kompatibel, wenn die Zuordnung zu Bestellungen aus folgenden Shop-Datenquellen in Klar erfolgt: Shopify, Shopware 5 & 6, Oxid, WooCommerce und Centra.
Für alle anderen Anwendungsfälle bitte das Kundensupport-Team über den In-App-Chat oder via [email protected] kontaktieren.
1. Basis-URL und Versionierung
Die Basis-URL der Klar API ist https://open-api.getklar.com/ gefolgt von einer Versionszeichenfolge, z.B. 06.2024.
Gut zu wissen: Eine vollständige Definition der API-Endpunkte und der verfügbaren Versionen ist in unserer automatisch generierten API-Spezifikation zu finden.
2. Endpunktübersicht und allgemeine Informationen
Gut zu wissen: Wenn ein Feld in der API-Spezifikation als erforderlich gekennzeichnet ist, muss es in der Übermittlung vorhanden sein. Ist es nicht erforderlich, aber vorhanden, muss es einen gültigen Wert haben, z.B. darf cancelledAt nicht mit einem Wert 0 übermittelt werden und muss auf undefined gesetzt werden.
Die Transaktionskosten-API bietet folgende Endpunkte:
POST /<VERSION>/transaction-costs/json
GET /transaction-costs/status
POST /<VERSION>/transaction-costs/json
Dieser Endpunkt ermöglicht das Hochladen der Zahlungs- und Transaktionskostendaten an Klar.
Der Anfragetext sollte ein JSON-Objekt enthalten, das ein Array von bis zu 1000 JSON-Objekten vom Typ TransactionCosts enthalten kann.
Mit diesem Endpunkt lassen sich Transaktionskosten erstellen und aktualisieren. Einfach dieselben Kosten erneut mit korrigierten oder aktualisierten Feldern übermitteln, z.B. wenn sich der Betrag der Transaktionskosten für eine Bestellung ändert.
Aktuell gibt es keinen Endpunkt zum vollständigen Löschen hochgeladener Daten. Zum Löschen einer Übermittlung bitte das Kundensupport-Team über den In-App-Chat oder via [email protected] anschreiben.
Gibt einen HTTP-Code 201 und folgenden Antworttext zurück:
{
"status": "VALID"
}
Gibt einen HTTP-Code 400 und eine Validierungsmeldung zurück, wenn ein Fehler aufgetreten ist:
{
"status": "INVALID",
"errors": [
{
"id": 1111,
"key": "0.orderId",
"message": "orderId must be a string",
"value": 1111
}
]
}GET /transaction-costs/state
Dieser Endpunkt ermöglicht die Abfrage einiger Metriken, wie z.B. die Gesamtanzahl der übermittelten Transaktionskosten total, die Anzahl der in der letzten Übermittlung übermittelten lastBatchCount und die Zeit der letzten erfolgreichen / fehlgeschlagenen Übermittlung lastSuccess / lastFailure.
Gibt einen HTTP 200 Statuscode und einen Antworttext zurück:
{
"total": "9",
"lastBatchCount": "4",
"lastSuccess": "2023-03-11 T12:13:31.193Z",
"lastFailure": "2023-03-11 T09:06:50.321Z"
}