注文取得

Authorizations

AppAccessToken
waiter.orders:read

Path Parameters

order_id

required

string

注文ID

200

OK

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

tableUse

object

id

required

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

string

storeId

店舗ID

string

tables

テーブル

Array<object>

object

id

テーブルID

string

nullable

name

テーブル名

string

status

ステータス

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

string

Allowed values: started ended canceled merged

Examples

{
  "orderId": "01ED3EV928A078J0TZAJQR69CK",
  "ordered": "2020-09-07T11:35:02+09:00",
  "items": [
    {
      "id": "50001",
      "name": "コーヒー",
      "status": "waiting",
      "memo": "",
      "menuId": "124",
      "quantity": 2,
      "menuType": "normal",
      "customContentId": "8",
      "customContentName": "微糖",
      "categoryId": "156",
      "sellingPrice": {
        "taxRate": 10,
        "taxType": "normal",
        "amount": "330",
        "tax": "included"
      },
      "discount": {
        "rateCoupon": "10",
        "amount": "33"
      },
      "toppings": [],
      "courseItems": []
    }
  ],
  "tableUseId": "10009",
  "tableUse": {
    "id": "10009",
    "status": "started",
    "storeId": "1",
    "tables": [
      {
        "id": "8",
        "name": "T2"
      },
      {
        "id": "9",
        "name": "T3"
      }
    ]
  }
}

Authorizations

Parameters

Path Parameters

Responses

200

Examples