ショッピング
追加画像ディレクトリ登録API
追加画像用のディレクトリを追加します。
※ フロント反映はしません。別途反映処理が必要です。
リクエストURL
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/addLibDirectory
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/addLibDirectory
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「RESTリクエストの構築（POST）」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| seller_id （必須） |
string | ストアアカウントを指定します。 |
| directory （必須） |
string |
追加する追加画像ディレクトリ名を指定します。 ■ ご注意ください フォルダ名に制御文字を使用しないようお願いします。 （エラーでは返しませんが、正常に動作しない可能性があります。） |
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/addLibDirecotyサンプルリクエスト
POST /ShoppingWebService/V1/addLibDirecoty HTTP/1.1Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
seller_id=teststore
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| /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の指定に不正があります。 |
| im-10006 | 400 | タグ(<>)は使用できません。 |
| im-10007 | 400 | 半角バックスラッシュ(\)は使用できません。 |
| im-10008 | 400 | 機種依存文字は使用できません。 |
| im-10009 | 400 | ディレクトリの追加に失敗しました。 |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。（無料）
まずはヘルプページのお問い合わせフォームからご相談ください。
利用約款
このAPIに関する利用約款はこちら。
