営業時間API(Business Hours API)の使い方
API
OAuth
営業時間
Business Hours
特例営業日
就業可能時間
シフト
Android
iOS
このガイドについて
レシートローラーの営業時間API(
レシートローラーの営業時間API(
/api/v1/stores/{storeId}/business-hours)の使い方をまとめています。曜日ごとの営業時間、特例営業日(臨時休業・営業時間変更)、シフト作成の上限となる就業可能時間を、モバイルアプリや外部システムから取得・更新できます。営業時間API(Business Hours API)の使い方
必要なスコープ
| スコープ | 付与される権限 |
|---|---|
store.business-hours.read | 営業時間・特例営業日・就業可能時間・営業中判定の参照 |
store.business-hours.write | 営業時間・特例営業日・就業可能時間の更新 |
アプリ編集画面の「APIスコープ」でチェックを入れたうえで、認可URLの scope パラメータに含めてください。
認証
他のv1 APIと同じトークン規約です。
- ビジネスアカウントに紐付いたトークン — そのまま呼び出せます
- ユーザースコープのトークン(ネイティブモバイルアプリ向け) — クエリに
?organizationId=を付与してください
エンドポイント一覧
| メソッド | パス | 内容 |
|---|---|---|
| GET | /api/v1/stores/{storeId}/business-hours | 曜日ごとの営業時間の取得 |
| PUT | /api/v1/stores/{storeId}/business-hours | 営業時間の一括更新 |
| PUT | /api/v1/stores/{storeId}/business-hours/{dayOfWeek}/{shiftIndex} | 特定曜日・時間帯の更新 |
| DELETE | /api/v1/stores/{storeId}/business-hours/{dayOfWeek}/{shiftIndex} | 特定曜日・時間帯の削除 |
| GET | /api/v1/stores/{storeId}/business-hours/special-days | 特例営業日(臨時休業・営業時間変更)の一覧 |
| PUT | /api/v1/stores/{storeId}/business-hours/special-days/{date} | 特例営業日の登録・更新 |
| DELETE | /api/v1/stores/{storeId}/business-hours/special-days/{date} | 特例営業日の削除 |
| GET | /api/v1/stores/{storeId}/business-hours/work-hours-limit | 就業可能時間(シフト作成の上限となる業務時間)の取得 |
| PUT | /api/v1/stores/{storeId}/business-hours/work-hours-limit | 就業可能時間の更新 |
| GET | /api/v1/stores/{storeId}/business-hours/open-status | 現在営業中かどうかの判定 |
営業時間と就業可能時間の違い
- 営業時間 — お客様向けに公開する開店・閉店時間。曜日ごとに複数の時間帯(昼営業・夜営業など)を登録できます
- 就業可能時間 — シフトを作成できる時間の上限となる業務時間。開店前の仕込みや閉店後の片付けを含めた範囲を設定します
シフト管理機能やシフト作成APIは、就業可能時間の範囲内でのみシフトを登録できます。
就業可能時間の設定
PUT /api/v1/stores/{storeId}/business-hours/work-hours-limit
Authorization: Bearer {token}
Content-Type: application/json
{
"standardWorkStartTime": "08:00",
"standardWorkEndTime": "23:00"
}
時刻は HH:mm 形式で指定し、開始は終了より前である必要があります。両方を空文字にすると制限なし(24時間シフト登録可)になります。
特例営業日の登録
PUT /api/v1/stores/{storeId}/business-hours/special-days/2026-08-13
Authorization: Bearer {token}
Content-Type: application/json
{
"isClosed": true,
"note": "夏季休業"
}
臨時休業のほか、特定日だけ営業時間を変更する登録もできます。open-status の判定は特例営業日を優先して評価します。
関連ガイド
公開日: 2026-06-10
更新日: 2026-06-10
カテゴリ
タグ
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 のガイドです。スタッフアプリなどのトークン認証クライアントから店舗情報の編集を実装できます。
-
リクエストとレスポンスの基本(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アプリで「ビジネスアカウント全体の取引」を一覧表示する際の入り口になります。
-
商品管理API(Products API)の使い方レシートローラーの商品管理API(/api/v1/products)でビジネスアカウント配下の商品をCRUD操作するためのガイドです。Android/iOSアプリやサーバー連携でPIM(商品マスター)を読み書きする際の入門記事です。