ショッピング

商品アップロードAPI

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


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

商品のCSVアップロードを行います。(フロント反映はしません)

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
GETパラメータで渡してください。
file
(必須)
multipart/form-data CSVファイルを指定します。
ファイルフォーマットはこちら
type
(必須)
integer アップロードタイプを指定します。
1: 追加
2: 上書き
3: 削除
4: 項目指定

※アップロードタイプについて
・【追加】
  ストア内に登録されている既存の商品に、アップロードした商品が追加されます。
 なお、現在ストアに登録されている商品のデータがある場合は、更新情報が上書きされます。
 フィールドを削除してデータをアップロードしますと、削除したフィールド部分のデータは削除されますので、
 登録されている商品データの一部項目のみを更新する場合は、項目指定アップロードをお使いください。
・【上書き】
 現在ストア内に登録されている商品の情報はすべて削除され、アップロードされた商品データのみに入れ替わります。
 万が一のために、上書き操作を行う前にバックアップデータを残しておくことを推奨します。
・【削除】
 アップロードするデータベースファイルに含まれる商品データをストア内から削除します。
 ※商品を削除すると、「画像管理」の商品画像フォルダ内にある商品画像、商品詳細画像も削除されます。
・【項目指定】
 アップロードするデータベースファイルに含まれる商品データの、指定したフィールドのみ、データの変更を行います。

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

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


サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadItemFile?seller_id=teststore

サンプルリクエスト

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

type=1&file=***(ファイルを指定)



レスポンスフィールド

フィールド 説明
/ResultSet クエリーレスポンスのすべてを含みます。
/ResultSet/Result 各個別レスポンスを含みます。
/ResultSet/Result/Status 更新結果(このフォーマットではOKのみです。)



サンプルレスポンス

<?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ステータスコード 説明
it-09001 400 typeが指定されていません。
it-09002 400 fileが指定されていません。
it-09003 400 定義されていないアップロードタイプが指定されています。




利用制限

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

利用約款

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