Zum Inhalt springen

Versionen und Änderungen

Was sich an der API ohne Ankündigung ändern darf, was sich in v1 nie ändert und wie früh Sie vom Rest erfahren.

/api/v1 bleibt kompatibel

Alles unter /api/v1 funktioniert weiter wie dokumentiert. Innerhalb von v1 machen wir nur Änderungen, die bestehende Programme nicht bemerken:

  • neue Endpunkte, neue optionale Parameter,
  • neue Felder in Antworten (ignorieren Sie Felder, die Sie nicht kennen),
  • neue Werte, wo eine Werteliste als offen dokumentiert ist (neue attributes, neue Kategorien),
  • neue CSV-Spalten, immer am Ende,
  • bessere Fehlermeldungen (richten Sie sich nach status und limit, nicht nach message).

Schreiben Sie Ihren Client so, dass ihn das nicht stört.

Inkompatible Änderungen

Eine Änderung, die ein Programm brechen könnte (ein Feld oder einen Endpunkt entfernen oder umbenennen, die Bedeutung eines Werts ändern), kommt nur mit einer neuen Version (/api/v2). Beide laufen mindestens 12 Monate nebeneinander. Endpunkte, die wegfallen, antworten mit den Headern Deprecation und Sunset, und wir schreiben jedem Kunden, der sie noch aufruft.

Das OpenAPI-Dokument

Die API-Referenz wird aus dem OpenAPI-3.1-Dokument der API erzeugt, /openapi/public-v1.json. Es wird bei jeder Änderung gegen den Code geprüft und beschreibt deshalb immer, was die API tut. Erzeugen Sie daraus einen Client, oder importieren Sie es in Postman, Bruno oder Insomnia.

Changelog

Oktober 2026

  • Webhooks: der Change-Feed an Ihren Server geschickt, signiert, in der richtigen Reihenfolge (Webhooks).
  • Jeder Fehler verlinkt seine Erklärung (docsUrl).
  • Der Change-Feed zeigt Änderungen etwa 30 Sekunden, nachdem sie passiert sind, damit ein Cursor nie an einer Änderung vorbeigeht, die noch geschrieben wird.
  • Produkte über Shops hinweg (/products), Produktcodes (gtin, mpn, brand) an Items, der Filter gtin.
  • Limits je Plan mit den Headern RateLimit-* und X-Quota-*, /plan.