Zum Hauptinhalt springen
Netzwerkfehler kommen vor. Wenn ein Request in einen Timeout läuft, können Sie nicht erkennen, ob PapelShip die Bestellung erstellt hat. Mit einem Idempotency-Key-Header können Sie den Store API-Aufruf sicher wiederholen.

So funktioniert es

Fügen Sie einem Erstellungs- oder Aktions-Request einen Idempotency-Key-Header (bis zu 255 Zeichen) hinzu. PapelShip speichert die erste Antwort 24 Stunden lang. Eine Wiederholung mit demselben Schlüssel und demselben Body erhält diese gespeicherte Antwort, statt den Request erneut auszuführen.

Unterstützte Endpunkte

Der Schlüssel funktioniert bei den Erstellungs- und Aktions-Endpunkten der Store API, unter anderem:
  • POST /invoices (Bestellung erstellen)
  • POST /invoices/{invoiceId}/papelpay (Kartenzahlung starten)
  • POST /invoices/{invoiceId}/complete und POST /invoices/{invoiceId}/refund
  • POST /orders/{invoiceId}/shipments
  • POST /products und POST /coupons

Best Practices

  • Erzeugen Sie einen Schlüssel pro Bestellung, nicht pro Request. Ihre eigene Bestell-ID eignet sich gut.
  • Speichern Sie den Schlüssel zusammen mit Ihrer Bestellung, damit jede Wiederholung ihn wiederverwendet.
  • Verwenden Sie einen Schlüssel niemals für eine andere Bestellung oder einen anderen Betrag.