ショッピング
SHPブランドコード検索API
リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopBrandList
こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopBrandList
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
Yahoo!ショッピングのブランドを検索します。
リクエストパラメータ
「RESTリクエストの構築（GET）」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| seller_id （必須） |
string | ストアアカウントを指定します。 |
| query （必須） |
string | 検索ワードを指定します。 ブランドコードは前方一致、ブランド名は部分一致となります。 |
| type | string （デフォルト : all） |
検索項目を指定します。 all : すべて code : ブランドコード name : ブランド名 |
| sort | string （デフォルト : +jtitle） |
一覧のソート項目を指定します。 jtitle : 和名（ブランド名カナ） update_date : 更新日 項目の前に以下の記号を付与することで、昇順降順を変更可能です。 +（昇順）/-（降順） ※UTF-8でURLエンコードされている必要があります。 |
| start | integer （デフォルト : 1） |
何件目からデータの取得をはじめるかを指定します。 |
| results | integer （デフォルト : 25） |
データの取得件数を指定します。（最大値100） |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
・Yahoo! ID連携
・Yahoo! ID連携によるAPIアクセス実装方法
※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getShopBrandList?サンプルリクエスト
GET /ShoppingWebService/V1/getShopBrandList?Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| /ResultSet | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
| /ResultSet/Result | 各ブランドの要素を含みます。 |
| /ResultSet/Result/BrandCode | ブランドコード |
| /ResultSet/Result/BrandName | ブランド名 |
| /ResultSet/Result/BrandJtitle | 和名（ブランド名カナ） |
| /ResultSet/Result/PathName | ブランド階層 |
| /ResultSet/Result/UpdateDate | 更新日（YYYY-MM-DD） |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="1630" totalResultsReturned="2" firstResultPosition="1">
<Result>
<BrandCode>42</BrandCode>
<BrandName><![CDATA[LGCソフト]]></BrandName>
<BrandJtitle><![CDATA[LGでんしじゃぱん]]></BrandJtitle>
<PathName><![CDATA[LG電子]]></PathName>
<UpdateDate>2008-09-08</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-05001 | 400 | 検索ワードが指定されていません。 |
| pr-05002 | 400 | typeの値が不正です。 |
| pr-05003 | 400 | sortの値が不正です。 |
| pr-05004 | 400 | startの値が不正です。 |
| pr-05005 | 400 | resultsの値が不正です。 |
| pr-05006 | 400 | queryの値が不正です。 |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。（無料）
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。
利用約款
このAPIに関する利用約款はこちら。
