定期購入変更要求登録API

定期購入で申し込まれている商品の変更を行う機能を提供します。
例えば、商品の価格を更新したい場合や、廃番やリニューアル等で申し込まれた商品で定期購入を継続できず、代替商品へ切り替えたい場合などに利用します。

変更後の商品を登録いただくと、お届け予定日の15日前に変更前の親注文の解約処理を行い、
お客様に切替後の商品をご案内し、再申し込みを促します。

利用申請について

本番環境について

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

テスト環境について

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

リクエストURL

リクエストパラメータ

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

リクエストURL

パラメータ	必須	型	最大長	説明
sellerId	〇	string	31	ストアアカウント
changeRequestType	〇	string	30	変更要求区分 ・price_update：価格変更 ・item_switch：商品切替
targetItemId	〇	string	99	対象商品ID lineId項目で指定した商品ラインの商品IDを設定してください
afterItemId	〇 ※商品切替時のみ必須	string	99	変更後商品ID ※商品切替の際は必須です。 　　切替後の商品情報が登録されている商品IDを指定してください。 　　価格変更の際は設定不可です。
subscriptionId	〇	string	70	対象の定期購入番号
lineId	〇	number	2	対象ラインID

サンプルリクエストURL

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

サンプルリクエスト

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

{
  "sellerId": "teststore"
  "changeRequestType": "item_switch",
  "targetItemId": "beforeItemId",
  "afterItemId": "afterItemId",
  "subscriptionId": "teiki-20220915-teststore-abc12345",
  "lineId": 1
}

レスポンスフィールド

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

サンプルレスポンス

レスポンス（JSON）

{
"result": "OK"
}

エラー

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

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

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

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

利用制限

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

利用約款

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