定期購入利用時のおちゃのこAPI仕様
商品関連のエンドポイントは、定期購入商品は対象外とし、通常購入商品に対してのみ利用することができます。
※受注関連のエンドポイントは、従来通り利用できます。
そのため、定期購入商品のみ販売する場合(※)は、すべての商品関連のエンドポイントはご利用できません。
※「定期購入管理」→「定期購入設定」→【基本設定】欄「定期購入商品のみ販売する」にチェックが入っている場合
ステータスコードとメッセージは以下の通りです。
| ステータスコード | メッセージ |
|---|---|
| 422 | The system is set up to sell only subscription products. Subscription products are not available for API. |
通常購入商品も定期購入商品も両方取り扱う場合は、以下の仕様となります。
| エンドポイント | 条件 | ステータスコード | メッセージ | 備考 |
|---|---|---|---|---|
| 一覧表示 | - | 200 | - | 販売方法が定期購入のみの商品は除外して返す。 |
| 選択表示 | 販売方法が通常購入のみの商品IDでリクエスト | 200 | - | 従来通り。 |
| 販売方法が定期購入のみの商品IDでリクエスト | 422 | Validation Failed. Subscription products are not available for API. | ||
| 販売方法が通常+定期の商品IDでリクエスト | 200 | - | 通常購入商品のデータのみを返す。 | |
| 在庫・価格変更 | 販売方法が通常購入のみもしくは通常+定期の商品IDだけが含まれているパラメータでリクエスト | 200 | - | 販売方法が通常購入のみの商品は従来通り。 販売方法が通常+定期の商品は通常購入商品のデータのみ更新可。 |
| 販売方法が定期購入のみの商品IDが1つでも含まれているパラメータでリクエスト | 422 | Product ID XXX is subscription product. Subscription products are not available for API. | 販売方法が定期購入のみの商品IDが1つでも含まれていれば、その他の商品についても更新されず、エラーレスポンスを返す。 |