ショッピング

データチェック履歴一覧API

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


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

アップロードした商品、画像、在庫、ストアカテゴリ、カート内関連商品のデータチェック履歴一覧を取得します。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
check_id integer 単一のデータチェック履歴だけ参照する場合にデータチェックIDを指定します。
指定しない場合、全データチェック履歴が対象となります。
file_type integer
(デフォルト : 0)
絞り込むデータの種類を指定します。
0 : すべて
1 : ストアカテゴリ
2 : 商品
3 : 商品画像
4 : 追加画像
5 : 在庫
6 : カート内関連商品
check_user string 単一のデータチェック履歴だけ参照する場合にチェックユーザーを指定します。
指定しない場合、全データチェック履歴が対象となります。
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/dataCheckHistorySummary?seller_id=teststore&file_type=2&check_user=FTP&start=1&results=25

サンプルリクエスト

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



レスポンスフィールド

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

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

/ResultSet/Result 各データチェック履歴の要素を含みます。
/ResultSet/Result/CheckId データチェックID
/ResultSet/Result/CheckTime データチェック日時(RFC3339)
/ResultSet/Result/CheckUser 編集者(APIで編集した場合、編集者は記録されず「-」となります)
/ResultSet/Result/UploadType アップロードタイプ
1 : 追加
2 : 上書き
3 : 削除
4 : 項目指定
/ResultSet/Result/FileType データの種類
1 : ストアカテゴリ
2 : 商品
3 : 商品画像
4 : 追加画像
5 : 在庫
6 : カート内関連商品
/ResultSet/Result/CheckStatus ステータス
0 : チェック中
1 : チェック済み
2 : 読込中
3 : 読込済み
9 : エラー
/ResultSet/Result/DataNum アップロード総件数
/ResultSet/Result/ErrorNum エラー総件数



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <CheckId>12345</CheckId>
        <CheckTime>2013-02-06T16:58:32+09:00</CheckTime>
        <CheckUser>-</CheckUser>
        <UploadType>1</UploadType>
        <FileType>2</FileType>
        <CheckStatus>3</CheckStatus>
        <DataNum>28</DataNum>
        <ErrorNum>9</ErrorNum>
    </Result>
    <Result>
        <CheckId>12346</CheckId>
        <CheckTime>2013-02-07T16:58:32+09:00</CheckTime>
        <CheckUser>-</CheckUser>
        <UploadType>2</UploadType>
        <FileType>4</FileType>
        <CheckStatus>0</CheckStatus>
        <DataNum>102</DataNum>
        <ErrorNum>98</ErrorNum>
    </Result>
</ResultSet>



エラー

データチェック履歴一覧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ステータスコード 説明
pm-01002 400 file_typeの値が不正です。
pm-01003 400 指定されたデータの取得件数が最大値を超えています。
pm-01004  400  check_idの値が不正です。
pm-01005 400  startの値が不正です。
pm-01006  400 resultsの値が不正です。
pm-01007 400 check_userの値が不正です。 




利用制限

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

利用約款

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