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

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

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/changerequest/list
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/changerequest/list

リクエストパラメータ

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

パラメータ 必須 型 最大長 説明
sellerid 〇 string ストアアカウント
countFrom number 8 検索対象件数範囲From
・最大長以下か
・countTo < countFrom + 1000 を満たすか（最大1000件までしか取得できない）
　（満たさない場合エラーコードSUBSCRIPTION-ORDER-API-1011を返却）
・countToも指定されているか
　（指定されていない場合エラーコードSUBSCRIPTION-ORDER-API-1011を返却）
「101～200件目を取得」する場合は「101」を指定
デフォルトは1
countTo number 8 検索対象件数範囲To
・最大長以下か
・countTo < countFrom + 1000 を満たすか（最大1000件までしか取得できない）
　（満たさない場合エラーコードSUBSCRIPTION-ORDER-API-1011を返却）
・countFromも指定されているか
（指定されていない場合エラーコードSUBSCRIPTION-ORDER-API-1011を返却）
「「101〜200件目を取得」する場合は「200」を指定
デフォルトは1000
sort string ソート順
次にに記載した値のいずれか
desc / asc
デフォルトはdesc
ソート順はchangeRequestId順
conditions object 検索条件

検索条件（conditions）：

キー名 型 最大長 一致方式 説明
changeRequestId number 18 完全一致 変更要求ID
整数値であるか
changeRequestType string 30 完全一致 変更要求区分
価格変更(price_update)
商品切替(item_switch)
のいずれか
changeRequestTargetType string 10 完全一致 変更要求対象区分
単体(single)
一括(bulk)
のいずれか
changeRequestStatus string 2 完全一致 整数値であるか
変更要求ステータスと変更要求詳細フェーズの遷移について参照
targetItemId string 99 完全一致 対象商品ID
afterItemId string 99 完全一致 変更後商品ID
changeRequestTimeFrom date 10 範囲指定 変更要求日時From
　yyyy-MM-dd 形式
未指定の場合は直近半年間の変更要求のみ返却する
changeRequestTimeTo date 10 範囲指定 変更要求日時To
　yyyy-MM-dd 形式
未指定の場合は直近半年間の変更要求のみ返却する

サンプルリクエストURL

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

サンプルリクエスト

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

{
  "sellerId": "test-store",
  "countFrom": 1,
  "countTo": 1000,
  "sort": "desc",
  "conditions": {
    "changeRequestId": 123,
    "changeRequestType": "price_update",
    "changeRequestStatus": 1,
    "changeRequestTimeFrom": "2024-03-01"
  }
}

レスポンスフィールド

  • 成功時

HTTPステータスコード：200

要素 フィールド 必須 型 最大長 名称 説明
count 〇 number 4 検索総件数 検索条件に一致した総件数
results 〇 array 検索結果一覧
changeRequestId 〇 number 18 変更要求ID
changeRequestType 〇 string 30 変更要求区分 変更要求区分
・price_update：価格変更
・item_switch ：商品切替
changeRequestTargetType 〇 string 10 変更要求対象区分 単体(single) or 一括(bulk)
changeRequestStatus 〇 string 2 変更要求ステータス 変更要求ステータスと変更要求詳細フェーズの遷移について参照
targetItemId 〇 string 99 対象商品ID
afterItemId 〇 string 99 変更後商品ID 価格変更の場合はキー自体存在なし
商品切替の場合は必ず返却
changeRequestTime 〇 datetime 25 変更要求日時 例：2019-12-31T15:00:00+09:00
changeRequestDetailCount 〇 object 変更要求詳細件数 変更要求ステータスと変更要求詳細フェーズの遷移について参照
※変更要求ステータスが1の場合、対象が抽出される前なので、全て0で返却される
beforeNotify 〇 number 10 通知前の件数 変更要求詳細フェーズが2の件数
afterNotify 〇 number 10 通知後の件数 変更要求詳細フェーズが3の件数
canceled 〇 number 10 キャンセルの件数 変更要求詳細フェーズが5～7の件数

サンプルレスポンス

レスポンス

{
    "count": 123,
    "results": [
        {
          "changeRequestId": 123,
          "changeRequestType": "price_update",
          "changeRequestTargetType": "single",
             ...
          "changeRequestTime": "2023-12-31T15:00:00+09:00",
          "changeRequestDetailCount": {
                  "beforeNotify": 1,
                  "afterNotify": 2,
                  "canceled": 3
          }
        },
          ...
        {
          "changeRequestId": 1,
          "changeRequestType": "item_switch",
          "changeRequestTargetType": "bulk",
            ...
          "changeRequestTime": "2022-12-31T15:00:00+09:00",
          "changeRequestDetailCount": {
                  "beforeNotify": 5,
                  "afterNotify": 4,
                  "canceled": 3
          }
        }
    ]
}
  • 失敗時
パラメータ 型 最大長 説明
error エラーコード
message エラーメッセージ

エラー

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

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

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント