商品オプション / 商品オプション値の追加・削除エンドポイントを公開しました
2026/06/17
商品オプション (色・サイズ等の軸) と商品オプション値 (赤・S 等) を追加・削除できるエンドポイントを公開しました。商品バリエーション (色×サイズ等の組み合わせ) は、商品オプション・商品オプション値の追加や削除に応じて自動で構成されます。
公開したエンドポイント
| メソッド | パス | 概要 |
|---|---|---|
| POST | /v1/products/{product_id}/options |
商品オプションの追加 |
| DELETE | /v1/products/{product_id}/options/{id} |
商品オプションの削除 |
| POST | /v1/products/{product_id}/options/{option_id}/values |
商品オプション値の追加 |
| DELETE | /v1/products/{product_id}/options/{option_id}/values/{id} |
商品オプション値の削除 |
β版として提供しています
本リリースの4エンドポイントはβ版として提供しています。β版は正式版として提供する前段階で安定稼働を確認するためのステータスです。β版の提供期間中に仕様や挙動の変更が発生する可能性があります。
注意事項
共通
- 利用には OAuth スコープ
write_productsが必要 - 商品オプションは1商品あたり最大2つまで設定可能
商品オプションの追加 (POST /v1/products/{product_id}/options)
- 商品オプション (例: 色) を追加します。追加時には商品オプション値 (例: 赤・青) を1つ以上指定する必要があります
- 追加した商品オプションと商品オプション値の組み合わせで商品バリエーションが構成されます (既に商品バリエーションがあった場合は、新しい組み合わせに置き換わります)
- 新しく構成される商品バリエーション別の在庫数 (
stocks) はnullになります (商品全体の在庫数は変動しません)
- 新しく構成される商品バリエーション別の在庫数 (
- 商品オプションが既に2つ設定されている商品に追加しようとした場合は422エラーを返します
商品オプションの削除 (DELETE /v1/products/{product_id}/options/{id})
- 削除した商品オプションに紐づく商品オプション値と商品バリエーションも併せて削除されます
- 他の商品オプションが残る場合は、商品バリエーションは残った商品オプション値の組み合わせに置き換わります
- 置き換え後の商品バリエーション別の在庫数 (
stocks) はnullになります (商品全体の在庫数は変動しません)
- 置き換え後の商品バリエーション別の在庫数 (
- 商品オプションがすべて削除された場合も商品全体の在庫数は維持されます
商品オプション値の追加 (POST /v1/products/{product_id}/options/{option_id}/values)
- 既存の商品バリエーションに変更はなく、追加した商品オプション値を含む商品バリエーションが新しく作成されます
- 新しく作成される商品バリエーションの在庫数 (
stocks) は、下記いずれかのパターンになります- 既存の商品バリエーションの在庫数が
0以上の整数の場合は0で作成されます - 既存の商品バリエーションの在庫数が
nullの場合はnullで作成されます
- 既存の商品バリエーションの在庫数が
商品オプション値の削除 (DELETE /v1/products/{product_id}/options/{option_id}/values/{id})
- 削除した商品オプション値に紐づく商品バリエーションも併せて削除されます
- 商品オプションに紐づく最後の商品オプション値を削除しようとした場合は422エラーを返します
- 商品オプションの削除エンドポイントを利用して、商品オプションと商品オプション値をまとめて削除してください
関連するお知らせ
2026年5月25日のお知らせ「商品オプションのレスポンスに項目を追加しました」もあわせてご確認ください。