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. 12.2022.
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 markiert ist, muss es in der Übermittlung vorhanden sein. Wenn es nicht erforderlich ist und vorhanden ist, muss es einen gültigen Wert haben, z.B. kann cancelledAt nicht mit dem Wert 0 übermittelt werden und muss auf undefined gesetzt werden.
Die COGS API bietet die folgenden Endpunkte:
POST /<VERSION>/cogs/validate
POST /<VERSION>/cogs/json
GET /cogs/status
POST /<VERSION>/logistics-costs/validate
Dieser Endpunkt ermöglicht es dir, deine COGS-Payload auf Gültigkeit zu prüfen. Wir prüfen derzeit auf Verstöße gegen die Spezifikation wie erforderliche Felder und Attributtypen, 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 COGS 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": {
// ... COGS-Objekt
},
"value": null,
"property": "productCogs",
"children": [],
"constraints": {
"isNumber": "productCogs muss eine Zahl sein, die den angegebenen Einschränkungen entspricht"
}
}
]
// ...
}]
POST /<VERSION>/cogs/json
Dieser Endpunkt ermöglicht es dir, deine Logistikkostendaten an Klar zu übermitteln.
Der Request Body sollte ein Array von bis zu 1000 JSON-Objekten vom Typ COGS enthalten. Die Antwort auf eine erfolgreiche Übermittlung ist eine leere Antwort mit einem HTTP-Code 201.
Mit diesem Endpunkt kannst du COGS sowohl erstellen als auch aktualisieren. Übermittle einfach dieselben COGS erneut mit korrigierten oder aktualisierten Feldern, z.B. wenn sich der Betrag der COGS für einen Artikel einer Bestellung ändert.
Wir bieten derzeit keinen Endpunkt zum vollständigen Löschen übermittelter Daten an. Wenn du eine Übermittlung löschen möchtest, schreibe bitte unserem Kundensupport-Team über unseren In-App-Chat oder per E-Mail an [email protected].
GET /cogs/status
Dieser Endpunkt ermöglicht die Abfrage einiger Metriken, wie z.B. des gesamten erstatteten Betrags total, des Betrags der COGS, der in der letzten Übermittlung enthalten war lastBatchCount und der Zeit der letzten erfolgreichen/fehlgeschlagenen Übermittlung 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"
}