反映履歴詳細API（V2）

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

変更履歴

2022年04月27日

レスポンスフィールド「updateType」の説明を修正しました。
前）UPDATE：編集
後）ORVERWRITE：編集

2021年08月10日

1）リクエストパラメータに下記項目を追加しました。
・data_type（更新データの種類）
2）リクエストパラメータ「start」のデフォルト値を変更しました。
・1 → 0
3）レスポンスフィールドから下記項目を削除しました。
・dataType（更新データの種類）
・uploadType（アップロード種別）
・totalFileNum（反映数）
・editUser（反映者）
・publishStatus（反映状況）
・createTime（反映日時）
・errorCount（エラー数）
4）レスポンスフィールドに下記項目を追加しました。
・imageName（画像のファイル名）
・uniqueImageName（画像ID）
・imageType（画像タイプ）
・updateType（アップロード種別）
・updateTime（更新日時）

リクエストURL

リクエストURL（JSON）

本番環境

https://circus.shopping.yahooapis.jp/ShoppingWebService/V2/publishHistoryDetail

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

リクエストパラメータ

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

パラメータ	値	説明
seller_id （必須）	string	ストアアカウントを指定します。
bulk_id （必須）	string	取得する反映履歴IDを指定します。
data_type	string	更新データの種類・IMAGE：画像（・ITEM：商品）
start	integer （デフォルト : 0）	何件目からデータの取得をはじめるかを指定します。
results	integer （デフォルト : 25）	データの取得件数を指定します。（最大値100）

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

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

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V2/publishHistoryDetail?seller_id=teststore&bulk_id=12345&data_type=IMAGE&start=1&results=25&sort=%2Bmodify_user

サンプルリクエスト

GET /ShoppingWebService/V2/publishHistoryDetail?seller_id=teststore&bulk_id=12345&data_type=IMAGE&start=1&results=25 HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

反映履歴/未反映項目詳細API（V2）のスキーマの記述は、以下になります。

フィールド	値	説明
-	配列	画像の反映サマリデータが配列で応答されます。
sellerId	string	ストアアカウント
bulkId	string	エラー詳細のキー
imageName	string	画像のファイル名 data_type=IMAGEを指定時に返却する。
uniqueImageName	string	画像ID data_type=IMAGEを指定時に返却する。
imageType	string	画像タイプ・item : 商品画像・item_detail：商品詳細画像・lib：追加画像
updateType	string	アップロード種別・NEW：追加・ORVERWRITE：編集・DELETE：削除・SKIP：変更なし・ERROR：エラー
updateTime	string	更新日時

サンプルレスポンス

[
    {
        "sellerId": "scproalltest-418",
        "bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
        "imageName": "image.jpeg",
        "uniqueImageName": "image",
        "imageType": "item",
        "updateType": "NEW",
        "updateTime": "2021/07/14 16:34:49"
    },
    {
        "sellerId": "scproalltest-418",
        "bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
        "imageName": "image_1.jpeg",
        "uniqueImageName": "image_1",
        "imageType": "item_detail",
        "updateType": "NEW",
        "updateTime": "2021/07/14 16:34:49"
    },
    {
        "sellerId": "scproalltest-418",
        "bulkId": "2144727e-060d-4dd6-95fe-b97bbcb90226",
        "imageName": "image_2.jpeg",
        "uniqueImageName": "image_2",
        "imageType": "item_detail",
        "updateType": "NEW",
        "updateTime": "2021/07/14 16:34:49"
    }
]

エラー

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

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（V2）

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

エラー

利用制限

利用約款

利用のルール

開発のヒント

サービス一覧