注文明細更新

PATCH

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

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/orders/example/items/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"quantity":2,"orderPrints":{"kitchenTicket":true,"orderSlip":false}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/orders/example/items/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "quantity": 2, "orderPrints": { "kitchenTicket": true, "orderSlip": false } }'

注文明細を更新します。

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

Authorizations

AppAccessToken
waiter.orders:write

Parameters

Path Parameters

order_id

required

string

注文ID

order_item_id

required

string

注文明細ID

Request Body

application/json

One of:

Quantity
Status

Quantity

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

object

quantity

required

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

integer

>= 1

orderPrints

OrderPrints

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

object

kitchenTicket

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

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

boolean

orderSlip

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

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

boolean

Status

object

status

required

ステータス

waiting:提供待ち (注文済)
provided:提供済み (配膳済)

string

Allowed values: waiting provided

Examples

{
  "quantity": 2,
  "orderPrints": {
    "kitchenTicket": true,
    "orderSlip": false
  }
}

{
  "status": "waiting"
}

Responses

200

application/json

GetOrderItem

注文アイテムモデル

object

注文明細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]*$/

timeLimit

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

integer

preTimeLimitMinutesLeft

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

integer

toppings

メニューのトッピング

Array<object>

object

注文明細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)

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

timeLimit

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

integer

preTimeLimitMinutesLeft

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

integer

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"
  },
  "timeLimit": 30,
  "preTimeLimitMinutesLeft": 10,
  "toppings": [],
  "courseItems": []
}

400

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

application/json

object

title

required

string

type

required

string

status

integer

detail

string

Example^generated

{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}

404

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

application/json

object

title

required

string

type

required

string

status

integer

detail

string

Example^generated

{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}

注文明細更新

Authorizations

Parameters

Path Parameters

Request Body

Examples

Responses

200

Examples

400

Examplegenerated

404

Examplegenerated

Example^generated

Example^generated