予約一覧取得

GET

/reservations

• サンドボックス
• 本番

予約一覧を取得します。

対象プラン

• フードビジネスプラン

Authorizations

• AppAccessToken
  waiter.reservations:read

Parameters

Query Parameters

store_id

required

string

店舗ID

Example

1

status

string

default: all

Allowed values: all waiting coming finished paid canceled

予約ステータス

• all: 全て
• waiting: 来店待ち
• coming: ご来店
• finished: お食事済
• paid: お会計済
• canceled: キャンセル

Example

all

start_at

string format: date

予約開始日(RFC3339の日付形式)[YYYY-MM-DD]
予約開始日時が指定日の予約を取得します。

Example

2023-06-06

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

cursor

string

default: -1

取得する一覧の先頭にしたいデータの予約IDを指定してください。
ページネーション共通仕様

Example

-1

sort

string

default: start_at

ソート順

• start_at: 予約開始日時

Example

start_at

Responses

200

OK

Array<object>

Reservation

予約情報

object

id

required

予約ID

string

storeId

店舗ID

string

reservationCode

予約コード
外部システムから予約を識別するための文字列

string

startAt

予約開始日時(RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

endAt

予約終了日時(RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

persons

人数

object

adults

人数(大人)

integer

children

人数(子供)

integer

reservationPersonName

予約者名

string

reservationPersonNameKana

予約者名(カナ)

string

nullable

status

予約ステータス

• waiting: 来店待ち
• coming: ご来店
• finished: お食事済
• paid: お会計済
• canceled: キャンセル

string

Allowed values: waiting coming finished paid canceled

tables

テーブル情報

Array<object>

object

id

required

テーブルID

string

name

テーブル名

string

phoneNumber

電話番号

string

staff

受付スタッフ

object

id

required

受付スタッフID

string

name

受付スタッフ名

string

note

メモ

string

reservedAt

予約受付日時(RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string

reservedFrom

予約元

string

tableUseId

テーブル利用ID

string

nullable

Examples

[
  {
    "id": "1",
    "storeId": "1",
    "reservationCode": "101",
    "startAt": "2023-06-06T12:00:00+09:00",
    "endAt": "2023-06-06T14:00:00+09:00",
    "persons": {
      "adults": 2,
      "children": 1
    },
    "reservationPersonName": "山田",
    "reservationPersonNameKana": "ヤマダ",
    "status": "waiting",
    "tables": [
      {
        "id": "1",
        "name": "A1"
      }
    ],
    "phoneNumber": "00-0000-0000",
    "staff": {
      "id": "1",
      "name": "高橋"
    },
    "note": "",
    "reservedAt": "2023-06-05T17:02:39+09:00",
    "reservedFrom": "smaregi-pos",
    "tableUseId": "123"
  },
  {
    "id": "2",
    "storeId": "2",
    "reservationCode": "102",
    "startAt": "2023-06-06T16:00:00+09:00",
    "endAt": "2023-06-06T18:00:00+09:00",
    "persons": {
      "adults": 2,
      "children": 1
    },
    "reservationPersonName": "佐々木",
    "reservationPersonNameKana": "ササキ",
    "status": "coming",
    "tables": [
      {
        "id": "2",
        "name": "A2"
      }
    ],
    "phoneNumber": "00-0000-0000",
    "staff": {
      "id": "1",
      "name": "高橋"
    },
    "note": "",
    "reservedAt": "2023-06-06T11:03:41+09:00",
    "reservedFrom": "smaregi-waiter",
    "tableUseId": null
  }
]

Headers

Link

string

<次のURI>; rel="next"

400

Bad Request

• リクエストパラメーターが不正
  • 不正な値が指定された場合
  • 店舗IDが指定されていない場合

object

title

required

string

type

required

string

status

integer

detail

string

403

Forbidden

• 対象契約のプランで利用できない場合

object

title

required

string

type

required

string

status

integer

detail

string