データチェック履歴詳細API（v2）
アップロードした商品、画像、在庫、ストアカテゴリ、カート内関連商品のデータチェック履歴詳細を取得します。
リリース予定日：2021年2月下旬予定
変更履歴
2022年06月13日
レスポンスフィールドを更新しました。・「fileName」 → 「imageName」へ修正
・「totalErrorCount」を追加
・「lineNum」の説明文に「dataTypeがSTOCKの場合のみ値が返却される」を追加
2021年04月08日
リクエストパラメータ「dataType」の説明を更新しました。
リクエストURL
リクエストURL（本番環境）
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V2/dataCheckHistoryDetail
リクエストURL（テスト環境）
XML
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V2/dataCheckHistoryDetail
リクエストパラメータ
「Web APIの使い方#GETとは」をご参照ください。
| パラメータ | 必須 | 型 | デフォルト値 | 値の例 | 説明 |
|---|---|---|---|---|---|
| seller_id | 〇 | string | teststore | ストアアカウントを指定します。 | |
| bulkId | 〇 | integer | 2144727e-060d-4dd6-95fe-b97bbcb90226 | 参照するデータチェックIDを指定します。 | |
| dataType | 〇 | integer | 0 | STOCK | 現時点ではSTOCK(在庫)のみが指定できます。 ※2022年5月以降、「IMAGE（画像）」を指定いただけます。 出店者様ごとに順次リリースになりますので、リリース日について告知ページにてご確認ください。 |
| limit | integer | 25 | データの取得件数を指定します。（最大値100） デフォルト値(25) ※「在庫」の場合、リクエスト指定可能 |
||
| offset | integer | 0 | 何件目からデータの取得をはじめるかを指定します。 デフォルト値(0) ※「在庫」の場合、リクエスト指定可能 |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
※こちらのAPIを利用する場合は、こちらからClient ID（アプリケーションID）を取得してください。
サンプルリクエストURL
http://circus.shopping.yahooapis.jp/ShoppingWebService/V2/dataCheckHistoryDetail?sellerId=teststore&bulkId=2144727e-060d-4dd6-95fe-b97bbcb90226&dataType=STOCKレスポンスフィールド
出力形式
| 文字コード | UTF-8 |
|---|---|
| Content-Type | application/json |
| フォーマット | json |
仕様
| フィールド | 値 | 説明 |
|---|---|---|
| - | 配列 | 在庫・画像の反映サマリデータが配列で応答されます。 |
| sellerId | string | ストアアカウントが返却されます。 |
| bulkId | string | エラー詳細のキーです。 |
| sellerManagedItemId | string | 入力した商品コードが応答されます。 エラーとなった商品コードが1000文字を超え、 フォーマットエラーとなった場合は1000文字まで返却されます。 |
| lineNum | integer | CSVデータのエラーとなっている行数が応答されます。 dataTypeがSTOCKの場合のみ値が返却される |
| field | string | FTP入稿されたCSVデータのエラーとなっているフィールド名です。 |
| errorCode | string | 後述するエラーコードが返却されます。 |
| imageType | string | 画像ファイルタイプ ITEM：商品画像 IMTE_DETAIL:商品詳細画像 LIB：追加画像 |
| string | 登録した画像ファイル名 | |
| totalErrorCount | string | 画像登録処理のエラー件数 dataTypeがIMAGEの場合のみ返却 |
エラーコード仕様
※エラーメッセージは返却されません
| エラーコード | エラー内容 |
|---|---|
| mkwrite-stock-1001 | 商品コードは必須です。 |
| mkwrite-stock-1002 | 個別商品コードは99バイト以内で入力してください。 |
| mkwrite-stock-1003 | 個別商品コードは99バイト以内で入力してください。 |
| mkwrite-stock-1004 | 個別商品コードのフォーマットが無効です。 |
| mkwrite-stock-1005 | 商品コードは必須です。 |
| mkwrite-stock-1006 | 個別商品コードは必須です。 |
| mkwrite-stock-1007 | 個別商品コードは99バイト以内で入力してください。 |
| mkwrite-stock-1008 | 個別商品コードは99バイト以内で入力してください。 |
| mkwrite-stock-1009 | 個別商品コードのフォーマットが無効です。 |
| mkwrite-stock-1010 | 商品コードは必須です。 |
| mkwrite-stock-1011 | 在庫は空欄または、0～999999999を入力してください。 |
| mkwrite-stock-1012 | 在庫は空欄または、0～999999999を入力してください。 |
| mkwrite-stock-1013 | 在庫は空欄または、0～999999999を入力してください。 |
| mkwrite-stock-1014 | 在庫は空欄または、0～999999999を入力してください。 |
| mkwrite-stock-1015 | 在庫モードのフォーマットが無効です。 |
| mkwrite-stock-1016 | 在庫クローズの値が不正です。 |
| mkwrite-stock-1017 | 在庫クローズの値を補正しました。 |
| mkwrite-stock-1018 | 超過購入設定は空欄または、0,1を入力してください。 |
| mkwrite-stock-1019 | 商品数が上限を超えています。 |
| mkwrite-stock-9999 | システムエラーが発生しました。 |
| mkwrite-system-0001 | システムエラーが発フォーマット生しました。 |
| ERROR-AP-PC-0001 | データが存在しません。 |
| ERROR-AP-PC-0002 | データが存在しません。 |
| ERROR-AP-PC-0003 | 商品コードは必須です。 |
| ERROR-AP-PC-0004 | 入力された商品コードは重複しています。 |
| ERROR-AP-PC-0005 | フィールドの設定に誤りがあります。 |
| ERROR-AP-PC-0006 | システムエラーが発生しました。 |
| ERROR-AP-PC-0007 | システムエラーが発生しました。 |
| ERROR-AP-PC-0008 | システムエラーが発生しました。 |
| ERROR-AP-PC-0009 | ファイルサイズが10メガバイトを超えています。 |
| ERROR-AP-PC-0010 | ファイル行数が10,000行を超えています。 |
| ERROR-AP-PC-0011 | システムエラーが発生しました。 |
| ERROR-AP-PC-0012 | ファイルのフォーマットが無効です。 |
| ERROR-AP-PC-0013 | システムエラーが発生しました。 |
| ERROR-AP-PC-0014 | システムエラーが発生しました。 |
| ERROR-AP-PC-0015 | システムエラーが発生しました。 |
| ERROR-AP-PC-0016 | システムエラーが発生しました。 |
| ERROR-AP-PC-0017 | 文字コードはSJISかEUCで入力してください。 |
| ERROR-AP-PC-0018 | システムエラーが発生しました。 |
| ERROR-AP-PC-0019 | システムエラーが発生しました。 |
| ERROR-AP-PC-0098 | システムエラーが発生しました。 |
| ERROR-AP-PC-0099 | システムエラーが発生しました。 |
サンプルレスポンス
[
{
"sellerId": "scproalltest-418",
"bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
"sellerManagedItemId": "Editor-001",
"lineNum": 2,
"field": "code",
"errorCode": "mkwrite-stock-1005"
},
{
"sellerId": "scproalltest-418",
"bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
"sellerManagedItemId": "Editor-001",
"lineNum": 2,
"field": null,
"errorCode": "mkwrite-system-0001"
},
{
"sellerId": "scproalltest-418",
"bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
"sellerManagedItemId": "Editor-001",
"lineNum": 3,
"field": "stock-close",
"errorCode": "mkwrite-stock-1017"
}
]エラー
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に関する利用約款はこちら。