商品アップロードAPI

商品のCSVアップロードを行います。(フロント反映はしません)
※ フロント反映はしません。別途反映処理が必要です。

変更履歴

2019年09月12日

下記2つの項目を追加しました。

  • supplier-type(販売ルート)
  • y-shopping-display-flag(Yahoo!ショッピング検索に表示する商品フラグ)

※PayPayモール出店者様限定


2019年08月13日

下記項目を追加しました。

  • taxrate-type(軽減税率コード)

リリース日:2019年08月01日(木)

2019年08月07日

下記項目を追加します。

  • is-drug(第1類医薬品)

リリース日:2019年08月08日(木)

※ファイルフォーマットの詳細はこちらをご確認ください。

サンプルコード(PHP版)をご用意しています。こちらのページをご確認ください。

ファイルフォーマット

ファイルフォーマットについては、以下のページをご確認ください。

アップロードフォーマット

プログラム中のファイルの指定方法についてはサンプルコードをご参照ください。

サンプルコード(商品アップロードAPI)

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadItemFile
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadItemFile

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

Web APIの使い方#POSTとは」をご参照ください。

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

※アップロードタイプについて

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

サンプルリクエスト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>

エラー

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

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント