ショッピング

反映履歴/未反映項目詳細API

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


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

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

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
publish_id
(必須)
integer 取得する反映履歴IDを指定します。
0を指定した場合、未反映項目詳細を取得します。
start integer
(デフォルト : 1)
何件目からデータの取得をはじめるかを指定します。
results integer
(デフォルト : 25)
データの取得件数を指定します。(最大値100)
sort string
(デフォルト : -modify_time)
一覧のソート項目を指定します。指定のない場合は反映日時の降順になります。
modify_time : 更新日時
modify_user : 編集者
項目の前に以下の記号を付与することで、昇順降順を変更可能です。
+(昇順)/-(降順) ※UTF-8でURLエンコードされている必要があります。

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

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


サンプルリクエストURL

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

サンプルリクエスト

GET /ShoppingWebService/V1/publishHistoryDetail?seller_id=teststore&publish_id=12345&start=1&results=25&sort=%2Bmodify_user HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>



レスポンスフィールド

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

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

/ResultSet/Result 各反映履歴詳細を含みます。
/ResultSet/Result/ModifyType 更新タイプ
1 : 新規
2 : 編集
3 : 削除
/ResultSet/Result/PageType ページ種類
1 : トップページ、その他
2 : カテゴリページ
3 : 商品ページ
4 : カスタムページ
5 : ストアデザイン
6 : 商品画像
7 : 追加画像
/ResultSet/Result/TargetKey データの種類によって下記の内容となります。
ページ系 : ページキー
ストアデザイン : モジュールID
商品画像 : 画像ID
追加画像 : ファイル名
/ResultSet/Result/Name データの種類によって下記の内容となります。
トップページ、その他 : ページタイトル
カテゴリページ : カテゴリ名
商品ページ : 商品名
カスタムページ : ページタイトル
ストアデザイン : ヘッダ、サイドナビ、フッタ、ボディ(トップ)、ボディ(カテゴリ)、ボディ(商品)、ボディ(カスタム)、全体の設定
商品画像 : ファイル名
追加画像 : ファイル名
/ResultSet/Result/ModifyUser 編集者(APIで編集した場合、編集者は記録されず「-」となります)
/ResultSet/Result/ModifyTime 更新日時(RFC3339)



サンプルレスポンス

<ResultSet totalResultsAvailable="59" totalResultsReturned="2" firstResultPosition="1">
    <Result>
        <ModifyType>1</ModifyType>
        <PageType>2</PageType>
        <TargetKey>a5aba5c6a52</TargetKey>
        <Name>カテゴリ1</Name>
        <ModifyUser>-</ModifyUser>
        <ModifyTime>2013-02-06T16:58:32+09:00</ModifyTime>
    </Result>
    <Result>
        <ModifyType>2</ModifyType>
        <PageType>5</PageType>
        <TargetKey>a5aba5c6a52</TargetKey>
        <Name>サイドナビ</Name>
        <ModifyUser>-</ModifyUser>
        <ModifyTime>2013-02-06T16:58:32+09:00</ModifyTime>
    </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-04001 400 反映履歴IDが指定されていません。
pm-04002 400 指定された反映履歴IDは存在しません。
pm-04003 403 指定されたデータの取得件数が最大値を超えています。
pm-04004 400 反映履歴IDの値が不正です。
pm-04005 400 startの値が不正です。
pm-04006 400 resultsの値が不正です。
pm-04007 400 sortの値が不正です。




利用制限

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

利用約款

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