ショッピング

追加画像ディレクトリ登録API

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


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

追加画像用のディレクトリを追加します。
※追加するのみで、反映処理はしません。

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
directory
(必須)
string 追加する追加画像ディレクトリ名を指定します。

※追加画像ディレクトリ数は200件までです。

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

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


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/addLibDirecoty

サンプルリクエスト

POST /ShoppingWebService/V1/addLibDirecoty HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

seller_id=teststore&directory=%E6%9C%AC



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。
/ResultSet/Status OK : 成功



サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>OK</Status>
</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 ストアアカウントの指定が不正です。
ed-00006 400 反映またはアップロード中のため更新ができません。


・エラーコード

コード HTTPステータスコード 説明
im-10001 400 ディレクトリ名が重複しています。
im-10002 400 追加画像ディレクトリ数は200件までです。
im-10003 400 directoryは必須項目です。
im-10004 400 directoryは40バイト以内で入力してください。
im-10005 400 directoryの指定に不正があります。




利用制限

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

利用約款

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