定期購入変更要求一括キャンセルAPI

定期購入の商品の価格の更新や、代替品の切り替えなどで、商品の変更要求を行った後に、変更要求を取り消したい場合に利用します。
お届け予定日の15日前の解約処理と変更内容をお客様にご案内する前までであれば変更要求の取り消しが可能です。

利用申請について

本番環境について

定期購入APIを利用する場合は別途利用申請が必要です。下記フォームから申請をお願いします。
ショッピング定期購入API利用申請フォーム
※既に注文APIをご利用中のお客様に関しては、追加で申請をしていただく必要はありません。

テスト環境について

テスト用APIを利用する場合は、下記フォームから「テスト環境用」を指定して申請をお願いします。
新しいアプリケーションを開発
※テスト環境に関しては別途定期購入APIの利用申請をしていただく必要はありません。

リクエストとレスポンスで共通する事項について

• 最大長の単位は文字数で、半角も全角もそれぞれ1文字で扱います。

リクエストURL

リクエストパラメータ

パラメータ	必須	型	最大長	説明
sellerid	〇	string	31	ストアアカウント

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/changerequest/123/cancel/bulk

サンプルリクエスト

POST /ShoppingWebService/V1/subscription/order/changerequest/123/cancel/bulk HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

{
  "sellerId"："teststore"
}

レスポンスフィールド

• 成功時

HTTPステータスコード：200

サンプルレスポンス

レスポンス

{
  "result": "OK"
}

• 失敗時

パラメータ	型	最大長	説明
error			エラーコード
message			エラーメッセージ

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

• Yahoo! ショッピングAPI共通エラーコード一覧

定期購入APIで固有に返すエラーコードは以下をご覧ください。

• 定期購入APIで共通に利用する定義 - エラーコード

利用制限

※ご注意ください※
APIリクエストを複数回並列で実行した場合、本APIがエラー（SUBSCRIPTION-ORDER-API-1021）を返す可能性がございます。恐れ入りますが、複数回のコールを行う際は、並列ではなく直列にコール頂くようお願い致します。
また、上記エラーコードが返却された際は、再度APIをコール頂くことで正常に登録処理を行うことができます。

利用約款

このAPIに関する利用約款はこちら。