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

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

利用申請について

本番環境について

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

テスト環境について

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

リクエストURL

※changeRequestId：変更要求ID

リクエストパラメータ

「Web APIの使い方#PATCHとは」をご参照ください。

リクエストパラメータ

リクエストURL

パラメータ	必須	型	最大長	説明
sellerId	〇	string	31	ストアアカウント
subscriptionId	〇	string	70	定期購入番号
lineId	〇	number	2	変更対象ラインID

サンプルリクエストURL

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

サンプルリクエスト

PATCH https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/changerequest/1/cancel 
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

{
  "sellerId": "teststore"
  "subscriptionId": "teiki-20220915-teststore-abc12345",
  "lineId": "2"
}

レスポンスフィールド

要素	型	値の例	説明
status	string	ok	ステータス

サンプルレスポンス

レスポンス（JSON）

{
"result": "OK"
}

エラー

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

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

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

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

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

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