定期購入変更要求詳細一覧取得API

検索条件に一致する定期購入の変更要求詳細を一覧で取得する機能を提供します。

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

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

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

サンプルリクエストURL

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

サンプルリクエスト

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

{
  "sellerId"："teststore"
}

レスポンスフィールド

• 成功時

HTTPステータスコード：200

要素	フィールド	必須	型	最大長	名称	説明
changeRequestTime		〇	datetime	25	変更要求日時/td>	例：2024-12-31T15:00:00+09:00
changeRequestType		〇	string	30	変更要求区分/td>	・price_update：価格変更 ・item_switch：商品切替
changeRequestTargetType		〇	string	10	変更要求対象区分	・単体(single) ・一括(bulk)
changeRequestStatus		〇	string	2	変更要求ステータス	変更要求ステータスと変更要求詳細フェーズの遷移について参照
targetItemId		〇	string	99	対象商品ID
afterItemId			string	99	変更後商品ID	価格変更の場合はキー自体存在なし 商品切替の場合は必ず返却
changeRequestDetails			array
	subscriptionId	〇	string	70	定期購入ID
	lineId	〇	number	2	ラインID
	nextRemindDate		date	10	通知予定日	例：2024-10-01 解約通知が送信される予定の日付
	changeRequestDetailPhase	〇	string	2	変更要求詳細フェーズ	変更要求ステータスと変更要求詳細フェーズの遷移について参照
	changeRequestDetailPhaseUpdateTime	〇	datetime	25	変更要求詳細フェーズ更新日時	例：2024-12-31T15:00:00+09:00 ※詳細フェーズが3(通知済み)の場合、この項目は通知を行った日時となる

サンプルレスポンス

レスポンス

{
    "changeRequestTime": "2023-12-31T15:00:00+09:00",
    "changeRequestType": "price_update",
    "changeRequestTargetType": "single",
          ...
    "changeRequestDetails": [
        {
            "subscriptionId": "teiki-XXXX-YYYY",
            "lineId": 2,
            "changeRequestDetailPhase": 3,
            "changeRequestDetailPhaseUpdateTime": "2019-12-31T15:00:00+09:00"
        },
        {
            "subscriptionId": "teiki-AAAA-BBBB",
            "lineId": 1,
            "nextRemindDate": "2020-01-01",
            "changeRequestDetailPhase": 2,
            "changeRequestDetailPhaseUpdateTime": "2020-12-31T15:00:00+09:00"
        },
        ...
    ]
}

• 失敗時

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

エラー

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

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

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

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

利用制限

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

利用約款

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