全反映予約API
保存した内容をお客様に見えるように反映するための処理または予約を行います。
リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/reservePublish
こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/reservePublish
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「Web APIの使い方#POSTとは」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
seller_id (必須) |
string | ストアアカウントを指定します。 |
mode (必須) |
integer | 反映予約を行うか予約取り消しを行うかのモードを指定します。 1 : 反映予約・予約日時変更 2 : 反映予約取り消し 3 : 予約確認 |
reserve_time | string (デフォルト : 現在の時刻) |
mode=1のとき、反映する日時を指定します。(YYYYMMDDHHmm形式) 予約は最大7日後まで可能です。(7日後の現在時刻まで) 空の場合は現在の時刻で予約を行います。 システム全体で反映処理が空いている場合は即反映となりますが、混んでいる場合は反映まで時間がかかります。 |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
※こちらのAPIを利用する場合は、こちらからClient ID(アプリケーションID)を取得してください。
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/reservePublish
サンプルリクエスト
POST /ShoppingWebService/V1/reservePublish HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
seller_id=teststore&mode=1&reserve_time=201302151330
レスポンスフィールド
フィールド | 説明 |
---|---|
/ResultSet | レスポンスのすべてを含みます。 |
/ResultSet/Status | 成功時に「OK」と表示します。 失敗時は別フォーマットでエラーレスポンスを表示します。 |
/ResultSet/ReserveTime | 予約日時(RFC3339) |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
<Status>OK</Status>
<ReserveTime>2013-07-24T18:45:57+09:00</ReserveTime>
</ResultSet>
エラー
Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。
商品系API、および全反映予約APIで固有に返すエラーコードは以下をご覧ください。
商品系API共通エラーコード
コード | HTTPステータスコード | 説明 |
---|---|---|
ed-00000 | 404 | ページが見つかりません。 |
ed-00001 | 500 | システムエラーが発生しました。 |
ed-00002 | 503 | サーバがメンテナンス中です。 |
ed-00003 | 400 | ストアアカウントが指定されていません。 |
ed-00004 | 400 | ストアアカウントが存在しません。 |
ed-00005 | 400 | ストアアカウントの指定が不正です。 |
ed-00006 | 400 | 反映またはアップロード中のため更新ができません。 |
エラーコード
コード | HTTPステータスコード | 説明 |
---|---|---|
pm-05001 | 400 | 未反映項目はありません。 |
pm-05002 | 400 | 反映処理中のため反映予約できません。 |
pm-05003 | 400 | 反映予約日時が不正です。 |
pm-05004 | 400 | 定義されていないmodeが指定されています。 |
pm-05005 | 400 | modeが指定されていません。 |
pm-05006 | 400 | 反映予約日は現在日から7日以内にしてください。 |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
利用約款
このAPIに関する利用約款はこちら。
目次
- 商品検索
- カテゴリランキング
- カテゴリID取得
- 商品コード検索(商品詳細)
- キーワードランキング
- おすすめ情報モジュール
- ポイントキャンペーン情報取得
- 販促イベント検索
- 商品レビュー検索
- 出品管理に関連するAPI
- 商品に関連するAPI
- 問い合わせ管理に関連するAPI
- 製品/SHPカテゴリ/ブランドに関連するAPI
- 在庫に関連するAPI
- ストアカテゴリに関連するAPI
- 画像に関連するAPI
- デザインに関連するAPI
- 注文に関するAPI
- ヘルプ