在庫アップロードAPI

在庫のCSVアップロードを行います。

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

リクエストURL

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

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

リクエストパラメータ

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

パラメータ 説明
seller_id
(必須)
string ストアアカウントを指定します。
GETパラメータで渡してください。
file
(必須)
multipart/form-data CSVファイルを指定します。
ファイルフォーマットはこちら

サンプルリクエストURL

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

サンプルリクエスト

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

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

サンプルコード(PHP)

<?php

  $header = [
      'Content-Type: multipart/form-data',
      'POST /ShoppingWebService/V1/uploadStockFile?seller_id=<ストアアカウント> HTTP/1.1',
      'Host: circus.shopping.yahooapis.jp',
      'Authorization: Bearer ' . <アクセストークン>
  ];

  $url   = 'https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/uploadStockFile?seller_id=<ストアアカウント>';
  $param = array('file' => new CURLFile('<在庫csvのパス>'));

  // 必要に応じてオプションを追加してください。
  $ch = curl_init();
  curl_setopt($ch, CURLOPT_CUSTOMREQUEST,  'POST');
  curl_setopt($ch, CURLOPT_HTTPHEADER,     $header);
  curl_setopt($ch, CURLOPT_URL,            $url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST,           true);
  curl_setopt($ch, CURLOPT_POSTFIELDS,     $param);

  $response = curl_exec($curl);
  curl_close($curl);

?>

レスポンスフィールド

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

サンプルレスポンス

<?xml version="1.0" encoding="UTF-8" ?>
<ResultSet>
    <Status>OK</Status>
</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ステータスコード 説明
st-03001 400 CSVファイルが指定されていません。
st-03002 400 CSVファイルの指定が不正です。

利用制限

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

利用約款

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

アプリケーションの管理

目次

利用のルール

開発のヒント