SHPカテゴリツリー取得API

Yahoo!ショッピングのカテゴリをツリーで取得します。

リクエストURL

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

こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopCategory
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

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

パラメータ 値 説明
seller_id
（必須）		 string ストアアカウントを指定します。
category_code integer SHPカテゴリコードを指定します。 ※指定しない場合は第1階層を取得します。

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

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

サンプルリクエストURL

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

レスポンスフィールド

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

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。
  • firstResultPosition : 最初のデータが何個目に当たるかです。
/ResultSet/Result 各SHPカテゴリの要素を含みます。
/ResultSet/Result/CategoryCode 末端フラグ（isLeaf）＝0のとき、SHPカテゴリコードを返します。
末端フラグ（isLeaf）＝1のとき、プロダクトカテゴリIDを返します。
/ResultSet/Result/CategoryName 末端フラグ（isLeaf）＝0のとき、SHPカテゴリ名を表示します。
末端フラグ（isLeaf）＝1のとき、プロダクトカテゴリ名を表示します。
/ResultSet/Result/IsLeaf 末端フラグ
1 : 末端です。CategoryCodeには、商品に登録するためのプロダクトカテゴリIDが入っています。
0 : 子カテゴリが存在します。
/ResultSet/Result/Display 表示フラグ
1 : 表示すべき通常のカテゴリです。
0 : パラメータで指定されているセラーには表示すべきでないカテゴリです。
/ResultSet/Result/UpdateDate 更新日（YYYY-MM-DD）

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="1630">
<Result>
    <CategoryCode>3</CategoryCode>
    <CategoryName><![CDATA[デスクトップパソコンその他]]></CategoryName>
    <IsLeaf>0</IsLeaf>
    <Display>1</Display>
    <UpdateDate>2013-01-25</UpdateDate>
</Result>
</ResultSet>

エラー

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

商品系API、およびSHPカテゴリツリー取得APIで固有に返すエラーコードは以下をご覧ください。

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

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

・エラーコード

コード HTTPステータスコード 説明
pr-02001 400 SHPカテゴリコードの指定が不正です。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント