注文 | スマレジ・プラットフォームAPI 仕様書

Authorizations

AppAccessToken
waiter.orders:write

Path Parameters

table_use_id

required

string

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

Request Body

NewOrder

新規注文APIのリクエストスキーマ

object

items

required

Array<object>

>= 1 items <= 100 items

NewOrderItem

新規注文アイテムモデル

object

menuId

required

メニューID

string

quantity

required

数量

integer

>= 1 <= 1000

menuType

注文時のメニュー取扱種別（項目がない場合、メニューマスタの種別が適用されます）

normal:単品
plan:プラン
inPlan:プラン内メニュー
course:コース

string

Allowed values: normal plan inPlan course

name

メニュー名

項目がない場合、メニューマスタの設定が適用されます
絵文字など、UTF-8で4バイトとして扱われる文字は使用できません

string

>= 1 characters <= 85 characters

customContentId

お好みオーダー内容ID

string

nullable

sellingPrice

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

required

クーポン割引率

string

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

toppings

メニューのトッピング

Array<object>

object

id

required

トッピングID

string

name

トッピング名

項目がない場合、メニューマスタの設定が適用されます
絵文字など、UTF-8で4バイトとして扱われる文字は使用できません

string

<= 255 characters

quantity

required

トッピング数量（紐づく親メニュー１つに対して必要な個数を設定してください）

integer

>= 1 <= 1000

sellingPrice

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

menuId

required

メニューID

string

extraAmount

追加料金（項目がない場合、コースマスタで設定された値が適用されます）

string

<= 999999

orderPrints

OrderPrints

印刷する伝票を指定できます。
印刷共通仕様

object

kitchenTicket

キッチン伝票（チビ伝票）を印刷するかどうかを指定できます

true: 印刷する
false: 印刷しない

boolean

orderSlip

注文伝票を印刷するかどうかを指定できます

true: 印刷する
false: 印刷しない

boolean

Examples

{
  "items": [
    {
      "menuId": "100",
      "quantity": 1,
      "menuType": "normal",
      "name": "焼き鳥",
      "sellingPrice": {
        "amount": "300",
        "tax": "included",
        "taxRate": 10,
        "taxType": "normal"
      },
      "discount": {
        "rate": "10"
      }
    }
  ],
  "orderPrints": {
    "kitchenTicket": true,
    "orderSlip": false
  }
}

{
  "items": [
    {
      "menuId": "100",
      "quantity": 2,
      "menuType": "normal",
      "name": "ラーメン",
      "sellingPrice": {
        "amount": "850",
        "tax": "included",
        "taxRate": 10,
        "taxType": "normal"
      },
      "toppings": [
        {
          "id": "101",
          "name": "味玉",
          "quantity": 1,
          "sellingPrice": {
            "amount": "100",
            "tax": "included",
            "taxRate": 10,
            "taxType": "normal"
          }
        },
        {
          "id": "102",
          "name": "チャーシュー",
          "quantity": 1,
          "sellingPrice": {
            "amount": "200",
            "tax": "included",
            "taxRate": 10,
            "taxType": "normal"
          }
        }
      ]
    }
  ],
  "orderPrints": {
    "kitchenTicket": true,
    "orderSlip": false
  }
}

{
  "items": [
    {
      "menuId": "200",
      "quantity": 1,
      "menuType": "course",
      "name": "おまかせコース",
      "sellingPrice": {
        "amount": "4500",
        "tax": "included",
        "taxRate": 10,
        "taxType": "normal"
      },
      "courseItems": [
        {
          "menuId": "201",
          "extraAmount": "500"
        },
        {
          "menuId": "202"
        },
        {
          "menuId": "203"
        }
      ]
    }
  ],
  "orderPrints": {
    "kitchenTicket": false,
    "orderSlip": true
  }
}

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"
      }
    ]
  }
}

400

入力チェックエラーの場合

object

title

required

string

type

required

string

status

integer

detail

string

404

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

object

title

required

string

type

required

string

status

integer

detail

string

注文

Authorizations

Parameters

Path Parameters

Request Body

Examples

Responses

200

Examples

400

404