在庫参照API

Yahoo!ショッピングの在庫データベースを参照し、指定した条件に該当する在庫データを返します。

変更履歴

サンプルコード（PHP版）をご用意しています。こちらのページをご確認ください。

リクエストURL

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

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

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。 使用できる文字は、小文字の半角英数字、ハイフン「-」、アンダーバー「_」になります。 最大文字数は128文字です。
item_code （必須）	string	商品コードを指定します。 カンマ「,」区切りで最大1,000個まで指定できます。 個別商品コードを持たない商品については、商品コードのみを指定してください。 個別商品コードを持つ商品については、商品コードと個別商品コードをコロン「:」でつなげてください。 使用できる文字は、共に半角英数字、ハイフン「-」になります。 最大文字数は共に99文字です。

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getStock

サンプルリクエスト

POST /ShoppingWebService/V1/getStock HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

seller_id=yshop&item_code=item-01:sub-01,item-01:sub-02

サンプルコード（PHP）

<?php

  $header = [
      'POST /ShoppingWebService/V1/getStock HTTP/1.1',
      'Host: circus.shopping.yahooapis.jp',
      'Authorization: Bearer ' . ＜アクセストークン＞
  ];

  $url   = 'https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getStock';
  $param = array(
              "seller_id" => '＜ストアアカウント＞',
              "item_code" => '＜商品コード＞',
          );

  // 必要に応じてオプションを追加してください。
  $ch = curl_init();
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST,  'POST');
  curl_setopt($ch, CURLOPT_HTTPHEADER,     $header);
  curl_setopt($ch, CURLOPT_URL,            $url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST,           true);
  curl_setopt($ch, CURLOPT_POSTFIELDS,     http_build_query($param));

  $response = curl_exec($ch);
  curl_close($ch);

?>

レスポンスフィールド

フィールド	説明
/ResultSet	クエリーレスポンスのすべてを含み、次の属性を持ちます。 totalResultsAvailable : 指定した条件に該当した在庫情報の総件数です。 totalResultsReturned : 返却した在庫情報の総件数です。（＝totalResultsAvailable） firstResultPosition : 返却した在庫情報の開始位置です。（1固定） ok : 在庫情報を取得できた件数です。 ng : 在庫情報を取得できなかった件数です。
/ResultSet/Result	各個別レスポンスを含みます。
/ResultSet/Result/ItemCode	商品コード
/ResultSet/Result/SubCode	個別商品コード 個別商品コードを持たない商品の場合は空になります。
/ResultSet/Result/Status	在庫取得ステータス 0 : 在庫情報なし 1 : 在庫情報あり
/ResultSet/Result/Quantity	在庫数 空の場合は在庫数が無限大であることを意味します。
/ResultSet/Result/AllowOverdraft	超過購入設定 0 : 超過購入不可能 1 : 超過購入可能
/ResultSet/Result/IsPublished	商品反映フラグ 0 : 商品反映されていない状態 1 : 商品反映済み
/ResultSet/Result/UpdateTime	最終更新日時（RFC3339） 例）2013-03-09T12:34:56+09:00
/ResultSet/Result/StockClose	在庫クローズフラグ 0:通常状態 1:在庫クローズ状態

サンプルレスポンス

<ResultSet totalResultsAvailable="2" totalResultsReturned="2" firstResultPosition="1" ok="1" ng="1">
    <Result>
        <ItemCode>
            item-01
        </ItemCode>
        <SubCode>
            sub-01
        </SubCode>
        <Status>
            1
        </Status>
        <Quantity>
            10
        </Quantity>
        <AllowOverdraft>
            0
        </AllowOverdraft>
        <IsPublished>
            1
        </IsPublished>
        <UpdateTime>
            2013-03-09T12:34:56+09:00
        </UpdateTime>
    </Result>
    <Result>
        <ItemCode>
            item-01
        </ItemCode>
        <SubCode>
            sub-02
        </SubCode>
        <Status>
            0
        </Status>
    </Result>
</ResultSet>

エラー

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

• Yahoo! ショッピングAPI共通エラーコード一覧

在庫参照APIで固有に返すエラーコードは以下をご覧ください。

エラーコード

コード	HTTPステータスコード	説明
st-01999	500	システムエラーが発生しました。
st-01100	400	パラメータ「seller_id」が不正です。
st-01101	400	パラメータ「item_code」が不正です。
st-01102	400	パラメータ「item_code」に指定した商品コードの数が上限値を超えています。
st-01103	400	パラメータ「item_code」に重複する商品コードが含まれています。
ed-00002	503	メンテナンス中です。
ed-00003	400	ストアアカウントが指定されていません。 2021年3月中旬変更予定
ed-00005	400	ストアアカウントの指定が不正です。 2021年3月中旬変更予定
ed-00004	400	ストアアカウントが存在しません。 2021年3月中旬変更予定
ed-00001	500	システムエラーが発生しました。 2021年3月中旬変更予定

利用制限

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

利用約款

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