ショッピング
追加画像一括アップロードAPI
リクエストURL
XML
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadLibImagePack
こちらはテスト用APIもご利用いただけます。URLは以下の通りです。
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadLibImagePack
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
zipで圧縮した複数枚の追加画像を一括でアップロードします。（フロント反映はしません）
リクエストパラメータ
「RESTリクエストの構築（POST）」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| seller_id （必須） |
string | ストアアカウントを指定します。 GETパラメータで渡してください。 |
| file （必須） |
multipart/form-data | zipファイルを指定します。 1回にアップロード可能なデータ容量は25メガバイト以下です。 zipに含める画像ファイルはGIF/PNG/JPEG形式のみです。 画像一枚のサイズは、500キロバイト以下です。 |
| directory | string （デフォルト : パーツ） |
アップロードする画像を格納する追加画像ディレクトリ名を指定します。 指定しない場合、「パーツ」ディレクトリに格納されます。 |
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
・Yahoo! ID連携
・Yahoo! ID連携によるAPIアクセス実装方法
※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadLibImagePack?サンプルリクエスト
POST /ShoppingWebService/V1/uploadLibImagePack?Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
file=(sample1.zip)
レスポンスフィールド
| フィールド | 説明 |
|---|---|
| /ResultSet | クエリーレスポンスのすべてを含みます。 |
| /ResultSet/Result | 結果 |
| /ResultSet/Result/Status | NG : 失敗 OK : 成功 |
※個別エラーについて
| フィールド名 | 説明 |
|---|---|
| im-07101 | 画像サイズを500キロバイト以下に変更して下さい。 |
| im-07102 | ファイル名は255byte以内です。 |
| im-07103 | ファイル形式はgif/png/jpgのみです。 |
| im-07104 | 半角英数字、ハイフン（ - ）、アンダーバー（ _ ）、ピリオド（ . ）のみ使用できます。 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
<Result>
<Status>OK</Status>
</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 | ストアアカウントの指定が不正です。 |
| ed-00006 | 400 | 反映またはアップロード中のため更新ができません。 |
・エラーコード
| コード | HTTPステータスコード | 説明 |
|---|---|---|
| im-07001 | 400 | 1回にアップロード可能なデータ容量は25メガバイトまでです。 |
| im-07006 | 400 | fileは必須項目です。 |
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。（無料）
まずはヘルプページのお問い合わせフォームからご相談ください。
利用約款
このAPIに関する利用約款はこちら。
