店舗情報登録更新API

店舗在庫情報を登録・更新することができます。
※上書きをするので元の情報は削除されます。

変更履歴

リクエストURL

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

リクエストパラメータ

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

リクエストURL

パラメータ	必須	デフォルト値	値の例	説明	補足
/sellerId	〇		teststore	セラーID
/stores	〇			店舗情報の配列
/stores/shopCode	〇		ABC0001	店舗コード
/stores/branchName			汐留支店	支店名
/stores/zipCode	〇		105-7390	郵便番号
/stores/prefecture	〇		東京都	都道府県
/stores/city	〇		港区	市区町村
/stores/area			関東	地域
/stores/address1	〇		東新橋1-9-1	住所1
/stores/address2			東京汐留ビルディング 地下1階	住所2
/stores/phoneNumber	〇		03-9999-9999	電話番号
/stores/openTime			0930	営業開始時間
/stores/closeTime			2145	営業終了時間
/stores/regularHoliday			0:6	実店舗定期休業週	・定期休業曜日を「:」区切りで設定 ・0:日,1:月,2:火,3:水,4:木,5:金,6:土
/stores/holiday			20200101:0505#20210101:0505	実店舗休業日	年は「#」区切り 月日は「:」区切り
/stores/storeCode			shop01:shop02:shop03	ショップコード	ショップコードは「:」区切りで最大50件 ショップコードは20byte以内（半角英数のみ）
/stores/receiptDay			1	店頭受取可能日（在庫あり）
/stores/receiptHour			08	店頭受取可能時間（在庫あり）
/stores/receiptDayStockLittle			1	店頭受取可能日（在庫わずか）
/stores/receiptHourStockLittle			08	店頭受取可能時間（在庫わずか）
/stores/listUses			0:1:2	ファイル利用用途	0：店頭受取利用、1：店頭在庫利用、2：店頭在庫配送利用 nullのときは"0"がセットされます。

サンプルリクエストURL

curl -X POST "https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/setRealStore" -H  "Content-Type: application/json" -d
'{
  "sellerId": "teststore",
  "stores": [
    {
      "shopCode": "tokyo0001",
      "branchName": "新馬場駅前店",
      "zipCode": "140-0001",
      "prefecture": "東京都",
      "city": "品川区",
      "area": "関東",
      "address1": "大井9-9-56",
      "address2": "XXXビル 9F",
      "phoneNumber": "999-9999-9999  ",
      "openTime": "0800",
      "closeTime": "2000",
      "regularHoliday": "0:6",
      "holiday": "20200101:0505#20210101:0505",
      "storeCode": "shop01:shop02:shop03",
      "receiptDay": "1",
      "receiptHour": "08",
      "receiptDayStockLittle": "1",
      "receiptHourStockLittle": "08",
      "listUses": "0:1:2"
    },
    {
      "shopCode": "tokyo0002",
      "branchName": "汐留支店",
      "zipCode": "105-7390",
      "prefecture": "東京都",
      "city": "港区",
      "area": "関東",
      "address1": "東新橋1-9-1",
      "address2": "東京汐留ビルディング 地下1階",
      "phoneNumber": "03-9999-9999  ",
      "openTime": "0930",
      "closeTime": "2145",
      "regularHoliday": "4:5",
      "holiday": "20200101:0505#20210101:0505",
      "storeCode": "shop01:shop02:shop03",
      "receiptDay": "1",
      "receiptHour": "08",
      "receiptDayStockLittle": "1",
      "receiptHourStockLittle": "08",
      "listUses": "0:1:2"
    }
  ]
}
'

レスポンスフィールド

要素	型	値の例	説明
/status	string	ok	ステータス

サンプルレスポンス

レスポンス（JSON）

{
    "status": "ok"
}

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

• Yahoo! ショッピングAPI共通エラーコード一覧

店舗情報登録更新APIで固有に返すエラーは、以下のJSONレスポンスを返します。

要素	型
/type	string
/title	string
/detail	string
/status	integer

サンプルエラーレスポンス

{
    "type":"about:blank",
    "title":"Bad Request",
    "detail":"Failed to read HTTP message",
    "status":400
}

ご注意

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

• Yahoo! ID連携
• Yahoo! ID連携によるAPIアクセス実装方法

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

利用制限

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

利用約款

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