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

注文明細更新

PATCH
/orders/{order_id}/items/{order_item_id}

注文明細を更新します。

数量の更新が同数の場合は、REQUEST BODY の orderPrints.kitchenTicket または orderPrints.orderSlip が true でも各伝票は印刷されません。

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
order_id
required
string

注文ID

order_item_id
required
string

注文明細ID

Request Body

Section titled “Request Body ”
One of:
Quantity

注文明細更新API（数量変更）のリクエストスキーマ

object
quantity
required

数量（現状の注文数以下の数量を設定してください）

integer
>= 1
orderPrints
OrderPrints

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

object
kitchenTicket

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

  • true: 印刷する
  • false: 印刷しない
boolean
orderSlip

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

  • true: 印刷する
  • false: 印刷しない
boolean
Examples
{
  "quantity": 2,
  "orderPrints": {
    "kitchenTicket": true,
    "orderSlip": false
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

GetOrderItem

注文アイテムモデル

object
id

注文明細ID (明細ID)

string
name

注文内容

string
status

ステータス

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

配膳日時 (RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]
ステータスを provided に変更した際の日時。

※ ウェイターサーバー ver.2.43.0 以前のプラットフォームAPIでチェックアウトしたデータは、チェックアウト時の日時が入っている場合があります。

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

クーポン割引率

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
servedAt

配膳日時 (RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]
ステータスを provided に変更した際の日時。

※ ウェイターサーバー ver.2.43.0 以前のプラットフォームAPIのチェックアウトでは、チェックアウト時の日時が入っている場合があります。

string format: date-time
nullable
Examples
{
  "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"
  },
  "toppings": [],
  "courseItems": []
}

400

Section titled “400 ”

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

object
title
required
string
type
required
string
status
integer
detail
string

404

Section titled “404 ”

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

object
title
required
string
type
required
string
status
integer
detail
string