テーブル利用履歴一覧取得

GET

/table_uses

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/table_uses?store_id=1&status=all&started=2024-06-01&ended=2024-06-01&sort=started%3Adesc&limit=50&cursor=-1' \
  --header 'Authorization: Bearer <token>'

• サンドボックス
• 本番

テーブル利用履歴の一覧を取得します

Authorizations

• AppAccessToken
  waiter.orders:history

Parameters

Query Parameters

store_id

string

店舗ID

Example

1

status

string

default: started

Allowed values: all started ended canceled merged

ステータス

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

Example

all

started

string format: date

利用開始日(RFC3339の日付形式)[YYYY-MM-DD]

Example

2024-06-01

ended

string format: date

利用終了日(RFC3339の日付形式)[YYYY-MM-DD]

Example

2024-06-01

sort

string

default: started:desc

ソート順

• started: 利用開始日時

Example

started:desc

limit

integer

default: 50 >= 1 <= 100

取得件数

Example

50

cursor

string

default: -1

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

Example

-1

Responses

200

OK

Media typeapplication/json

Array<object>

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

uuid

テーブル利用UUID

テーブル利用作成時に付与される値です。
この項目は空の結果を返す場合があります。
テーブル利用IDと組み合わせて、テーブル利用の正当性を検証するために利用できます。
（例: 取引QRコードのURLに テーブル利用ID と uuid の両方を含めた場合など）

string

0 <= 36 characters

Examples

Exampleレスポンス例

[
  {
    "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",
    "uuid": "68F6B1E9-99AD-4803-AB0D-D85AD5DB11F3"
  },
  {
    "id": "10002",
    "storeId": "1",
    "tables": [
      {
        "id": "2",
        "name": "T2"
      }
    ],
    "number": 3,
    "status": "started",
    "started": "2020-09-07T11:45:20+09:00",
    "ended": null,
    "customerGroups": [
      {
        "id": "1",
        "name": "女性"
      }
    ],
    "quantity": 3,
    "tableChargePerPerson": "0",
    "serviceChargeRate": 0,
    "totalPrice": "1700",
    "tempTransactionHeadId": null,
    "reservationId": null,
    "uuid": "87416234-BA06-4B0E-9D82-3D40A68FFE0D"
  }
]

Headers

Link

string

<次のURI>; rel="next"