定期購入価格別件数取得API

検索条件に一致する定期購入価格別の件数を取得する機能を提供します。

利用申請について

本番環境について

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

テスト環境について

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

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

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

リクエストURL

リクエストパラメータ

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

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

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/subscription/order/item/sample-item/origincount

サンプルリクエスト

{
  "sellerId"："teststore"
}

レスポンスフィールド

• 成功時

HTTPステータスコード：200

要素	フィールド	必須	型	最大長	名称	説明
totalCount		〇	number	10	合計件数
results			array
	priceWithoutOption	〇	number	10	オプション価格抜きの価格(税込)	定期購入価格の昇順（安い順）に返却されます
	count	〇	number	10	上記価格の継続中親注文の件数	status=0（継続中）の件数のみ返却されます

サンプルレスポンス

レスポンスサンプル

{
    "totalCount": 20,
    "results":[
        {
            "priceWithoutOption": 3000,
            "count": 8
        },
        {
            "priceWithoutOption": 4000,
            "count": 12
        },
    ]
}

取得件数0件の場合のレスポンス

{
    "totalCount": 0,
    "results": []
}

エラー

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

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

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

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

利用制限

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

利用約款

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