Hinweis: Dieser Artikel wurde automatisch übersetzt. 🤖
1. Basis-URL und Versionierung
Die Basis-URL der Klar API ist https://open-api.getklar.com/ gefolgt von einem Versionsstring, z.B. 04.2024.
Gut zu wissen: Eine vollständige Definition der API-Endpunkte und der verfügbaren Versionen findest du in unserer automatisch generierten API-Spezifikation.
2. Endpunktübersicht und allgemeine Infos
Gut zu wissen: Wenn ein Feld in der API-Spezifikation als erforderlich gekennzeichnet ist, muss es in der Einreichung vorhanden sein. Wenn es nicht erforderlich ist und vorhanden ist, muss es einen gültigen Wert haben, z.B. kann cancelledAt nicht mit einem Wert von 0 übermittelt werden und muss auf undefined gesetzt werden.
Die Logistikkosten-API bietet die folgenden Endpunkte:
POST /<VERSION>/logistics-costs/validate
POST /<VERSION>/logistics-costs/json
GET /logistics-costs/status
POST /<VERSION>/logistics-costs/validate
Mit diesem Endpunkt kannst du deine Logistikkosten-Payload auf Gültigkeit prüfen. Wir prüfen derzeit auf Verstöße gegen die Spezifikation wie erforderliche Felder und Attributtypen, wie z.B. number, string usw. In Zukunft werden wir auch Logikverstoßfehler als Ergebnis einer fehlerhaften Payload zurückgeben. Der Request Body sollte ein JSON-Objekt mit dem Schlüssel "items" enthalten, das ein Array von bis zu 1000 JSON-Objekten vom Typ LogisticsCosts enthalten kann.
Gibt einen HTTP-Code 202 und den folgenden Response Body zurück:
{
"status": "VALID"
}Gibt einen HTTP-Code 400 und eine Validator-Nachricht zurück, wenn ein Fehler aufgetreten ist:
[{
// ...
"children": [
{
"target": {
// ... LogisticsCosts Objekt
},
"value": null,
"property": "logisticsCosts",
"children": [],
"constraints": {
"isNumber": "logisticsCosts muss eine Zahl sein, die den angegebenen Einschränkungen entspricht."
}
}
]
// ...
}]
POST /<VERSION>/logistics-costs/json
Mit diesem Endpunkt kannst du deine Logistikkostendaten an Klar hochladen.
Der Request Body sollte ein Array von bis zu 1000 JSON-Objekten vom Typ LogisticsCosts enthalten. Die Antwort auf eine erfolgreiche Einreichung ist eine leere Antwort mit einem HTTP-Code 201.
Mit diesem Endpunkt kannst du Logistikkosten sowohl erstellen als auch aktualisieren. Übermittle einfach dieselben Logistikkosten erneut mit korrigierten oder aktualisierten Feldern, z.B. wenn sich die Höhe der für eine Bestellung ausgegebenen Logistikkosten ändert.
Wir bieten derzeit keinen Endpunkt zum vollständigen Löschen von hochgeladenen Daten an. Wenn du eine Einreichung löschen möchtest, schreibe bitte unserem Kundensupport-Team über unseren In-App-Chat oder per E-Mail an [email protected].
GET /logistics-costs/state
Mit diesem Endpunkt kannst du einige Metriken abfragen, wie z.B. den Gesamtbetrag der eingereichten Rückerstattungen total, die Anzahl der in der letzten Einreichung eingereichten lastBatchCount und die Zeit der letzten erfolgreichen / fehlgeschlagenen Einreichung lastSuccess / lastFailure.
Gibt einen HTTP-Statuscode 200 und einen Response Body zurück:
{
"total": "9",
"lastBatchCount": "4",
"lastSuccess": "2023-03-11T12:13:31.193Z",
"lastFailure": "2023-03-11T09:06:50.321Z"
}