店舗情報API(Store Information API)の使い方

API Store 店舗情報 OAuth

店舗の基本情報(店舗名・店舗種別・連絡先・住所)を REST API で取得・更新するためのガイドです。スタッフアプリなどのトークン認証クライアントから、店舗情報の編集画面を実装できます。

認証

店舗一覧の取得と同じ認証です。リクエストに Authorization: Bearer アクセストークン(user スコープのトークン)を付与し、対象のビジネスアカウントのメンバーである必要があります。追加のスコープは不要です。対象店舗がそのビジネスアカウント配下にない場合は 404 を返します。

店舗を1件取得する

編集画面の初期表示に使います。

GET /api/v1/me/organizations/{organizationId}/stores/{storeId}

レスポンス例(MeStore 形式。店舗一覧の各要素と同じ形です):

{
  "id": "store-id",
  "name": "渋谷店",
  "storeType": "Restaurant",
  "primaryCategory": "...",
  "status": "Active",
  "address": {
    "country": "JP",
    "prefecture": "東京都",
    "city": "渋谷区",
    "line1": "...",
    "line2": "...",
    "postalCode": "150-0001",
    "latitude": 35.6,
    "longitude": 139.7
  },
  "phone": "03-xxxx-xxxx",
  "websiteUrl": "https://...",
  "updatedAt": "2026-06-20T00:00:00Z"
}

店舗情報を更新する

PUT /api/v1/me/organizations/{organizationId}/stores/{storeId}

編集できる項目は、店舗名(name)・店舗種別(storeType)・主要カテゴリ(primaryCategory)・状態(status)・電話番号(phone)・ウェブサイト(websiteUrl)・住所(address の postalCode / prefecture / city / line1 / line2)です。

部分更新に対応しています。指定しなかった(null の)項目は変更されず、空文字を送るとその項目をクリアします。

リクエスト例:

{
  "name": "渋谷本店",
  "phone": "03-1234-5678",
  "websiteUrl": "https://example.com",
  "address": {
    "postalCode": "150-0002",
    "prefecture": "東京都",
    "city": "渋谷区",
    "line1": "渋谷1-2-3",
    "line2": "ビル4F"
  }
}

更新後の店舗情報(取得時と同じ MeStore 形式)が返ります。画面はこのレスポンスで再描画できます。

注意事項

  • 住所を更新しても、サーバー側でジオコーディング(緯度・経度の再取得)は行いません。country / latitude / longitude は保持されます。
  • 営業時間・定休日・就業可能時間はこのAPIの対象外です。営業時間API(Business Hours API)をご利用ください。
  • リクエスト本文に含めなかった項目(外部ID・POS連携情報など)はすべて保持されます。

関連ページ

公開日: 2026-06-20 更新日: 2026-06-20
このトピックについて
開発者API
機能の詳細を見る
タグ
API (22) OAuth (15) Android (10) iOS (9) Webhook (8) api (6) oauth (5) トラブル (5) POS連携 (4) getting-started (4)
関連記事