ストアアプリ コンテンツAPI(お知らせ・ページ・営業情報)の使い方
API
ストアアプリ
お知らせ
ページ
営業情報
shopId
このガイドの目的
ストアアプリ(Web レンダラー・LINE ミニアプリ・iOS / Android アプリ)が表示するコンテンツ — お知らせ・ページ・アプリマニフェスト・営業情報・会員証設定 — を取得する /api/v1/apps/{shopId}/* の使い方をまとめます。
重要:
ストアアプリはビジネスアカウントごとに 1 つです。エンドポイントの
shopId はビジネスアカウント ID ですストアアプリはビジネスアカウントごとに 1 つです。エンドポイントの
{shopId} には、GET /api/v1/me/organizations が返す organizationId をそのまま渡してください。shopId とビジネスアカウント ID は同一の値で、店舗 ID(storeId)とは別物です。店舗 ID から shopId を解決する手順や専用フィールドは必要ありません。
エンドポイント一覧
| メソッド | パス | 用途 | スコープ範囲 |
|---|---|---|---|
| GET | /api/v1/apps/{shopId}/manifest | アプリの外観・テーマ・ナビ・各プラットフォーム ID | ビジネスアカウント単位 |
| GET | /api/v1/apps/{shopId}/posts | お知らせ(ニュース)一覧 | ビジネスアカウント単位 |
| GET | /api/v1/apps/{shopId}/pages | 公開ページ一覧 | ビジネスアカウント単位 |
| GET | /api/v1/apps/{shopId}/pages/{slug} | ページ詳細(slug 指定) | ビジネスアカウント単位 |
| GET | /api/v1/apps/{shopId}/business-info?storeId={storeId} | 営業時間・特別営業日・現在の営業状況 | 店舗単位 |
| GET | /api/v1/apps/{shopId}/membership-card-config | 会員証・ウォレット設定 | ビジネスアカウント単位 |
例:お知らせを取得する
{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 からの作成・更新エンドポイントはありません)。お知らせの編集はレシートローラーの管理画面から行います。将来、店舗スタッフがアプリからお知らせを投稿できるようにする場合は、書き込み用エンドポイントと専用スコープを別途追加します。
関連ガイド
- ビジネスアカウント・店舗・POS端末の一覧を取得する —
organizationId/storeIdの取得元 - 営業時間API(Business Hours API)の使い方
- 開発者ヘルプトップへ戻る
公開日: 2026-06-21
更新日: 2026-06-24
カテゴリ
タグ
API (22)
OAuth (15)
Android (10)
iOS (9)
Webhook (8)
api (6)
oauth (5)
トラブル (5)
POS連携 (4)
getting-started (4)
関連記事
-
店舗情報API(Store Information API)の使い方店舗の基本情報(店舗名・店舗種別・連絡先・住所)を取得・更新する REST API のガイドです。スタッフアプリなどのトークン認証クライアントから店舗情報の編集を実装できます。
-
営業時間API(Business Hours API)の使い方レシートローラーの営業時間API(/api/v1/stores/{storeId}/business-hours)のガイドです。曜日ごとの営業時間の取得・更新、特例営業日(臨時休業・営業時間変更)の登録、店舗の就業可能時間(シフト作成時の上限となる業務時間)の設定、現在営業中かどうかの判定までを解説します。
-
リクエストとレスポンスの基本(JSON)レシートローラーAPIのリクエスト形式、必須ヘッダー、レスポンス構造、ページネーション、フィルタリング、日時形式の規則を解説します。
-
ネイティブモバイルアプリ向けガイド: 複数ビジネスアカウントアクセスと OAuth フローAndroid / iOS のネイティブアプリ向け実装ガイド。アプリ登録時に「認可時に1つのビジネスアカウントへトークンを紐付ける」をオフにすると、user-scoped OAuth トークンが発行されます。/api/v1/me/organizations + ?organizationId= パターンで複数ビジネスアカウントを横断アクセスできます。
-
取引一覧API(Transactions API:POS+OMS統合フィード)の使い方レシートローラーのTransactions APIは、レジ売上(PosTransactions)と販売管理注文(OmsOrders)を1つのフィードに統合した読み取り専用APIです。Android/iOSアプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。