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

予約更新

PATCH
/reservations/{reservation_id}
curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/reservations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reservationPersonName": "須磨零二", "reservationPersonNameKana": "スマレイジ", "note": "持ち込みあり。" }'

予約を更新します。
予約はリクエストしたキーの内容で上書き更新します。
リクエストした予約の予約時間・テーブルが他の予約と重なっていても更新できます。
外部システム連携機能で取り込んだ予約情報は更新できません。

対象プラン

  • フードビジネスプラン

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
reservation_id
required
string

予約ID

Request Body

Section titled “Request Body”
Media typeapplication/json
UpdateReservation

予約更新APIのリクエストスキーマ

object
startAt

予約開始日時(RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]
予約終了日時より前の存在する日時を設定してください
保存時に指定したタイムゾーンに関わらず、参照時には Asia/Tokyo のタイムゾーンが適用されます

string format: date-time
endAt

予約終了日時(RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]
予約開始日時より後の存在する日時を設定してください
保存時に指定したタイムゾーンに関わらず、参照時には Asia/Tokyo のタイムゾーンが適用されます

string format: date-time
persons

人数

  • nullが指定された場合、adultsとchildrenの値に0が設定されます
object
adults
required

人数(大人)

integer
<= 1000
children
required

人数(子供)

integer
<= 1000
reservationPersonName

予約者名

  • 絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
  • 不可視文字のみの登録はできません
string
>= 1 characters <= 50 characters
reservationPersonNameKana

予約者名(カナ)

  • 絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
string
<= 50 characters
status

予約ステータス
注文に紐づいた予約は「キャンセル」のステータスへの変更を行えません

  • waiting: 来店待ち
  • coming: ご来店
  • finished: お食事済
  • canceled: キャンセル
string
Allowed values: waiting coming finished canceled
tableIds

店舗のテーブル情報

Array<string>
phoneNumber

電話番号

string
<= 20 characters
staff

受付スタッフ

object
staffId
required

受付スタッフID

string
staffName

受付スタッフ名
指定がない場合、受付スタッフIDにて検索した受付スタッフ名を使用して登録が行われます

  • 絵文字など、UTF-8で4バイトとして扱われる文字は使用できません
  • 不可視文字のみの登録はできません
string
>= 1 characters <= 50 characters
note

メモ

string
<= 1000 characters
reservedAt

予約受付日時(RFC3339の日時形式)[YYYY-MM-DDThh:mm:ssTZD]
保存時に指定したタイムゾーンに関わらず、参照時には Asia/Tokyo のタイムゾーンが適用されます

string format: date-time
Examples
{
  "reservationPersonName": "須磨零二",
  "reservationPersonNameKana": "スマレイジ",
  "note": "持ち込みあり。"
}

Responses

Section titled “Responses”

204

Section titled “204”

No Content
更新成功

400

Section titled “400”

Bad Request

  • リクエストパラメーターが不正
    • 指定した店舗ID、テーブルID、受付スタッフIDが存在しない場合
    • 不正なフォーマットの値を指定した場合
    • テーブルIDに重複が存在する場合
  • 休止中の店舗IDの予約が指定された場合
Media typeapplication/json
object
title
required
string
type
required
string
status
integer
detail
string
Examplegenerated
{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}

403

Section titled “403”

Forbidden

  • 対象契約のプランで利用できない場合
Media typeapplication/json
object
title
required
string
type
required
string
status
integer
detail
string
Examplegenerated
{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}

404

Section titled “404”

Not Found

  • 指定したデータが存在しない場合
Media typeapplication/json
object
title
required
string
type
required
string
status
integer
detail
string
Examplegenerated
{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}

405

Section titled “405”

Method Not Allowed

  • 外部システム連携機能で取り込んだ予約情報の場合
  • テーブル利用に紐づいている予約のステータスをキャンセルへと変更しようとした場合
Media typeapplication/json
object
title
required
string
type
required
string
status
integer
detail
string
Examplegenerated
{
  "title": "example",
  "type": "example",
  "status": 1,
  "detail": "example"
}