ストアカテゴリ一覧API

ストアカテゴリの一覧を取得します。

リクエストURL

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

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

リクエストパラメータ

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

パラメータ 値 説明
seller_id
（必須）		 string ストアアカウントを指定します。
page_key string 取得したい親カテゴリのページキーを指定します。
指定がない場合は第1階層を取得します。

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

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

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/stCategoryList?seller_id=teststore&page_key=c3e6b8c5a5

サンプルリクエスト

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

レスポンスフィールド

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

  • totalResultsAvailable : 該当件数の総個数です。
  • totalResultsReturned : 返された値の個数です。（必ずtotalResultsAvailableと同じ値になります）
  • firstResultPosition : 最初のデータが何個目に当たるかです。（必ず1になります）

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/PageKey ストアカテゴリページキー
/ResultSet/Result/Name ストアカテゴリ名
/ResultSet/Result/Display ページ公開
0 : 非公開
1 : 公開
/ResultSet/Result/HiddenPageFlag 隠しページフラグ
0 : 通常ページ
1 : 隠しページ
/ResultSet/Result/SortOrder 指定ストアカテゴリ内での子ストアカテゴリ表示順序
/ResultSet/Result/EditingFlag 編集フラグ
0 : 反映済み
1 : 編集されてからフロント反映されていない状態
/ResultSet/Result/UpdateTime 更新日時（RFC3339）

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
 <Result>
     <PageKey>c3e6b8c5a5</PageKey>
     <Name>カテゴリ1</Name>
     <Display>1</Display>
     <HiddenPageFlag>1</HiddenPageFlag>
     <EditingFlag>0</EditingFlag>
     <UpdateTime>2013-02-06T16:58:32+09:00</UpdateTime>
 </Result>
 <Result>
     <PageKey>c2f1b8d4a3</PageKey>
     <Name>カテゴリ2</Name>
     <Display>0</Display>
     <HiddenPageFlag>0</HiddenPageFlag>
     <EditingFlag>1</EditingFlag>
     <UpdateTime>2013-02-07T16:58:32+09:00</UpdateTime>
 </Result>
</ResultSet>

エラー

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

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

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

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

エラーコード

コード HTTPステータスコード 説明
sc-03001 400 指定されたカテゴリページキーは存在しないか、親カテゴリではありません。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント