チェックイン

Authorizations

AppAccessToken
waiter.orders:write

Request Body

Checkin

チェックインモデル

object

storeId

required

店舗ID

string

tables

required

Array<object>

object

id

required

テーブルID

string

number

required

人数

integer

>= 1 <= 1000

customerGroups

Array<object>

nullable

object

id

required

客層ID

string

staffId

スタッフID

string

nullable

tableChargePerPerson

一人当たりのテーブルチャージ額
数値：指定の値を一人当たりのテーブルチャージ額に設定します。
null：店舗のテーブルチャージ額設定を利用します。
※ リクエストにプロパティがない場合、テーブルチャージ額は 0 となります。

string

nullable /^(0|[1-9][\d]{0,7})$/

serviceChargeRate

サービスチャージ率(%)
数値：指定の値をサービスチャージ率に設定します。
null：店舗のサービスチャージ率を利用します。
※ リクエストにプロパティがない場合、サービスチャージ率は 0 となります。

integer

nullable <= 100

Examples

{
  "storeId": "1",
  "tables": [
    {
      "id": "1"
    }
  ],
  "number": 2,
  "customerGroups": [
    {
      "id": "1"
    }
  ],
  "staffId": "10",
  "tableChargePerPerson": "500",
  "serviceChargeRate": 10
}

200

OK

object

id

required

テーブル利用ID（注文ヘッダーID）

string

storeId

店舗ID

string

tables

テーブル

Array<object>

object

id

テーブルID

string

nullable

name

テーブル名

string

number

人数

integer

status

ステータス

started: 利用中
ended: 利用終了
canceled: キャンセル済み
merged: 結合済み

string

Allowed values: started ended canceled merged

started

利用開始日時 (入店日時)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

ended

利用終了日時 (精算日時)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

customerGroups

客層

Array<object>

object

id

客層ID

string

name

客層名

string

quantity

合計注文点数

integer

tableChargePerPerson

一人当たりのテーブルチャージ額

string

serviceChargeRate

サービスチャージ率(%)

integer

totalPrice

合計金額（税込）

string

tempTransactionHeadId

仮販売ID（ウェイター管理画面 ver.2.23のリリース以降にチェックアウトされたテーブル利用のみ取得できます）

string

nullable

reservationId

予約ID（削除済みの予約IDもレスポンスに含みます）

string

nullable

Examples

{
  "id": "10001",
  "storeId": "1",
  "tables": [
    {
      "id": "1",
      "name": "T1"
    }
  ],
  "number": 2,
  "status": "started",
  "started": "2020-09-07T11:30:20+09:00",
  "ended": null,
  "customerGroups": [
    {
      "id": "1",
      "name": "女性"
    }
  ],
  "quantity": 0,
  "tableChargePerPerson": "0",
  "serviceChargeRate": 0,
  "totalPrice": "0",
  "tempTransactionHeadId": null,
  "reservationId": "123"
}

400

入力チェックエラーの場合
既にチェックイン済みのテーブルIDが指定された場合

object

title

required

string

type

required

string

status

integer

detail

string

404

指定したデータが存在しない場合

object

title

required

string

type

required

string

status

integer

detail

string

チェックイン

Authorizations

Request Body

Examples

Responses

200

Examples

400

404