定期購入変更要求一括登録API

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

変更前後の商品IDや価格変更対象の価格を指定すると、条件にあった定期購入親注文の変更を一括でおこなうことができます。
処理が完了すると、お届け予定日の15日前に変更前の親注文の解約処理を行い、お客様の定期購入申し込み時のメールアドレスに切替後の商品をご案内し、再申し込みを促します。

変更通知メールの内容は、ストアクリエイターPro　ツールマニュアルをご確認ください。
ストアクリエイターPro >ツールマニュアル >定期購入 >
定期購入の概要 定期購入で通知されるメール > 8.変更通知メール

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

パラメータ	必須	型	最大長	説明
sellerid	〇	string	31	ストアアカウント
changeRequestType	〇	string	30	変更要求区分 ・price_update：価格変更 ・item_switch：商品切替
targetItemId	〇	string	99	対象商品ID
afterItemId	※〇	string	99	変更後商品ID ※商品切替の際は必須です。切替後の商品情報が登録されている商品IDを指定してください。価格変更の際は設定不可です。
targetPriceWithoutOption	※〇	array	要素数100	価格変更対象価格要素数 ・1つ1つの価格は最大10桁までであること ・整数のみが含まれる配列であること ※指定した価格の親注文のみが変更対象です。 ※現在設定されている商品価格と同一価格が含まれる場合はエラーとなります 例：[500, 600, 1000] ※価格変更の際は必須　商品切替の際は無効です。

サンプルリクエストURL

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

サンプルリクエスト

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

{
  "sellerId"："teststore",
  "changeRequestType": "price_update",
  "targetItemId": "itemId",
  "targetPriceWithoutOption": [1000, 1500, 1600]
}

レスポンスフィールド

• 成功時

HTTPステータスコード：200

パラメータ	型	最大長	説明
changeRequestId	number	18	発番された変更要求ID

サンプルレスポンス

レスポンス

{
  "changeRequestId": 3
}

• 失敗時

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

エラー

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

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

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

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

利用制限

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

利用約款

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