定期購入情報変更履歴一覧API

定期購入情報を変更した履歴一覧を取得する機能を提供します。

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

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

リクエストURL

パラメータ	型	説明
sellerId （必須）	string	ストアアカウントを指定します。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/changehistory/list?sellerId=teststore

サンプルリクエスト

GET /ShoppingWebService/V1/subscription/order/origin/teiki-20220915-teststore-abc12345/changehistory/list?sellerId=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
 

レスポンスフィールド

要素	キー名	型	最大長	名称	説明
histories		array		変更履歴リスト
	historyId	integer	10
	updateTime	string	11	変更日時
	updateContent	string	3	変更内容	101：新規申し込み 200：お申し込み情報変更 201：お申し込み情報変更（明細情報） 202：お申し込み情報変更（お届け情報） 203：お申し込み情報変更（お支払情報） 204：お申し込み情報変更（注文者情報） 301：定期購入申し込み利用状況（スキップ） 302：定期購入申し込みステータス変更（解約）
	updatePerson	string	30	変更者	1：YJDN 2：ストア 3：ヤフー 4：バイヤー

サンプルレスポンス

レスポンス（JSON）

{
  "histories": [
    {
      "historyId": 1,
      "updateTime": "2022-08-23T20:37:53.086997+09:00",
      "updateContent": 101,
      "updatePerson": "4"
    },
    {
      "historyId": 2,
      "updateTime": "2022-09-13T12:56:02.649541+09:00",
      "updateContent": 302,
      "updatePerson": "2"
    }
  ]
}}

エラー

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

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

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

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

利用制限

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

利用約款

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