商店應用程式 內容 API（公告、頁面、營業資訊）的使用方式

本指南的目的

本文彙整用於取得商店應用程式（Web 落地頁、LINE 迷你應用程式、iOS / Android 應用程式）所顯示的內容 — 公告、頁面、應用程式資訊清單、營業資訊、會員卡設定 — 的 /api/v1/apps/{shopId}/* 使用方式。

端點一覽

範例：取得公告

{shopId} 請傳入商業帳戶 ID。

GET /api/v1/apps/{organizationId}/posts?status=Published&take=20

公告、頁面、資訊清單皆為商業帳戶層級。無論選擇同一商業帳戶底下的哪一間店鋪，都會回傳相同的內容（不會依店鋪區分）。

範例：取得營業資訊（店鋪層級）

只有營業時間會因店鋪而異，因此必須以查詢參數傳入 storeId。

GET /api/v1/apps/{organizationId}/business-info?storeId={storeId}&specialDaysAhead=30

storeId 是 GET /api/v1/me/organizations/{organizationId}/stores 所回傳的店鋪 ID。

關於 store → shopId 的對應

應用程式以「選擇商業帳戶 → 選擇店鋪」的流程運作，已同時保有 organizationId 與 storeId。傳入內容 API 時，請依下列方式處理。

• 公告、頁面、資訊清單、會員卡設定 → {shopId} 傳入 organizationId（不需指定店鋪）
• 營業資訊 → {shopId} 傳入 organizationId，並在 storeId 查詢參數傳入店鋪 ID

驗證

內容的讀取端點為公開（因為內容本身即為公開資訊），不需要 OAuth 權杖。只要在應用程式內已得知商業帳戶 ID，即可直接呼叫。

關於公告的建立

目前 posts 為唯讀（沒有從 API 建立、更新的端點）。公告的編輯請從 ReceiptRoller 的管理畫面進行。未來若要讓店鋪員工能從應用程式張貼公告，會另行新增寫入用的端點與專用權限範圍。

相關指南

• 取得商業帳戶、店鋪、POS 端末的一覽 — organizationId / storeId 的取得來源
• 營業時間 API（Business Hours API）的使用方式
• 返回開發者幫助中心