店舗の営業状況取得

GET

/dashboard/stores/{store_id}

• サンドボックス
• 本番

店舗の営業状況を取得します

Authorizations

• AppAccessToken
  waiter.stores:read

Parameters

Path Parameters

store_id

required

string

店舗ID

Example

1

Query Parameters

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

sort

string

default: sort_no

ソート順

• sort_no: ソート番号
• category: テーブルカテゴリー名

Example

sort_no

page

integer

default: 1 >= 1

ページ番号

Example

1

Responses

200

OK

object

time

現在日時[YYYY-MM-DDThh:mm:ssTZD]

string

count

レスポンスに含むテーブル数

integer

0

total

全テーブル数

integer

0

page

現在のページ番号

integer

tables

店舗テーブルリスト

Array

object

table

Table

テーブル情報

object

id

required

テーブルID

string

name

テーブル名

string

category

テーブルカテゴリー

string

sortNo

テーブル全体での並び順

integer

tableUse

テーブル利用（テーブルが稼働中の場合のみ取得できます）

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

{
  "time": "2020-09-01T08:30:00+09:00",
  "count": 3,
  "total": 10,
  "page": 1,
  "tables": [
    {
      "table": {
        "id": "1",
        "name": "A1",
        "category": "1F",
        "sortNo": 1
      },
      "tableUse": {
        "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": 2,
        "tableChargePerPerson": "0",
        "serviceChargeRate": 0,
        "totalPrice": "1252",
        "tempTransactionHeadId": null,
        "reservationId": "123"
      }
    },
    {
      "table": {
        "id": "2",
        "name": "A2",
        "category": "1F",
        "sortNo": 2
      },
      "tableUse": null
    },
    {
      "table": {
        "id": "3",
        "name": "A3",
        "category": "1F",
        "sortNo": 3
      },
      "tableUse": null
    }
  ]
}

Headers

Link

string

<前のURI>; rel="prev", <次のURI>; rel="next"

403

店舗が休止中の場合

object

title

required

string

type

required

string

status

integer

detail

string

404

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

object

title

required

string

type

required

string

status

integer

detail

string