ショッピング

データチェック履歴詳細API

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


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

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

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
check_id
(必須)
integer 参照するデータチェックIDを指定します。
error_type integer
(デフォルト : 0)
絞り込むエラー種別を指定します。
0 : すべて
1 : エラー
2 : 警告
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/dataCheckHistoryDetail?seller_id=teststore&check_id=12345&error_type=1&start=1&results=25

サンプルリクエスト

GET /ShoppingWebService/V1/dataCheckHistoryDetail?seller_id=teststore&check_id=12345&error_type=1&start=1&results=25 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

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

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

/ResultSet/Result 各データチェック詳細の要素を含みます。
/ResultSet/Result/ErrorLine エラー行番号
/ResultSet/Result/ErrorCode エラーコード
/ResultSet/Result/ErrorMsg エラーメッセージ
/ResultSet/Result/DataKey データの種類によって下記の内容となります。
ストアカテゴリ : カテゴリパス
商品 : 商品コード
商品画像 : ファイル名
追加画像 : ファイル名
在庫 : 商品コード
カート内関連商品 : 購入商品の商品コード
/ResultSet/Result/FieldName アップロードされたファイルがCSVの場合、フィールド名となります。
画像の場合、「name」という文字列が固定で入ります。
/ResultSet/Result/ErrorType エラー種別
1:エラー
2:警告



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <ErrorLine>123</ErrorLine>
        <ErrorCode>X-000-0001</ErrorCode>
        <ErrorMsg>システムエラーが発生しました。</ErrorMsg>
        <DataKey>myitem001</DataKey>
        <FieldName>price</FieldName>
        <ErrorType>1</ErrorType>
    </Result>
    <Result>
        <ErrorLine>124</ErrorLine>
        <ErrorCode>X-000-0002</ErrorCode>
        <ErrorMsg>不正な文字列が含まれています。</ErrorMsg>
        <DataKey>myitem002</DataKey>
        <FieldName>title</FieldName>
        <ErrorType>2</ErrorType>
    </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-02001 400 データチェックIDが指定されていません。
pm-02002 400 指定されたデータチェックIDは存在しません。
pm-02003 400 定義されていないerror_typeが指定されています。
pm-02004 403 指定されたデータの取得件数が最大値を超えています。
pm-02005 400 不正なパラメタが指定されています。
pm-02006 400 check_idが不正です。
pm-02007 400 startが不正です。
pm-02008 400 resultsが不正です。




利用制限

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

利用約款

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