ショッピング

商品リストAPI

リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/myItemList


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

自分のストアの登録商品のリストを返します。
このAPIを利用し、商品一括更新APIを利用して商品データを更新することが可能です。
※商品参照APIは商品コードのみの指定ですが、このAPIは検索ワードや商品名などで複数のデータ情報を取得することが可能です。(ただし、参照項目は異なります)
※2016年4月6日以降、「リクエストパラメータ」の一部変更がございます。詳しくは「リクエストパラメータ」をご覧ください

リクエストパラメータ

RESTリクエストの構築(GET)」をご参照ください。

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
stock boolean
(デフォルト : false)
在庫数を取得するかどうか指定します。
false : 在庫数を取得しない
true : 在庫数を取得する
start integer
(デフォルト : 1)
何件目からデータの取得をはじめるかを指定します。

(例 : データが100件あった場合。startを「26」にしてresultsを「25」にした場合は、100件あるデータのうち26件目~50件目のデータを取得する。商品データ編集画面などを作る際の表示イメージ)
results integer
(デフォルト : 25)
データの取得件数(最大値100)を指定します。
query
(必須※1)
string 検索ワードを指定します。
スペース区切りで複数指定した場合は、AND検索となります。
type string
(デフォルト : item_code)
検索する項目を指定します。
item_code : 商品コード(前方一致)
name : 商品名 (部分一致)
sort string
(デフォルト : +sort_order)
※デフォルト値は2016年4月6日以降は「+sort_priority」が設定されます
一覧のソート項目を指定します。指定のない場合はsort_orderの昇順になります。
sort_order : ストアカテゴリ下の並び順 ※こちらのパラメータは2016年4月5日をもって削除を予定しております
item_code : 商品コード
name : 商品名
stcat_key : 親カテゴリのページキー
sort_priority : 商品表示優先順
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順)※UTF-8でURLエンコードされている必要があります。
stcat_key
(必須※1)
string 絞り込むストアカテゴリのページキーを指定します。

※1 どちらか片方のパラメータが必須です。

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

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


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/myItemList?seller_id=teststore&start=1&results=50&query=%BE%A6%C9%CA%A3%B1&type=name&sort=%2Bitem_code

サンプルリクエスト

GET /ShoppingWebService/V1/myItemList?seller_id=teststore&start=1&results=50&query=%BE%A6%C9%CA%A3%B1&type=name&sort=%2Bitem_code HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

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

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

/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/ItemCode 商品コード
/ResultSet/Result/HasSubCode サブコードの有無
1 : サブコードあり
0 : サブコードなし
/ResultSet/Result/Name 商品名(CDATA)
/ResultSet/Result/StCatName ストアカテゴリ名(CDATA)
リクエストパラメータでstcat_keyが指定されているときはそのカテゴリ名が表示されます。
stcat_keyが指定されていないときは、実体が所属するカテゴリ名が表示されます。
/ResultSet/Result/Display ページ公開
1 : 公開
0 : 非公開
/ResultSet/Result/EditingFlag 編集フラグ
1 : 編集されてからフロント反映されていない状態
0 : 反映済み
/ResultSet/Result/OriginalPrice 定価
/ResultSet/Result/Price 通常販売価格
/ResultSet/Result/SalePrice 特価
/ResultSet/Result/SalePeriodStart 販売開始日時(RFC3339)
/ResultSet/Result/SalePeriodEnd 販売終了日時(RFC3339)
/ResultSet/Result/SortOrder ストアカテゴリ下の商品表示順序
/ResultSet/Result/SortPriority ストアカテゴリ下の商品表示優先順
/ResultSet/Result/Quantity 在庫(stock=true のリクエストが指定されているときのみ項目があります。)



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="220" totalResultsReturned="50" firstResultPosition="101">
    <Result>
        <ItemCode>939124-001</ItemCode>
        <HasSubCode>0</HasSubCode>
        <Name><![CDATA[防水CD/DVDプレーヤー/mini labo/ベルメゾンネット]]></Name>
        <StCatName><![CDATA[カテゴリ1]]></StCatName>
        <Display>1</Display>
        <EditingFlag>0</EditingFlag>
        <OriginalPrice>30000</OriginalPrice>
        <Price>29800</Price>
        <SalePrice>20000</SalePrice>
        <SalePeriodStart>2013-06-25T10:00:00+09:00</SalePeriodStart>
        <SalePeriodEnd>2013-07-25T21:00:00+09:00</SalePeriodEnd>
        <SortOrder>3</SortOrder>
        <SortPriority>1</SortPriority>
        <Quantity>2</Quantity>
    </Result>
 
(以下 <Result>要素繰り返し)



エラー

商品リスト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ステータスコード 説明
it-08001 400 queryかstcat_keyのどちらか片方が必須です。
it-08002 400 指定されたデータの取得件数が最大値を超えています。
it-08003 400 stockの値が不正です。
it-08004 400  startの値が不正です。
it-08005 400 resultsの値が不正です。
it-08006 400 typeの値が不正です。
it-08007 400 sortの値が不正です。
it-08008  400 stcat_keyの値が不正です。
it-08009  400 queryの値が不正です。




利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

利用約款

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