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

注文取得

GET
/orders/{order_id}
curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/orders/example \
  --header 'Authorization: Bearer <token>'

注文を取得します

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
order_id
required
string

注文ID

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
orderId

注文ID

string
ordered

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

string format: string
items
required
Array<object>
OrderItem

注文レスポンス内の注文明細モデル

object
id

注文明細ID (明細ID)

string
name

注文内容

string
status

ステータス

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

配膳日時 (RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
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
required

クーポン割引率

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

値引金額

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

制限時間設定（分）。0 の場合は制限時間通知の対象外となります。

integer
preTimeLimitMinutesLeft

制限時間事前通知設定（分）。0 の場合は事前通知の対象外となります。

integer
toppings

メニューのトッピング

Array<object>
object
id

注文明細ID (明細ID)

string
toppingId

トッピングID

string
name

トッピング名

string
quantity

親注文明細 1 件あたりのトッピング数量です。トッピング実個数を親注文明細の数量で除算した値です。

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

コース内明細の実数量です。プラットフォームAPI 経由の注文では親注文明細の数量に連動して設定されますが、プラットフォームAPI 以外の経路で登録された注文では連動しない場合があるため、親注文明細の数量と常に一致するとは限りません。

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

ステータス

string
Allowed values: waiting provided canceled
servedAt

配膳日時 (RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
timeLimit

制限時間設定（分）。0 の場合は制限時間通知の対象外となります。

integer
preTimeLimitMinutesLeft

制限時間事前通知設定（分）。0 の場合は事前通知の対象外となります。

integer
submenuItems

【submenuItems は waiter-server ver.2.46.0 (2026年10月上旬リリース予定) で追加予定】

注文明細に紐づくサブメニュー明細です。
waiter-server ver.2.46.0以降は、サブメニュー明細の有無にかかわらず常に返却されます。
サブメニュー明細が存在しない場合は空配列を返却します。
waiter-server ver.2.45.x以前は、このプロパティは返却されません。

Array
OrderSubmenuItem

【waiter-server ver.2.46.0 (2026年10月上旬リリース予定) で追加予定】

サブメニュー明細（子階層）

object
id

注文明細ID (明細ID)

string
menuId

メニューID

string
name

メニュー名

string
quantity

サブメニュー明細の実数量です。
当該サブメニュー明細自身の数量を示します。
直近の親要素（1階層上の明細）の数量変更に伴う増減は isQuantitySyncedWithParent の値に従います。

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
servedAt

配膳日時 (RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
timeLimit

制限時間設定（分）。0 の場合は制限時間通知の対象外となります。

integer
preTimeLimitMinutesLeft

制限時間事前通知設定（分）。0 の場合は事前通知の対象外となります。

integer
isQuantitySyncedWithParent
required

直近の親要素（1階層上の明細）の数量変更時に、このサブメニュー明細の数量を連動更新するかを示します。

  • true: 直近の親要素の数量に応じて本明細の数量も増減します。
  • false: 直近の親要素の数量が変わっても本明細の数量は自動変更されません。
boolean
submenuItems
required

サブメニュー明細の子要素（孫階層）です。
孫階層の明細が存在しない場合は空配列を返却します。

Array
OrderSubmenuItemNested

【waiter-server ver.2.46.0 (2026年10月上旬リリース予定) で追加予定】

サブメニュー明細（孫階層）。
孫階層の明細には submenuItems は返却されません。

object
id

注文明細ID (明細ID)

string
menuId

メニューID

string
name

メニュー名

string
quantity

サブメニュー明細の実数量です。
当該サブメニュー明細自身の数量を示します。
直近の親要素（1階層上の明細）の数量変更に伴う増減は isQuantitySyncedWithParent の値に従います。

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
servedAt

配膳日時 (RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]

string format: date-time
nullable
timeLimit

制限時間設定（分）。0 の場合は制限時間通知の対象外となります。

integer
preTimeLimitMinutesLeft

制限時間事前通知設定（分）。0 の場合は事前通知の対象外となります。

integer
isQuantitySyncedWithParent
required

直近の親要素（1階層上の明細）の数量変更時に、このサブメニュー明細の数量を連動更新するかを示します。

  • true: 直近の親要素の数量に応じて本明細の数量も増減します。
  • false: 直近の親要素の数量が変わっても本明細の数量は自動変更されません。
boolean
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",
      "servedAt": null,
      "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"
      },
      "timeLimit": 30,
      "preTimeLimitMinutesLeft": 10,
      "toppings": [],
      "courseItems": []
    }
  ],
  "tableUseId": "10009",
  "tableUse": {
    "id": "10009",
    "status": "started",
    "storeId": "1",
    "tables": [
      {
        "id": "8",
        "name": "T2"
      },
      {
        "id": "9",
        "name": "T3"
      }
    ]
  }
}