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

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

リリース予定日：2021年2月下旬予定

変更履歴

2022年04月27日

「仕様」欄の下記項目を修正しました。
・dataType・・・「IMAGE：画像」を追加
・uploadType・・・「DEL：削除」を追加

2022年04月08日

・リクエストパラメータ「dataType」の説明を更新しました。
・レスポンスフィールド「publishStatus」の説明を更新しました。

リクエストURL

リクエストURL（本番環境）
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V2/dataCheckHistorySummary
リクエストURL（テスト環境）
XML
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V2/dataCheckHistorySummary

リクエストパラメータ

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

パラメータ 必須 型 デフォルト値 値の例 説明
seller_id 〇 string teststore ストアアカウントを指定します。
isFtpOnly boolean false ストアアカウントを指定します。
dataType 〇 string STOCK 現時点ではSTOCK(在庫)のみが指定できます。
※2022年5月以降、「IMAGE（画像）」を指定いただけます。
出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。
limit integer 25 データの取得件数を指定します。（最大値100）
デフォルト値(25)
※dataTypeがIMAGE(画像)の場合のみ有効
※dataTypeがSTOCK(在庫)の場合は無効
offset integer 0 何件目からデータの取得をはじめるかを指定します。
デフォルト値(0)
※dataTypeがIMAGE(画像)の場合のみ有効
※dataTypeがSTOCK(在庫)の場合は無効

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

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

サンプルリクエストURL

http://circus.shopping.yahooapis.jp/ShoppingWebService/V2/dataCheckHistorySummary?seller_id=teststore&isFtpOnly=true&dataType=STOCK

レスポンスフィールド

出力形式

文字コード UTF-8
Content-Type application/json
フォーマット json

仕様

フィールド 値 説明
- 配列 在庫・画像の反映サマリデータが配列で応答されます。
sellerId string ストアアカウントが返却されます。
bulkId string サマリデータから詳細データを引き当てるときのキーとなります。
詳細データのキーに指定してください。
dataType string STOCK：在庫
IMAGE：画像
uploadType string ADD：追加
DEL：削除
reserveTime date 日時指定予約により反映された在庫/画像データデータの予約時間が返却されます。
予約による追加ではない場合は空文字が返却されます。
YYYY-MM-DD HH:mm:ssの形式
totalLine integer 反映を行ったデータの件数が返却されます。
editUser string 反映を行ったビジネスIDが返却されます。
FTP経由の反映の場合は"FTP"と返却されます。
publishStatus integer 反映ステータス：1~5の値が返却されます。
1: データの反映が開始され、反映中である際のステータスです。
2: データの反映が完了した際のステータスです。
3: データの反映時にエラーとなったデータが含まれる際のステータスです。
4: エラーで反映できていない状態。※エディタの反映履歴画面でも「エラー」と表示されます。
5: データの反映が完了した際のステータスです。商品画像の場合、商品と紐づけが行われていない状態となります。
※エディタの反映管理画面では「反映済み」と表示されます。
createTime date 当該履歴データが作成された日付です。
YYYY-MM-DD HH:mm:ssの形式
imageFileName 入稿したzip画像ファイル名
一括(zip)アップロードの場合は、zipファイル名
個別(画像ファイル単体)でアップロードの場合は、空欄
totalSummaryCount 反映した画像件数
totalFileNum 在庫の場合：空欄
画像の場合：
一括(zip)アップロードの場合は、zipファイル内の画像ファイル数
個別(画像ファイル単体)でアップロードの場合は、1度にアップロードした画像ファイル数

サンプルレスポンス

[
{
 "sellerId": "teststore",
 "bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
 "dataType": "STOCK",
 "uploadType": "ADD",
 "reserveTime": null,
 "totalLine": 3,
 "editUser": "testuser",
 "publishStatus": 2,
 "createTime": "2020-12-23 18:21:51"
},
{
 "sellerId": "teststore",
 "bulkId": "aa872fbe-3be8-4750-88ea-95302757f8e3",
 "dataType": "STOCK",
 "uploadType": "ADD",
 "reserveTime": null,
 "totalLine": 3,
 "editUser": "FTP",
 "publishStatus": 2,
 "createTime": "2020-12-23 18:05:50"
},
{
 "sellerId": "teststore",
 "bulkId": "26435f44-2fd4-4924-84bf-99056ca5c1a6",
 "dataType": "STOCK",
 "uploadType": "ADD",
 "reserveTime": null,
 "totalLine": 3,
 "editUser": "FTP",
 "publishStatus": 1,
 "createTime": "2020-12-08 15:06:03"
},
{
 "sellerId": "teststore",
 "bulkId": "97896c83-0e2c-4350-98c0-5cbb1aad798b",
 "dataType": "STOCK",
 "uploadType": "ADD",
 "reserveTime": null,
 "totalLine": 3,
 "editUser": "FTP",
 "publishStatus": 1,
 "createTime": "2020-12-08 15:04:42"
},
{
 "sellerId": "teststore",
 "bulkId": "0fe9c9ba-b0e7-4d6d-a7ec-7aeb7f4d29e8",
 "dataType": "STOCK",
 "uploadType": "ADD",
 "reserveTime": null,
 "totalLine": 3,
 "editUser": "FTP",
 "publishStatus": 1,
 "createTime": "2020-12-08 15:03:24"
}
]

エラー

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

データチェック履歴一覧API（v2）で固有に返すエラーコードは以下をご覧ください。

エラーコード

コード HTTPステータスコード 説明
ERR-00105 400 指定されたパラメータが不正な場合に返却されます。
ERR-00106 400 指定されたパラメータのフォーマット不正時などに返却されます。
ERR-00203 404 指定したデータがデータベースに存在しない場合に返却されます。
ERR-00299 500 システム内部で何らかのエラーが発生した際に返却されます。 
{
"errorCode": "ERR-00105",
"title": "INVALID_ARGUMENT"
}

利用制限

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

利用約款

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

アプリケーションの管理

利用のルール

開発のヒント