コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

テーブル利用履歴取得

GET
/table_uses/{table_use_id}

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
table_use_id
required
string

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

Responses

Section titled “ Responses ”

200

Section titled “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
orders
Array<object>
GetOrder

注文モデル

object
orderId

注文ID

string
ordered

注文日時[YYYY-MM-DDThh:mm:ssTZD]

string format: string
items
required
Array<object>
GetOrderItem

注文アイテムモデル

object
id

注文明細ID (明細ID)

string
name

注文内容

string
status

ステータス

  • waiting: 提供待ち (注文済)
  • provided: 提供済み (配膳済)
  • canceled: キャンセル済み
string
Allowed values: waiting provided canceled
memo

メモ

string
menuId

メニューID

string
quantity

数量

integer
>= 1
menuType

注文時のメニュー取扱種別

  • normal:単品
  • plan:プラン
  • inPlan:プラン内メニュー
  • course:コース
string
Allowed values: normal plan inPlan course
customContentId

お好みオーダー内容ID

string
nullable
customContentName

お好みオーダー内容

string
categoryId

カテゴリーID

string
sellingPrice
NewOrderItemPrice

販売価格

object
taxRate
required

税率の割合(税率10％の場合、10 。非課税のメニューの場合、指定がなければ標準の税率になります。)

number
<= 100
taxType
required

税種別

  • normal:標準
  • reduced:軽減
  • none:非課税
string
Allowed values: normal reduced none
amount
required

金額

string
<= 999999
tax
required

金額の税情報

  • included: 税込
  • excluded: 税抜
  • none: 非課税
string
Allowed values: included excluded none
discount
One of:
RateCoupon

注文メニューの値引、割引設定

object
rateCoupon

クーポン割引率

string
/^([1-9][\d]?|100)$/
amount

値引金額

string
/^[1-9][\d]*$/
toppings

メニューのトッピング

Array<object>
object
id

注文明細ID (明細ID)

string
toppingId

トッピングID

string
name

トッピング名

string
quantity
integer
>= 1
categoryId

カテゴリーID

string
sellingPrice
NewOrderItemPrice

販売価格

object
taxRate
required

税率の割合(税率10％の場合、10 。非課税のメニューの場合、指定がなければ標準の税率になります。)

number
<= 100
taxType
required

税種別

  • normal:標準
  • reduced:軽減
  • none:非課税
string
Allowed values: normal reduced none
amount
required

金額

string
<= 999999
tax
required

金額の税情報

  • included: 税込
  • excluded: 税抜
  • none: 非課税
string
Allowed values: included excluded none
courseItems

コース内容

Array<object>
object
id

注文明細ID (明細ID)

string
menuId

メニューID

string
name

メニュー名

string
quantity
integer
>= 1
categoryId

カテゴリーID

string
sellingPrice
NewOrderItemPrice

追加料金

object
taxRate
required

税率の割合(税率10％の場合、10 。非課税のメニューの場合、指定がなければ標準の税率になります。)

number
<= 100
taxType
required

税種別

  • normal:標準
  • reduced:軽減
  • none:非課税
string
Allowed values: normal reduced none
amount
required

金額

string
<= 999999
tax
required

金額の税情報

  • included: 税込
  • excluded: 税抜
  • none: 非課税
string
Allowed values: included excluded none
status

ステータス

  • waiting: 提供待ち (注文済)
  • provided: 提供済み (配膳済)
  • canceled: キャンセル済み
string
Allowed values: waiting provided canceled
tableUseId

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

string
nullable
Examples
{
  "id": "10001",
  "tables": [
    {
      "id": "1",
      "name": "T1"
    }
  ],
  "number": 2,
  "customerGroups": [
    {
      "id": "1",
      "name": "女性"
    }
  ],
  "status": "ended",
  "started": "2020-09-07T11:30:20+09:00",
  "ended": "2020-09-07T12:30:20+09:00",
  "storeId": "1",
  "quantity": 3,
  "tableChargePerPerson": "0",
  "serviceChargeRate": 0,
  "totalPrice": "1252",
  "tempTransactionHeadId": "1234",
  "reservationId": "123",
  "orders": [
    {
      "orderId": "01ED3EV928A078J0TZAJQR69CK",
      "ordered": "2020-09-07T11:35:02+09:00",
      "items": [
        {
          "id": "50001",
          "name": "サラダ",
          "status": "provided",
          "memo": "トマト抜き",
          "menuId": "124",
          "quantity": 2,
          "menuType": "normal",
          "customContentId": "12",
          "customContentName": "小盛り",
          "categoryId": "158",
          "sellingPrice": {
            "taxRate": 10,
            "taxType": "normal",
            "amount": "690",
            "tax": "included"
          },
          "discount": {
            "rateCoupon": "10",
            "amount": "69"
          },
          "toppings": [
            {
              "id": "50002",
              "toppingId": "13",
              "name": "ドレッシング",
              "quantity": 1,
              "categoryId": "112",
              "sellingPrice": {
                "taxRate": 10,
                "taxType": "normal",
                "amount": "10",
                "tax": "included"
              }
            }
          ],
          "courseItems": []
        }
      ],
      "tableUseId": "10001"
    }
  ]
}