コンテンツにスキップ
ShopentlyLearn

安全な書き込み

冪等キーとバージョン確認を組み合わせ、予測可能な更新を行います。

使い始める

  1. 読み取り

    編集前にリソースを取得し、文書に従って expected_version を指定します。

  2. 書き込み

    対応するリソースの作成には POST、部分更新には PATCH、削除には DELETE を使います。

  3. レスポンス

    成功した操作を繰り返すと、再実行せず保存済みの結果を返します。

ヘッダー

Idempotency-Key
リソースへのすべての書き込みに Idempotency-Key が必要です。 論理操作ごとに1つ生成し、再試行ではキー、メソッド、対象、内容を同じにしてください。
expected_version
価格変更では商品、価格、バリエーション価格、価格表のバージョンも必要な場合があります。 バージョンが変わったら再取得して変更を調整し、古いデータを強制適用しないでください。

再試行方針

  • 同じキーを別のリクエストに使うと idempotency.key_reused になります。
  • すべての例は合成データです。
  • 実行前に、識別子を自分のストアで取得した値に置き換えてください。