SHPカテゴリ検索API

Yahooショッピングカテゴリを検索します。

リクエストURL

XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopCategoryList

こちらはテスト用APIもご利用いただけます。
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
URLは以下の通りです。

https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopCategoryList

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
query
(必須)
string 検索ワードを指定します。
category_code string Yahooショッピングカテゴリコードを指定します。
指定すると検索条件となり、指定カテゴリのYahooショッピングカテゴリが検索されます。
sort string
(デフォルト : +path_name)
一覧のソート項目を指定します。
path_name : カテゴリ階層
name : カテゴリ名
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順) ※UTF-8でURLエンコードされている必要があります。
start integer
(デフォルト : 1)
何件目からデータの取得をはじめるかを指定します。
results integer
(デフォルト : 25)
データの取得件数を指定します。(最大値100)

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。

※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopCategoryList?seller_id=teststore&query=PC&category=13457

サンプルリクエスト

GET /ShoppingWebService/V1/getShopCategoryList?seller_id=teststore&query=PC&category=13457 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含み、次の属性を持ちます。

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • firstResultPosition : 最初のデータが何個目に当たるかです。

/ResultSet/Result 各Yahooショッピングカテゴリの要素を含みます。
/ResultSet/Result/CategoryCode Yahooショッピングカテゴリコード
/ResultSet/Result/CategoryName Yahooショッピングカテゴリ名
/ResultSet/Result/PathName カテゴリパス
/ResultSet/Result/UpdateDate カテゴリの更新日(YYYY-MM-DD)

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
  <ResultSet totalResultsAvailable="1630" totalResultsReturned="2" firstResultPosition="1">
  <Result>
      <Id>3</Id>
      <Name><![CDATA[デスクトップパソコンその他]]></Name>
      <PathName><![CDATA[パソコン、周辺機器 > デスクトップパソコン > その他]]></PathName>
      <UpdateDate></UpdateDate>
  </Result>
</ResultSet>

エラー

SHPカテゴリ検索APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

商品系API共通エラーコード

コード HTTPステータスコード 説明
ed-00000 404 ページが見つかりません。
ed-00001 500 システムエラーが発生しました。
ed-00002 503 サーバがメンテナンス中です。
ed-00003 400 ストアアカウントが指定されていません。
ed-00004 400 ストアアカウントが存在しません。
ed-00005 400 ストアアカウントの指定が不正です。

エラーコード

コード HTTPステータスコード 説明
pr-03001 400 検索ワードが指定されていません。
pr-03002 400 Yahooショッピングカテゴリコードの値が不正です。
pr-03003 400 sortの値が不正です。 
pr-03004 400 startの値が不正です。
pr-03005 400 resultsの値が不正です。
pr-03006 400 指定されたデータの取得件数が最大値を超えています。
pr-03007 400 検索ワードの値が不正です。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。

利用約款

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

アプリケーションの管理

目次

開発のヒント