店鋪資訊 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-07-06
このトピックについて
開発者API
機能の詳細を見る
標籤
API (22) OAuth (15) Android (10) iOS (9) Webhook (8) api (7) oauth (5) POS串接 (4) getting-started (4) 參考 (4)
相關文章