反映履歴/未反映項目一覧API

反映した履歴の一覧および未反映項目の一覧を取得します。

変更履歴

2022年04月08日

下記レスポンスフィールドの「説明」を更新しました。

  • /ResultSet/Result/ItemImageNum
  • /ResultSet/Result/LibImageNum

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/publishHistorySummary
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/publishHistorySummary

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

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
publish_id integer 単一の反映履歴だけ参照する場合に反映履歴IDを指定します。
0を指定した場合、未反映項目を取得します。
指定しない場合、0(未反映項目)以外の全反映履歴が対象となります。
start integer
(デフォルト : 1)
何件目からデータの取得をはじめるかを指定します。
results integer
(デフォルト : 25)
データの取得件数を指定します。(最大値100)
sort string
(デフォルト : -publish_time)
一覧のソート項目を指定します。指定のない場合は反映日時の降順になります。
publish_time : 反映日時
publish_user : 反映者
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順) ※UTF-8でURLエンコードされている必要があります。

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

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

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/publishHistorySummary?seller_id=teststore&start=1&results=25&sort=%2Bpublish_user

サンプルリクエスト

GET /ShoppingWebService/V1/publishHistorySummary?seller_id=teststore&start=1&results=25&sort=%2Bpublish_user HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

反映履歴/未反映項目一覧APIのスキーマの記述は、以下になります。

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

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

/ResultSet/Result 各反映履歴の要素を含みます。
/ResultSet/Result/PublishId 反映履歴ID
/ResultSet/Result/PublishUser 反映者(APIで反映した場合、反映者は記録されず「-」となります)
/ResultSet/Result/PublishTime 反映日時(RFC3339)
/ResultSet/Result/ItemPageNum 商品ページの反映数
/ResultSet/Result/CategoryPageNum カテゴリページの反映数
/ResultSet/Result/TopPageNum トップページその他の反映数
/ResultSet/Result/CustomPageNum カスタムページの反映数
/ResultSet/Result/StoreDesignNum ストアデザインの反映数
/ResultSet/Result/ItemImageNum 商品画像の反映数
※2022年5月以降件数が返却されなくなります。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
/ResultSet/Result/LibImageNum 追加画像の反映数
※2022年5月以降件数が返却されなくなります。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <PublishId>12345</PublishId>
        <PublishUser>-</PublishUser>
        <PublishTime>2013-02-06T16:58:32+09:00</PublishTime>
        <ItemPageNum>28</ItemPageNum>
        <CategoryPageNum>28</CategoryPageNum>
        <TopPageNum>28</TopPageNum>
        <CustomPageNum>28</CustomPageNum>
        <StoreDesignNum>28</StoreDesignNum>
        <ItemImageNum>28</ItemImageNum>
        <LibImageNum>28</LibImageNum>
    </Result>
    <Result>
        <PublishId>12346</PublishId>
        <PublishUser>FTP</PublishUser>
        <PublishTime>2013-02-07T16:58:32+09:00</PublishTime>
        <ItemPageNum>0</ItemPageNum>
        <CategoryPageNum>0</CategoryPageNum>
        <TopPageNum>0</TopPageNum>
        <CustomPageNum>0</CustomPageNum>
        <StoreDesignNum>8</StoreDesignNum>
        <ItemImageNum>0</ItemImageNum>
        <LibImageNum>0</LibImageNum>
    </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ステータスコード 説明
pm-03001 400 指定された反映履歴IDは存在しません。
pm-03002 400 指定されたデータの取得件数が最大値を超えています。
pm-03003 400 publish_idの値が不正です。
pm-03004 400 startの値が不正です。
pm-03005 400 resultsの値が不正です。
pm-03006 400 sortの値が不正です。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント