⚠️ Bitte beachte:
Dieser Endpoint ist aktuell nur kompatibel beim Mapping mit Bestellungen der folgenden Shop-Data-Sources in Klar: Shopify, Shopware 5 & 6, Oxid, WooCommerce und Centra.
Für alle anderen Use-Cases kontaktiere bitte unser Customer-Support-Team über den In-App-Chat oder per [email protected].
1. Base-URL und Versionierung
Die Base-URL der Klar API ist https://open-api.getklar.com/ gefolgt von einem Versions-String, z. B. 06.2024.
Gut zu wissen: Eine vollständige Definition der API-Endpoints und der verfügbaren Versionen findest du in unserer automatisch generierten API-Spezifikation.
2. Endpoint-Übersicht und allgemeine Infos
Gut zu wissen: Wenn ein Feld in der API-Spezifikation als required markiert ist, muss es in der Übermittlung vorhanden sein. Ist es nicht required und wird übermittelt, muss es einen gültigen Wert haben, z. B. darf cancelledAt nicht mit einem 0-Wert übermittelt werden und muss auf undefined gesetzt sein.
Die Transaction Costs API bietet die folgenden Endpoints:
POST /<VERSION>/transaction-costs/json
GET /transaction-costs/status
POST /<VERSION>/transaction-costs/json
Über diesen Endpoint kannst du deine Payment- & Transaktionskosten-Daten zu Klar hochladen.
Der Request-Body sollte ein JSON-Objekt enthalten, das ein Array von bis zu 1000 JSON-Objekten vom Typ TransactionCosts enthalten kann.
Mit diesem Endpoint kannst du Transaktionskosten sowohl erstellen als auch aktualisieren. Übermittle einfach dieselben Kosten erneut mit korrigierten oder aktualisierten Feldern, z. B. wenn sich der Betrag der Transaktionskosten für eine Bestellung ändert.
Aktuell bieten wir keinen Endpoint zum vollständigen Löschen hochgeladener Daten. Wenn du eine Übermittlung löschen willst, schreib bitte unserem Customer-Support-Team über den In-App-Chat oder per [email protected].
Gibt einen HTTP-Code 201 und den folgenden Response-Body zurück:
{
"status": "VALID"
}Gibt einen HTTP-Code 400 und eine Validator-Message zurück, falls ein Fehler auftrat:
{
"status": "INVALID",
"errors": [
{
"id": 1111,
"key": "0.orderId",
"message": "orderId must be a string",
"value": 1111
}
]
}GET /transaction-costs/state
Über diesen Endpoint kannst du ein paar Metriken abfragen, etwa die Gesamtzahl der übermittelten Transaktionskosten total, die Anzahl der in der letzten Übermittlung übermittelten lastBatchCount sowie den Zeitpunkt der letzten erfolgreichen / fehlgeschlagenen Übermittlung lastSuccess / lastFailure.
Gibt einen HTTP-200-Statuscode und einen Response-Body zurück:
{
"total": "9",
"lastBatchCount": "4",
"lastSuccess": "2023-03-11T12:13:31.193Z",
"lastFailure": "2023-03-11T09:06:50.321Z"
}