Zum Inhalt springen
ShopentlyLearn

Sicheres Schreiben

Kombinieren Sie Idempotenzschlüssel und Versionsprüfungen für vorhersehbare Änderungen.

Erste Schritte

  1. Lesen

    Lesen Sie die Ressource vor einer Änderung und senden Sie expected_version wie dokumentiert.

  2. Schreiben

    POST erstellt unterstützte Ressourcen, PATCH ändert einzelne Felder und DELETE entfernt unterstützte Ressourcen.

  3. Antwort

    Die Wiederholung eines erfolgreichen Vorgangs liefert dessen gespeichertes Ergebnis, ohne die Änderung nochmals anzuwenden.

Header

Idempotency-Key
Jeder Ressourcenschreibvorgang erfordert Idempotency-Key. Verwenden Sie einen Schlüssel pro logischem Vorgang und bei Wiederholungen denselben Schlüssel, dieselbe Methode, dasselbe Ziel und denselben Inhalt.
expected_version
Preisänderungen können zusätzlich Produkt-, Preis-, Variantenpreis- oder Preislistenversionen verlangen. Bei einer Versionsänderung erneut lesen und die Änderung abstimmen, statt veraltete Daten zu erzwingen.

Wiederholungsregeln

  • Ein für eine andere Anfrage wiederverwendeter Schlüssel führt zu idempotency.key_reused.
  • Die Beispiele sind synthetisch; ersetzen Sie Kennungen vor der Ausführung durch Werte aus Ihrem Shop.