キッチン伝票印刷

POST

/store_print/{store_id}/kitchen_ticket

サンドボックス
本番

キッチン伝票の印刷を実行します。
※ 印刷対象のメニューIDに応じて、印刷を行うプリンターが自動的に決定されます
※ メニューの印刷対象伝票のキッチン伝票がオンの場合は印刷されます

印刷するプリンターは以下の優先順で決まります（いずれも指定の店舗の設定）：

メニューの取扱店舗設定でプリンターの設定がある場合、そのプリンターが使用されます。
メニューの取扱店舗設定でプリンターの設定がない場合は、メニューが属するカテゴリーのプリンター設定が使用されます。
上記いずれにも該当しない場合は、印刷は行われません。

Authorizations

AppAccessToken
waiter.stores:print

Parameters

Path Parameters

store_id

required

string

店舗ID

Request Body

NewKitchenTicket

新規キッチン伝票印刷APIのリクエストスキーマ

object

appName

required

アプリ名
伝票に印字するアプリ名を指定してください。

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
不可視文字のみの登録はできません

string

>= 1 characters <= 85 characters

slipType

required

伝票種別

newOrder: 新規注文
addOrder: 追加注文
changeQuantity: 数量変更
cancelOrder: 注文キャンセル

選択した伝票種別に応じた伝票名が印字されます。
※ 注文キャンセルを指定した場合、印字の際に明細の数量の背景色が反転します

string

Allowed values: newOrder addOrder changeQuantity cancelOrder

newOrder

headerTitle

ヘッダータイトル

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 85 characters

headerContents

ヘッダー内容

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 1000 characters

items

required

明細
印字時に、ウェイターの店舗に設定したアプリ設定が適用されます。

Array<object>

>= 1 items <= 100 items

KitchenTicketItem

キッチン伝票明細情報

object

menuId

required

メニューID

メニューIDを元に印刷を行うプリンターが特定されます
name が未指定または null の場合、menuId に対応するメニュー情報を参照し、name を補完します
name が指定されている場合、menuId は補完には使用されません

string

name

メニュー名

name が未指定または null の場合は、menuId に基づいてメニューのキッチン伝票印字名を補完します。キッチン伝票印字名が未設定の場合は、メニュー名で補完されます
意図的に別名で印刷したい場合は、必ず指定してください
絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
不可視文字のみの登録はできません

string

nullable >= 1 characters <= 85 characters

quantity

required

数量

integer

>= 1 <= 9999

orderDetailNo

注文明細番号

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 20 characters

9860-0000

note

メモ

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 1000 characters

courseItems

コース内容

Array<object>

nullable >= 1 items <= 10 items

object

menuId

required

メニューID

メニューIDを元に印刷を行うプリンターが特定されます
name が未指定または null の場合、menuId に対応するメニュー情報を参照し、name を補完します
name が指定されている場合、menuId は補完には使用されません

string

name

メニュー名

name が未指定または null の場合は、menuId に基づいてメニューのキッチン伝票印字名を補完します。キッチン伝票印字名が未設定の場合は、メニュー名で補完されます
意図的に別名で印刷したい場合は、必ず指定してください
絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
不可視文字のみの登録はできません

string

nullable >= 1 characters <= 85 characters

quantity

required

数量

integer

>= 1 <= 9999

note

メモ

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 1000 characters

toppings

トッピング

※ 要素では toppingId 、name のいずれかが必須です

Array<object>

nullable >= 1 items <= 10 items

object

toppingId

トッピングID

name が未指定または null の場合、toppingId に対応するトッピング情報を参照し、name を補完します
name が指定されている場合、toppingId は補完には使用されません

string

nullable

name

メニュー名（トッピング名)

name が未指定または null の場合は、toppingId に基づいてトッピングのキッチン伝票印字名を補完します。キッチン伝票印字名が未設定の場合は、トッピング名（メニュー名）で補完されます
意図的に別名で印刷したい場合は、必ず指定してください
絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
不可視文字のみの登録はできません

string

nullable >= 1 characters <= 85 characters

quantity

required

数量

integer

>= 1 <= 9999

customOrderContents

お好みオーダー内容

Array<object>

nullable >= 1 items <= 10 items

object

name

required

お好みオーダー名

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
不可視文字のみの登録はできません

string

>= 1 characters <= 85 characters

footerTitle

フッタータイトル

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 85 characters

footerContents

フッター内容

絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
null を指定した場合は項目が印字されません

string

nullable >= 1 characters <= 1000 characters

Examples

{
  "appName": "サンプルプラットフォームアプリ名",
  "slipType": "newOrder",
  "headerTitle": "引換券番号\nX00001898",
  "headerContents": "お渡しまでの時間 19分\n注文時間 2025/06/09 12:30",
  "items": [
    {
      "menuId": "13",
      "name": "ラーメン",
      "quantity": 2,
      "orderDetailNo": "9860-000043",
      "note": null,
      "courseItems": null,
      "toppings": null,
      "customOrderContents": null
    }
  ],
  "footerTitle": "受渡時間\n2025/06/09 14:05",
  "footerContents": "配達方法：配達代行"
}

Responses

202

Accepted

object

400

リクエストパラメーターが不正
- 指定されたメニューIDやトッピングIDが存在しない、または店舗で取り扱わない場合
- 不正なフォーマットの値を指定した場合
- toppings の各要素において、toppingId および name の両方が未指定の場合
休止中の店舗IDが指定された場合
指定の店舗にウェイターターミナルが登録されていない場合

object

title

required

string

type

required

string

status

integer

detail

string

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "(エラー内容の説明メッセージ)",
  "status": 400
}

{
  "type": "https://api.smaregi.jp/problems/waiter/no-waiter-terminal",
  "title": "店舗にウェイターターミナル未登録",
  "detail": "指定の店舗はウェイターターミナルが登録されていないため、印刷できません。",
  "status": 400
}

404

指定した店舗が存在しない場合

object

title

required

string

type

required

string

status

integer

detail

string