追加画像ディレクトリ一覧API
追加画像ディレクトリの一覧を取得します。
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/libDirectoryList
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/libDirectoryList
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「Web APIの使い方#GETとは」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
seller_id (必須) |
string | ストアアカウントを指定します。 |
サンプルリクエストURL
http://circus.shopping.yahooapis.jp/ShoppingWebService/V1/libDirectoryList?appid=<あなたのClient ID(アプリケーションID)>&seller_id=teststore
サンプルリクエスト
GET /ShoppingWebService/V1/libDirectoryList?seller_id=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
レスポンスフィールド
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含みます |
/ResultSet/Result | 結果 |
/ResultSet/Result/TotalCount | 該当件数の個数です。 |
/ResultSet/Result/Directory | 追加画像ディレクトリ名 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
<Result>
<TotalCount>6</TotalCount>
<Directory>パーツ</Directory>
<Directory>dir_A</Directory>
<Directory>dir_B</Directory>
<Directory>dir_C</Directory>
<Directory>dir_D</Directory>
<Directory>dir_E</Directory>
</Result>
</ResultSet>
エラー
Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。
追加画像ディレクトリ一覧APIで固有に返すエラーコードは以下をご覧ください。
商品系API共通エラーコード
コード | HTTPステータスコード | 説明 |
---|---|---|
ed-00000 | 404 | ページが見つかりません。 |
ed-00001 | 500 | システムエラーが発生しました。 |
ed-00002 | 503 | サーバがメンテナンス中です。 |
ed-00003 | 400 | ストアアカウントが指定されていません。 |
ed-00004 | 400 | ストアアカウントが存在しません。 |
ed-00005 | 400 | ストアアカウントの指定が不正です。 |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
利用約款
このAPIに関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ