Klar API
Über Schnittstellen Daten in Klar importieren
Von Frank und 1 weiteren Person2 Autoren25 Artikel
- Entwickler-Leitfaden: Verbindung zur Klar RESTful APIDieser Artikel bietet Entwickler:innen einen umfassenden Überblick und technische Richtlinien für die Integration externer Systeme mit der Klar RESTful API.
- Data Mapping: Frontend- vs. API-FelderZuordnung aller Frontend-Dimensionen zu ihren entsprechenden API-Feldern — für einfachere Integration und Fehlersuche.
Endpunkte
Liste der über die Klar-API verfügbaren Endpunkte
- API-AuthentifizierungSo authentifizierst du dich an der Klar API per Bearer-Token — inkl. curl- und TypeScript-Beispiel.
- COGS (API-Endpunkt)Base-URL, Endpunkte /cogs/validate, /cogs/json und /cogs/status der Klar COGS-API — inkl. Beispiel-Payloads und Fehlermeldungen.
- Orders (API-Endpunkt)Base-URL, Headers und die Endpunkte /orders/validate, /orders/json und /orders/status der Klar Order-API — inkl. Beispiel-Payloads und Fehlermeldungen.
- Refunds (API-Endpunkt)Base-URL, Endpunkte /refunds/validate, /refunds/json und /refunds/status der Klar Refunds-API — inkl. Beispiel-Payloads und Fehlermeldungen.
- TransaktionskostenErmöglicht das Hochladen von Zahlungs- und Transaktionskosten für Bestellungen über die API
- Logistics Costs (API-Endpunkt)Base-URL, Endpunkte /logistics-costs/validate, /logistics-costs/json und /logistics-costs/status der Klar Logistics-Costs-API — inkl. Beispiel-Payloads und Fehlermeldungen.
Objekt-Schemas
Detaillierte Beschreibung der Entitäten für die Klar-API-Endpunkte
- COGS
- Customer (Kunde)
- Rabatt
- LineItem
- LogisticsCosts
- OptionalIdentifiers
- OrderReferenz aller Felder des Order-Objekts der Klar-API — Typen, Beschreibungen und Beispielwerte (id, createdAt, financialStatus, lineItems, shipping, customer usw.).
- Versand
- Steuer
- Transaction CostsObject Schema für den Transaction Costs Endpunkt der Klar API.