予約データの登録 / 更新 / キャンセル / 完了

予約データの登録 / 更新 / キャンセル / 完了

  • 時間タイプ
  • スクールタイプ
  • 会議室タイプ
  • イベントタイプ

ご契約と料金に関して

ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。利用するAPIごとのご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。

登録系API：予約データ

予約データを登録します。
登録は1リクエストあたり1件となります。

メソッド

  • POST

URL

  • /api/v2/reservations

リクエストヘッダ

  • Content-Type: application/json; charset=utf-8

リクエストボディ

◎：必須項目
※1：予約ブロックの場合は不要

パラメータ名 型 設定 説明 時間 会議室 スクール イベント
mail_send_flg 数値 任意 メール配信フラグ ○ ○ ○ ○
customer_id 数値 任意 予約者会員番号 ○ ○ ○ ○
customer_name 文字列 任意 予約者お名前 ○ ○ ○ ○
customer_kana 文字列 任意 予約者フリガナ ○ ○ ○ ○
customer_mail 文字列 任意 予約者メールアドレス ○ ○ ○ ○
customer_zip 文字列 任意 予約者郵便番号 ○ ○ ○ ○
customer_prefecture 文字列 任意 予約者都道府県名 ○ ○ ○ ○
customer_address1 文字列 任意 予約者住所1 ○ ○ ○ ○
customer_address２ 文字列 任意 予約者住所2 ○ ○ ○ ○
customer_tel 文字列 任意 予約者電話番号 ○ ○ ○ ○
customer_sex 文字列 任意 予約者性別 ○ ○ ○ ○
customer_birth_year 数値 任意 予約者生年月日年 ○ ○ ○ ○
customer_birth_month 数値 任意 予約者生年月日月 ○ ○ ○ ○
customer_birth_day 数値 任意 予約者生年月日日 ○ ○ ○ ○
customer_extension_id 文字列 任意 連携会員ID ○ ○ ○ ○
reservation_date 日付 必須 予約日（yyyy/mm/dd 形式） ◎ ◎    
reservation_time 日付 必須 開始時間（HH:mm形式） ◎ ◎    
category_id 数値 任意 カテゴリID ○ ○    
main_menu_id 数値 必須 メインメニューID ◎ ◎   ◎
timetable_id 数値 必須 時間割ID     ◎  
sub_menu_id 数値 必須 サブメニューID ◎※1 ◎ ※1    
option_id 数値 任意 オプションID ○ ○ ○ ○
option_num 数値 任意 オプション数 ○ ○ ○ ○
required_minute 数値 任意 所要時間[分] ○ ○    
reservation_number 数値 必須 予約数 ◎   ◎ ◎
memo 文字列 任意 管理メモ ○ ○ ○ ○
block_flg 数値 任意 予約ブロックフラグ ○ ○    
online_meeting_info 文字列 任意 Web会議情報 ○ ○    
attr_orgd1_value 文字列 任意 カスタム記念日値1 ○ ○ ○ ○
attr_orgd2_value 文字列 任意 カスタム記念日値2 ○ ○ ○ ○
attr_orgd3_value 文字列 任意 カスタム記念日値3 ○ ○ ○ ○
attr_orgd4_value 文字列 任意 カスタム記念日値4 ○ ○ ○ ○
attr_orgd5_value 文字列 任意 カスタム記念日値5 ○ ○ ○ ○
attr_org1_value 文字列 任意 カスタム属性値1 ○ ○ ○ ○
attr_org2_value 文字列 任意 カスタム属性値2 ○ ○ ○ ○
attr_org3_value 文字列 任意 カスタム属性値3 ○ ○ ○ ○
attr_org4_value 文字列 任意 カスタム属性値4 ○ ○ ○ ○
attr_org5_value 文字列 任意 カスタム属性値5 ○ ○ ○ ○
attr_org6_value 文字列 任意 カスタム属性値6 ○ ○ ○ ○
attr_org7_value 文字列 任意 カスタム属性値7 ○ ○ ○ ○
attr_org8_value 文字列 任意 カスタム属性値8 ○ ○ ○ ○
attr_org9_value 文字列 任意 カスタム属性値9 ○ ○ ○ ○
attr_org10_value 文字列 任意 カスタム属性値10 ○ ○ ○ ○
attr_org11_value 文字列 任意 カスタム属性値11 ○ ○ ○ ○
attr_org12_value 文字列 任意 カスタム属性値12 ○ ○ ○ ○
attr_org13_value 文字列 任意 カスタム属性値13 ○ ○ ○ ○
attr_org14_value 文字列 任意 カスタム属性値14 ○ ○ ○ ○
attr_org15_value 文字列 任意 カスタム属性値15 ○ ○ ○ ○
attr_org16_value 文字列 任意 カスタム属性値16 ○ ○ ○ ○
attr_org17_value 文字列 任意 カスタム属性値17 ○ ○ ○ ○
attr_org18_value 文字列 任意 カスタム属性値18 ○ ○ ○ ○
attr_org19_value 文字列 任意 カスタム属性値19 ○ ○ ○ ○
attr_org20_value 文字列 任意 カスタム属性値20 ○ ○ ○ ○
attr_org21_value 文字列 任意 カスタム属性値21 ○ ○ ○ ○
attr_org22_value 文字列 任意 カスタム属性値22 ○ ○ ○ ○
attr_org23_value 文字列 任意 カスタム属性値23 ○ ○ ○ ○
attr_org24_value 文字列 任意 カスタム属性値24 ○ ○ ○ ○
attr_org25_value 文字列 任意 カスタム属性値25 ○ ○ ○ ○
attr_org26_value 文字列 任意 カスタム属性値26 ○ ○ ○ ○
attr_org27_value 文字列 任意 カスタム属性値27 ○ ○ ○ ○
attr_org28_value 文字列 任意 カスタム属性値28 ○ ○ ○ ○
attr_org29_value 文字列 任意 カスタム属性値29 ○ ○ ○ ○
attr_org30_value 文字列 任意 カスタム属性値30 ○ ○ ○ ○
attr_res1_value 文字列 任意 予約属性値1 ○ ○ ○ ○
attr_res2_value 文字列 任意 予約属性値2 ○ ○ ○ ○
attr_res3_value 文字列 任意 予約属性値3 ○ ○ ○ ○
attr_res4_value 文字列 任意 予約属性値4 ○ ○ ○ ○
attr_res5_value 文字列 任意 予約属性値5 ○ ○ ○ ○
attr_res6_value 文字列 任意 予約属性値6 ○ ○ ○ ○
attr_res7_value 文字列 任意 予約属性値7 ○ ○ ○ ○
attr_res8_value 文字列 任意 予約属性値8 ○ ○ ○ ○
attr_res9_value 文字列 任意 予約属性値9 ○ ○ ○ ○
attr_res10_value 文字列 任意 予約属性値10 ○ ○ ○ ○
attr_res11_value 文字列 任意 予約属性値11 ○ ○ ○ ○
attr_res12_value 文字列 任意 予約属性値12 ○ ○ ○ ○
attr_res13_value 文字列 任意 予約属性値13 ○ ○ ○ ○
attr_res14_value 文字列 任意 予約属性値14 ○ ○ ○ ○
attr_res15_value 文字列 任意 予約属性値15 ○ ○ ○ ○
attr_res16_value 文字列 任意 予約属性値16 ○ ○ ○ ○
attr_res17_value 文字列 任意 予約属性値17 ○ ○ ○ ○
attr_res18_value 文字列 任意 予約属性値18 ○ ○ ○ ○
attr_res19_value 文字列 任意 予約属性値19 ○ ○ ○ ○
attr_res20_value 文字列 任意 予約属性値20 ○ ○ ○ ○
attr_res21_value 文字列 任意 予約属性値21 ○ ○ ○ ○
attr_res22_value 文字列 任意 予約属性値22 ○ ○ ○ ○
attr_res23_value 文字列 任意 予約属性値23 ○ ○ ○ ○
attr_res24_value 文字列 任意 予約属性値24 ○ ○ ○ ○
attr_res25_value 文字列 任意 予約属性値25 ○ ○ ○ ○
attr_res26_value 文字列 任意 予約属性値26 ○ ○ ○ ○
attr_res27_value 文字列 任意 予約属性値27 ○ ○ ○ ○
attr_res28_value 文字列 任意 予約属性値28 ○ ○ ○ ○
attr_res29_value 文字列 任意 予約属性値29 ○ ○ ○ ○
attr_res30_value 文字列 任意 予約属性値30 ○ ○ ○ ○

リクエスト例

JSON

  • {
  • "mail_send_flg": "1",
  • "reservation_date": "2023/09/20",
  • "reservation_time": "15:00",
  • "reservation_number":4,
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": "2003",
  • "customer_birth_month": "08",
  • "customer_birth_day": "17",
  • "main_menu_id":2,
  • "sub_menu_id":3,
  • "options": [
  • {
  • "option_id": 8,
  • "option_num": 2
  • },
  • {
  • "option_id": 7,
  • "option_num": 4
  • },
  • {
  • "option_id": 6,
  • "option_num": 6
  • },
  • {
  • "option_id": 5,
  • "option_num": 20
  • },
  • {
  • "option_id": 4,
  • "option_num": 18
  • },
  • {
  • "option_id": 3,
  • "option_num": 14
  • },
  • {
  • "option_id": 2,
  • "option_num": 15
  • },
  • {
  • "option_id": 1,
  • "option_num": 3
  • }
  • ],
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_value": "2021/11/19"
  • }

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 201 Created
  • Content-Type:application/json;charset=utf-8

※エラー時のレスポンスはエラーレスポンス項を参照ください。

レスポンスボディ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "reservation_id": 10003,
  • "customer_id": null,
  • "customer_login_id": "",
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": 2003,
  • "customer_birth_month": 8,
  • "customer_birth_day": 17,
  • "customer_extension_id": "",
  • "reservation_date": "2023/09/20",
  • "reservation_time": "15:00",
  • "category_id": null,
  • "category_name": "",
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "timetable_id": null,
  • "anyone_flg": 0,
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "equipment_id": null,
  • "equipment_name": "",
  • "staff_id": null,
  • "staff_name": "",
  • "options": [
  • {
  • "option_id": 1,
  • "option_name": "予約オプション8",
  • "option_num": 3,
  • "option_unit": "個"
  • },
  • {
  • "option_id": 2,
  • "option_name": "予約オプション7",
  • "option_num": 15,
  • "option_unit": "枚"
  • },
  • {
  • "option_id": 3,
  • "option_name": "予約オプション6",
  • "option_num": 14,
  • "option_unit": "人"
  • },
  • {
  • "option_id": 4,
  • "option_name": "予約オプション5",
  • "option_num": 18,
  • "option_unit": "台"
  • },
  • {
  • "option_id": 5,
  • "option_name": "予約オプション4",
  • "option_num": 20,
  • "option_unit": "件"
  • },
  • {
  • "option_id": 6,
  • "option_name": "予約オプション3",
  • "option_num": 6,
  • "option_unit": "本"
  • },
  • {
  • "option_id": 7,
  • "option_name": "予約オプション2",
  • "option_num": 4,
  • "option_unit": "席"
  • },
  • {
  • "option_id": 8,
  • "option_name": "予約オプション1",
  • "option_num": 2,
  • "option_unit": "人前"
  • }
  • ],
  • "required_minute": 60,
  • "reservation_number": 4,
  • "amount": 69000,
  • "payment_status": "",
  • "payment_transaction_id": "",
  • "reservation_message": "",
  • "registered_datetime": "2023/09/05 17:22:01",
  • "registered_operation_type": "API",
  • "update_datetime": "2023/09/05 17:22:01",
  • "memo": "",
  • "unfixed_flg": 0,
  • "unfixed_result_flg": 0,
  • "history_flg": 1,
  • "cancel_flg": 0,
  • "cancel_message": "",
  • "block_flg": 0,
  • "cancel_datetime": null,
  • "cancel_guest_code": "ul655mbk9u4h",
  • "online_meeting_info": "",
  • "google_meet_url": "",
  • "zoom_url": "https://us04web.zoom.us/j/xxxxxxxxx?pwd=xxxxxxxxxxxxxxx",
  • "zoom_id": "xxxxxxxxx",
  • "zoom_password": "xxxxxxxxx",
  • "zoom_url_host": "https://us04web.zoom.us/s/xxxxxxxxx?zak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "device": "PC",
  • "ip_address": "192.168.33.1",
  • "attr_orgd1_label": "",
  • "attr_orgd1_value": null,
  • "attr_orgd2_label": "",
  • "attr_orgd2_value": null,
  • "attr_orgd3_label": "",
  • "attr_orgd3_value": null,
  • "attr_orgd4_label": "",
  • "attr_orgd4_value": null,
  • "attr_orgd5_label": "",
  • "attr_orgd5_value": null,
  • "attr_org1_label": "カスタム属性1テキストボックス（１行）",
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_org2_label": "",
  • "attr_org2_value": "",
  • "attr_org3_label": "",
  • "attr_org3_value": "",
  • "attr_org4_label": "",
  • "attr_org4_value": "",
  • "attr_org5_label": "",
  • "attr_org5_value": "",
  • "attr_org6_label": "",
  • "attr_org6_value": "",
  • "attr_org7_label": "",
  • "attr_org7_value": "",
  • "attr_org8_label": "",
  • "attr_org8_value": "",
  • "attr_org9_label": "",
  • "attr_org9_value": "",
  • "attr_org10_label": "",
  • "attr_org10_value": "",
  • "attr_org11_label": "",
  • "attr_org11_value": "",
  • "attr_org12_label": "",
  • "attr_org12_value": "",
  • "attr_org13_label": "",
  • "attr_org13_value": "",
  • "attr_org14_label": "",
  • "attr_org14_value": "",
  • "attr_org15_label": "",
  • "attr_org15_value": "",
  • "attr_org16_label": "",
  • "attr_org16_value": "",
  • "attr_org17_label": "",
  • "attr_org17_value": "",
  • "attr_org18_label": "",
  • "attr_org18_value": "",
  • "attr_org19_label": "",
  • "attr_org19_value": "",
  • "attr_org20_label": "",
  • "attr_org20_value": "",
  • "attr_org21_label": "",
  • "attr_org21_value": "",
  • "attr_org22_label": "",
  • "attr_org22_value": "",
  • "attr_org23_label": "",
  • "attr_org23_value": "",
  • "attr_org24_label": "",
  • "attr_org24_value": "",
  • "attr_org25_label": "",
  • "attr_org25_value": "",
  • "attr_org26_label": "",
  • "attr_org26_value": "",
  • "attr_org27_label": "",
  • "attr_org27_value": "",
  • "attr_org28_label": "",
  • "attr_org28_value": "",
  • "attr_org29_label": "",
  • "attr_org29_value": "",
  • "attr_org30_label": "",
  • "attr_org30_value": "",
  • "attr_res1_label": "予約アンケートテキストボックス(１行)",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_label": "予約アンケートテキストエリア(複数行)",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_label": "予約アンケート日付",
  • "attr_res6_value": "2021/11/19",
  • "attr_res7_label": "",
  • "attr_res7_value": "",
  • "attr_res8_label": "",
  • "attr_res8_value": "",
  • "attr_res9_label": "",
  • "attr_res9_value": "",
  • "attr_res10_label": "",
  • "attr_res10_value": "",
  • "attr_res11_label": "",
  • "attr_res11_value": "",
  • "attr_res12_label": "",
  • "attr_res12_value": "",
  • "attr_res13_label": "",
  • "attr_res13_value": "",
  • "attr_res14_label": "",
  • "attr_res14_value": "",
  • "attr_res15_label": "",
  • "attr_res15_value": "",
  • "attr_res16_label": "",
  • "attr_res16_value": "",
  • "attr_res17_label": "",
  • "attr_res17_value": "",
  • "attr_res18_label": "",
  • "attr_res18_value": "",
  • "attr_res19_label": "",
  • "attr_res19_value": "",
  • "attr_res20_label": "",
  • "attr_res20_value": "",
  • "attr_res21_label": "",
  • "attr_res21_value": "",
  • "attr_res22_label": "",
  • "attr_res22_value": "",
  • "attr_res23_label": "",
  • "attr_res23_value": "",
  • "attr_res24_label": "",
  • "attr_res24_value": "",
  • "attr_res25_label": "",
  • "attr_res25_value": "",
  • "attr_res26_label": "",
  • "attr_res26_value": "",
  • "attr_res27_label": "",
  • "attr_res27_value": "",
  • "attr_res28_label": "",
  • "attr_res28_value": "",
  • "attr_res29_label": "",
  • "attr_res29_value": "",
  • "attr_res30_label": "",
  • "attr_res30_value": ""
  • }
  • ]
  • }

予約データを更新する

予約データを更新します。
更新は1リクエストあたり1件となります。

メソッド

  • PATCH

URL

  • /api/v2/reservations/:reservation_id

リクエストヘッダ

  • Content-Type: application/json; charset=utf-8

リクエスト例

URL

/api/v2/reservations/10003

JSON

  • {
  • "mail_send_flg": "1",
  • "reservation_date": "2023/09/20",
  • "reservation_time": "15:00",
  • "reservation_number":4,
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": "2003",
  • "customer_birth_month": "08",
  • "customer_birth_day": "17",
  • "main_menu_id":2,
  • "sub_menu_id":3,
  • "options": [
  • {
  • "option_id": 8,
  • "option_num": 2
  • },
  • {
  • "option_id": 7,
  • "option_num": 4
  • },
  • {
  • "option_id": 6,
  • "option_num": 6
  • },
  • {
  • "option_id": 5,
  • "option_num": 20
  • },
  • {
  • "option_id": 4,
  • "option_num": 18
  • },
  • {
  • "option_id": 3,
  • "option_num": 14
  • },
  • {
  • "option_id": 2,
  • "option_num": 15
  • },
  • {
  • "option_id": 1,
  • "option_num": 3
  • }
  • ],
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#予約アンケートチェックボックス選択肢2#予約アンケートチェックボックス選択肢3#予約アンケートチェックボックス選択肢4#予約アンケートチェックボックス選択肢5#予約アンケートチェックボックス選択肢6#予約アンケートチェックボックス選択肢7#予約アンケートチェックボックス選択肢8#予約アンケートチェックボックス選択肢9#予約アンケートチェックボックス選択肢10#",
  • "attr_res6_value": "2021/11/19"
  • }

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 200 OK
  • Content-Type:application/json;charset=utf-8

レスポンスボディ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "reservation_id": 10003,
  • "customer_id": null,
  • "customer_login_id": "",
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": 2003,
  • "customer_birth_month": 8,
  • "customer_birth_day": 17,
  • "customer_extension_id": "",
  • "reservation_date": "2023/09/20",
  • "reservation_time": "15:00",
  • "category_id": null,
  • "category_name": "",
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "timetable_id": null,
  • "anyone_flg": 0,
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "equipment_id": null,
  • "equipment_name": "",
  • "staff_id": null,
  • "staff_name": "",
  • "options": [
  • {
  • "option_id": 1,
  • "option_name": "予約オプション8",
  • "option_num": 3,
  • "option_unit": "個"
  • },
  • {
  • "option_id": 2,
  • "option_name": "予約オプション7",
  • "option_num": 15,
  • "option_unit": "枚"
  • },
  • {
  • "option_id": 3,
  • "option_name": "予約オプション6",
  • "option_num": 14,
  • "option_unit": "人"
  • },
  • {
  • "option_id": 4,
  • "option_name": "予約オプション5",
  • "option_num": 18,
  • "option_unit": "台"
  • },
  • {
  • "option_id": 5,
  • "option_name": "予約オプション4",
  • "option_num": 20,
  • "option_unit": "件"
  • },
  • {
  • "option_id": 6,
  • "option_name": "予約オプション3",
  • "option_num": 6,
  • "option_unit": "本"
  • },
  • {
  • "option_id": 7,
  • "option_name": "予約オプション2",
  • "option_num": 4,
  • "option_unit": "席"
  • },
  • {
  • "option_id": 8,
  • "option_name": "予約オプション1",
  • "option_num": 2,
  • "option_unit": "人前"
  • }
  • ],
  • "required_minute": 60,
  • "reservation_number": 4,
  • "amount": 69000,
  • "payment_status": "",
  • "payment_transaction_id": "",
  • "reservation_message": "",
  • "registered_datetime": "2023/09/05 17:22:01",
  • "registered_operation_type": "API",
  • "update_datetime": "2023/09/05 17:22:01",
  • "memo": "",
  • "unfixed_flg": 0,
  • "unfixed_result_flg": 0,
  • "history_flg": 1,
  • "cancel_flg": 0,
  • "cancel_message": "",
  • "block_flg": 0,
  • "cancel_datetime": null,
  • "cancel_guest_code": "ul655mbk9u4h",
  • "online_meeting_info": "",
  • "google_meet_url": "",
  • "zoom_url": "https://us04web.zoom.us/j/xxxxxxxxx?pwd=xxxxxxxxxxxxxxx",
  • "zoom_id": "xxxxxxxxx",
  • "zoom_password": "xxxxxxxxx",
  • "zoom_url_host": "https://us04web.zoom.us/s/xxxxxxxxx?zak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "device": "PC",
  • "ip_address": "192.168.33.1",
  • "attr_orgd1_label": "",
  • "attr_orgd1_value": null,
  • "attr_orgd2_label": "",
  • "attr_orgd2_value": null,
  • "attr_orgd3_label": "",
  • "attr_orgd3_value": null,
  • "attr_orgd4_label": "",
  • "attr_orgd4_value": null,
  • "attr_orgd5_label": "",
  • "attr_orgd5_value": null,
  • "attr_org1_label": "カスタム属性1テキストボックス（１行）",
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_org2_label": "",
  • "attr_org2_value": "",
  • "attr_org3_label": "",
  • "attr_org3_value": "",
  • "attr_org4_label": "",
  • "attr_org4_value": "",
  • "attr_org5_label": "",
  • "attr_org5_value": "",
  • "attr_org6_label": "",
  • "attr_org6_value": "",
  • "attr_org7_label": "",
  • "attr_org7_value": "",
  • "attr_org8_label": "",
  • "attr_org8_value": "",
  • "attr_org9_label": "",
  • "attr_org9_value": "",
  • "attr_org10_label": "",
  • "attr_org10_value": "",
  • "attr_org11_label": "",
  • "attr_org11_value": "",
  • "attr_org12_label": "",
  • "attr_org12_value": "",
  • "attr_org13_label": "",
  • "attr_org13_value": "",
  • "attr_org14_label": "",
  • "attr_org14_value": "",
  • "attr_org15_label": "",
  • "attr_org15_value": "",
  • "attr_org16_label": "",
  • "attr_org16_value": "",
  • "attr_org17_label": "",
  • "attr_org17_value": "",
  • "attr_org18_label": "",
  • "attr_org18_value": "",
  • "attr_org19_label": "",
  • "attr_org19_value": "",
  • "attr_org20_label": "",
  • "attr_org20_value": "",
  • "attr_org21_label": "",
  • "attr_org21_value": "",
  • "attr_org22_label": "",
  • "attr_org22_value": "",
  • "attr_org23_label": "",
  • "attr_org23_value": "",
  • "attr_org24_label": "",
  • "attr_org24_value": "",
  • "attr_org25_label": "",
  • "attr_org25_value": "",
  • "attr_org26_label": "",
  • "attr_org26_value": "",
  • "attr_org27_label": "",
  • "attr_org27_value": "",
  • "attr_org28_label": "",
  • "attr_org28_value": "",
  • "attr_org29_label": "",
  • "attr_org29_value": "",
  • "attr_org30_label": "",
  • "attr_org30_value": "",
  • "attr_res1_label": "予約アンケートテキストボックス(１行)",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_label": "予約アンケートテキストエリア(複数行)",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_label": "予約アンケート日付",
  • "attr_res6_value": "2021/11/19",
  • "attr_res7_label": "",
  • "attr_res7_value": "",
  • "attr_res8_label": "",
  • "attr_res8_value": "",
  • "attr_res9_label": "",
  • "attr_res9_value": "",
  • "attr_res10_label": "",
  • "attr_res10_value": "",
  • "attr_res11_label": "",
  • "attr_res11_value": "",
  • "attr_res12_label": "",
  • "attr_res12_value": "",
  • "attr_res13_label": "",
  • "attr_res13_value": "",
  • "attr_res14_label": "",
  • "attr_res14_value": "",
  • "attr_res15_label": "",
  • "attr_res15_value": "",
  • "attr_res16_label": "",
  • "attr_res16_value": "",
  • "attr_res17_label": "",
  • "attr_res17_value": "",
  • "attr_res18_label": "",
  • "attr_res18_value": "",
  • "attr_res19_label": "",
  • "attr_res19_value": "",
  • "attr_res20_label": "",
  • "attr_res20_value": "",
  • "attr_res21_label": "",
  • "attr_res21_value": "",
  • "attr_res22_label": "",
  • "attr_res22_value": "",
  • "attr_res23_label": "",
  • "attr_res23_value": "",
  • "attr_res24_label": "",
  • "attr_res24_value": "",
  • "attr_res25_label": "",
  • "attr_res25_value": "",
  • "attr_res26_label": "",
  • "attr_res26_value": "",
  • "attr_res27_label": "",
  • "attr_res27_value": "",
  • "attr_res28_label": "",
  • "attr_res28_value": "",
  • "attr_res29_label": "",
  • "attr_res29_value": "",
  • "attr_res30_label": "",
  • "attr_res30_value": ""
  • }
  • ]
  • }

仮予約データを承認する

仮予約データを承認します。

メソッド

  • PATCH

URL

  • /api/v2/reservations/:reservation_id/unfixed_accept

リクエストヘッダ

  • Content-Type: application/json; charset=utf-8

リクエスト例

URL

/api/v2/reservations/16955/unfixed_accept

JSON

  • {
  • "mail_send_flg": "1",
  • }

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 200 OK
  • Content-Type:application/json;charset=utf-8

レスポンスボディ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "reservation_id": 16955,
  • "customer_id": null,
  • "customer_login_id": "",
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": 2003,
  • "customer_birth_month": 8,
  • "customer_birth_day": 17,
  • "customer_extension_id": "",
  • "reservation_date": "2025/01/14",
  • "reservation_time": "15:00",
  • "category_id": null,
  • "category_name": "",
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "timetable_id": null,
  • "anyone_flg": 0,
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "equipment_id": null,
  • "equipment_name": "",
  • "staff_id": null,
  • "staff_name": "",
  • "options": [
  • {
  • "option_id": 1,
  • "option_name": "予約オプション8",
  • "option_num": 3,
  • "option_unit": "個"
  • },
  • {
  • "option_id": 2,
  • "option_name": "予約オプション7",
  • "option_num": 15,
  • "option_unit": "枚"
  • },
  • {
  • "option_id": 3,
  • "option_name": "予約オプション6",
  • "option_num": 14,
  • "option_unit": "人"
  • },
  • {
  • "option_id": 4,
  • "option_name": "予約オプション5",
  • "option_num": 18,
  • "option_unit": "台"
  • },
  • {
  • "option_id": 5,
  • "option_name": "予約オプション4",
  • "option_num": 20,
  • "option_unit": "件"
  • },
  • {
  • "option_id": 6,
  • "option_name": "予約オプション3",
  • "option_num": 6,
  • "option_unit": "本"
  • },
  • {
  • "option_id": 7,
  • "option_name": "予約オプション2",
  • "option_num": 4,
  • "option_unit": "席"
  • },
  • {
  • "option_id": 8,
  • "option_name": "予約オプション1",
  • "option_num": 2,
  • "option_unit": "人前"
  • }
  • ],
  • "required_minute": 60,
  • "reservation_number": 4,
  • "amount": 69000,
  • "payment_status": "",
  • "payment_transaction_id": "",
  • "reservation_message": "",
  • "registered_datetime": "2025/01/14 10:34:02",
  • "registered_operation_type": "予約サイト",
  • "update_datetime": "2025/01/14 10:39:55",
  • "memo": "",
  • "unfixed_flg": 0,
  • "unfixed_result_flg": 0,
  • "history_flg": 1,
  • "cancel_flg": 0,
  • "cancel_message": "",
  • "block_flg": 0,
  • "cancel_datetime": null,
  • "cancel_guest_code": "ul655mbk9u4h",
  • "online_meeting_info": "",
  • "google_meet_url": "",
  • "zoom_url": "https://us04web.zoom.us/j/xxxxxxxxx?pwd=xxxxxxxxxxxxxxx",
  • "zoom_id": "xxxxxxxxx",
  • "zoom_password": "xxxxxxxxx",
  • "zoom_url_host": "https://us04web.zoom.us/s/xxxxxxxxx?zak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "device": "PC",
  • "ip_address": "192.168.33.1",
  • "attr_orgd1_label": "",
  • "attr_orgd1_value": null,
  • "attr_orgd2_label": "",
  • "attr_orgd2_value": null,
  • "attr_orgd3_label": "",
  • "attr_orgd3_value": null,
  • "attr_orgd4_label": "",
  • "attr_orgd4_value": null,
  • "attr_orgd5_label": "",
  • "attr_orgd5_value": null,
  • "attr_org1_label": "カスタム属性1テキストボックス（１行）",
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_org2_label": "",
  • "attr_org2_value": "",
  • "attr_org3_label": "",
  • "attr_org3_value": "",
  • "attr_org4_label": "",
  • "attr_org4_value": "",
  • "attr_org5_label": "",
  • "attr_org5_value": "",
  • "attr_org6_label": "",
  • "attr_org6_value": "",
  • "attr_org7_label": "",
  • "attr_org7_value": "",
  • "attr_org8_label": "",
  • "attr_org8_value": "",
  • "attr_org9_label": "",
  • "attr_org9_value": "",
  • "attr_org10_label": "",
  • "attr_org10_value": "",
  • "attr_org11_label": "",
  • "attr_org11_value": "",
  • "attr_org12_label": "",
  • "attr_org12_value": "",
  • "attr_org13_label": "",
  • "attr_org13_value": "",
  • "attr_org14_label": "",
  • "attr_org14_value": "",
  • "attr_org15_label": "",
  • "attr_org15_value": "",
  • "attr_org16_label": "",
  • "attr_org16_value": "",
  • "attr_org17_label": "",
  • "attr_org17_value": "",
  • "attr_org18_label": "",
  • "attr_org18_value": "",
  • "attr_org19_label": "",
  • "attr_org19_value": "",
  • "attr_org20_label": "",
  • "attr_org20_value": "",
  • "attr_org21_label": "",
  • "attr_org21_value": "",
  • "attr_org22_label": "",
  • "attr_org22_value": "",
  • "attr_org23_label": "",
  • "attr_org23_value": "",
  • "attr_org24_label": "",
  • "attr_org24_value": "",
  • "attr_org25_label": "",
  • "attr_org25_value": "",
  • "attr_org26_label": "",
  • "attr_org26_value": "",
  • "attr_org27_label": "",
  • "attr_org27_value": "",
  • "attr_org28_label": "",
  • "attr_org28_value": "",
  • "attr_org29_label": "",
  • "attr_org29_value": "",
  • "attr_org30_label": "",
  • "attr_org30_value": "",
  • "attr_res1_label": "予約アンケートテキストボックス(１行)",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_label": "予約アンケートテキストエリア(複数行)",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_label": "予約アンケート日付",
  • "attr_res6_value": "2021/11/19",
  • "attr_res7_label": "",
  • "attr_res7_value": "",
  • "attr_res8_label": "",
  • "attr_res8_value": "",
  • "attr_res9_label": "",
  • "attr_res9_value": "",
  • "attr_res10_label": "",
  • "attr_res10_value": "",
  • "attr_res11_label": "",
  • "attr_res11_value": "",
  • "attr_res12_label": "",
  • "attr_res12_value": "",
  • "attr_res13_label": "",
  • "attr_res13_value": "",
  • "attr_res14_label": "",
  • "attr_res14_value": "",
  • "attr_res15_label": "",
  • "attr_res15_value": "",
  • "attr_res16_label": "",
  • "attr_res16_value": "",
  • "attr_res17_label": "",
  • "attr_res17_value": "",
  • "attr_res18_label": "",
  • "attr_res18_value": "",
  • "attr_res19_label": "",
  • "attr_res19_value": "",
  • "attr_res20_label": "",
  • "attr_res20_value": "",
  • "attr_res21_label": "",
  • "attr_res21_value": "",
  • "attr_res22_label": "",
  • "attr_res22_value": "",
  • "attr_res23_label": "",
  • "attr_res23_value": "",
  • "attr_res24_label": "",
  • "attr_res24_value": "",
  • "attr_res25_label": "",
  • "attr_res25_value": "",
  • "attr_res26_label": "",
  • "attr_res26_value": "",
  • "attr_res27_label": "",
  • "attr_res27_value": "",
  • "attr_res28_label": "",
  • "attr_res28_value": "",
  • "attr_res29_label": "",
  • "attr_res29_value": "",
  • "attr_res30_label": "",
  • "attr_res30_value": ""
  • }
  • ]
  • }

仮予約データを拒否する

仮予約データを拒否します。

メソッド

  • PATCH

URL

  • /api/v2/reservations/:reservation_id/unfixed_reject

リクエストヘッダ

  • Content-Type: application/json; charset=utf-8

リクエスト例

URL

/api/v2/reservations/16956/unfixed_reject

JSON

  • {
  • "mail_send_flg": "1",
  • }

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 200 OK
  • Content-Type:application/json;charset=utf-8

レスポンスボディ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "reservation_id": 16956,
  • "customer_id": null,
  • "customer_login_id": "",
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": 2003,
  • "customer_birth_month": 8,
  • "customer_birth_day": 17,
  • "customer_extension_id": "",
  • "reservation_date": "2025/01/16",
  • "reservation_time": "15:00",
  • "category_id": null,
  • "category_name": "",
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "timetable_id": null,
  • "anyone_flg": 0,
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "equipment_id": null,
  • "equipment_name": "",
  • "staff_id": null,
  • "staff_name": "",
  • "options": [
  • {
  • "option_id": 1,
  • "option_name": "予約オプション8",
  • "option_num": 3,
  • "option_unit": "個"
  • },
  • {
  • "option_id": 2,
  • "option_name": "予約オプション7",
  • "option_num": 15,
  • "option_unit": "枚"
  • },
  • {
  • "option_id": 3,
  • "option_name": "予約オプション6",
  • "option_num": 14,
  • "option_unit": "人"
  • },
  • {
  • "option_id": 4,
  • "option_name": "予約オプション5",
  • "option_num": 18,
  • "option_unit": "台"
  • },
  • {
  • "option_id": 5,
  • "option_name": "予約オプション4",
  • "option_num": 20,
  • "option_unit": "件"
  • },
  • {
  • "option_id": 6,
  • "option_name": "予約オプション3",
  • "option_num": 6,
  • "option_unit": "本"
  • },
  • {
  • "option_id": 7,
  • "option_name": "予約オプション2",
  • "option_num": 4,
  • "option_unit": "席"
  • },
  • {
  • "option_id": 8,
  • "option_name": "予約オプション1",
  • "option_num": 2,
  • "option_unit": "人前"
  • }
  • ],
  • "required_minute": 60,
  • "reservation_number": 4,
  • "amount": 69000,
  • "payment_status": "",
  • "payment_transaction_id": "",
  • "reservation_message": "",
  • "registered_datetime": "2025/01/14 10:35:23",
  • "registered_operation_type": "予約サイト",
  • "update_datetime": "2025/01/14 11:43:59",
  • "memo": "",
  • "unfixed_flg": 1,
  • "unfixed_result_flg": 0,
  • "history_flg": 1,
  • "cancel_flg": 1,
  • "cancel_message": "",
  • "block_flg": 0,
  • "cancel_datetime": 2025/01/14 11:43:59,
  • "cancel_guest_code": "ul655mbk9u4h",
  • "online_meeting_info": "",
  • "google_meet_url": "",
  • "zoom_url": "https://us04web.zoom.us/j/xxxxxxxxx?pwd=xxxxxxxxxxxxxxx",
  • "zoom_id": "xxxxxxxxx",
  • "zoom_password": "xxxxxxxxx",
  • "zoom_url_host": "https://us04web.zoom.us/s/xxxxxxxxx?zak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "device": "PC",
  • "ip_address": "192.168.33.1",
  • "attr_orgd1_label": "",
  • "attr_orgd1_value": null,
  • "attr_orgd2_label": "",
  • "attr_orgd2_value": null,
  • "attr_orgd3_label": "",
  • "attr_orgd3_value": null,
  • "attr_orgd4_label": "",
  • "attr_orgd4_value": null,
  • "attr_orgd5_label": "",
  • "attr_orgd5_value": null,
  • "attr_org1_label": "カスタム属性1テキストボックス（１行）",
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_org2_label": "",
  • "attr_org2_value": "",
  • "attr_org3_label": "",
  • "attr_org3_value": "",
  • "attr_org4_label": "",
  • "attr_org4_value": "",
  • "attr_org5_label": "",
  • "attr_org5_value": "",
  • "attr_org6_label": "",
  • "attr_org6_value": "",
  • "attr_org7_label": "",
  • "attr_org7_value": "",
  • "attr_org8_label": "",
  • "attr_org8_value": "",
  • "attr_org9_label": "",
  • "attr_org9_value": "",
  • "attr_org10_label": "",
  • "attr_org10_value": "",
  • "attr_org11_label": "",
  • "attr_org11_value": "",
  • "attr_org12_label": "",
  • "attr_org12_value": "",
  • "attr_org13_label": "",
  • "attr_org13_value": "",
  • "attr_org14_label": "",
  • "attr_org14_value": "",
  • "attr_org15_label": "",
  • "attr_org15_value": "",
  • "attr_org16_label": "",
  • "attr_org16_value": "",
  • "attr_org17_label": "",
  • "attr_org17_value": "",
  • "attr_org18_label": "",
  • "attr_org18_value": "",
  • "attr_org19_label": "",
  • "attr_org19_value": "",
  • "attr_org20_label": "",
  • "attr_org20_value": "",
  • "attr_org21_label": "",
  • "attr_org21_value": "",
  • "attr_org22_label": "",
  • "attr_org22_value": "",
  • "attr_org23_label": "",
  • "attr_org23_value": "",
  • "attr_org24_label": "",
  • "attr_org24_value": "",
  • "attr_org25_label": "",
  • "attr_org25_value": "",
  • "attr_org26_label": "",
  • "attr_org26_value": "",
  • "attr_org27_label": "",
  • "attr_org27_value": "",
  • "attr_org28_label": "",
  • "attr_org28_value": "",
  • "attr_org29_label": "",
  • "attr_org29_value": "",
  • "attr_org30_label": "",
  • "attr_org30_value": "",
  • "attr_res1_label": "予約アンケートテキストボックス(１行)",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_label": "予約アンケートテキストエリア(複数行)",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_label": "予約アンケート日付",
  • "attr_res6_value": "2021/11/19",
  • "attr_res7_label": "",
  • "attr_res7_value": "",
  • "attr_res8_label": "",
  • "attr_res8_value": "",
  • "attr_res9_label": "",
  • "attr_res9_value": "",
  • "attr_res10_label": "",
  • "attr_res10_value": "",
  • "attr_res11_label": "",
  • "attr_res11_value": "",
  • "attr_res12_label": "",
  • "attr_res12_value": "",
  • "attr_res13_label": "",
  • "attr_res13_value": "",
  • "attr_res14_label": "",
  • "attr_res14_value": "",
  • "attr_res15_label": "",
  • "attr_res15_value": "",
  • "attr_res16_label": "",
  • "attr_res16_value": "",
  • "attr_res17_label": "",
  • "attr_res17_value": "",
  • "attr_res18_label": "",
  • "attr_res18_value": "",
  • "attr_res19_label": "",
  • "attr_res19_value": "",
  • "attr_res20_label": "",
  • "attr_res20_value": "",
  • "attr_res21_label": "",
  • "attr_res21_value": "",
  • "attr_res22_label": "",
  • "attr_res22_value": "",
  • "attr_res23_label": "",
  • "attr_res23_value": "",
  • "attr_res24_label": "",
  • "attr_res24_value": "",
  • "attr_res25_label": "",
  • "attr_res25_value": "",
  • "attr_res26_label": "",
  • "attr_res26_value": "",
  • "attr_res27_label": "",
  • "attr_res27_value": "",
  • "attr_res28_label": "",
  • "attr_res28_value": "",
  • "attr_res29_label": "",
  • "attr_res29_value": "",
  • "attr_res30_label": "",
  • "attr_res30_value": ""
  • }
  • ]
  • }

予約データをキャンセルする

予約データをキャンセルします。

メソッド

  • PATCH

URL

  • /api/v2/reservations/:reservation_id/cancel

リクエストヘッダ

  • Content-Type: application/json; charset=utf-8

リクエスト例

URL

/api/v2/reservations/10003/cancel

JSON

  • {
  • "mail_send_flg": "1"
  • "force_cancel_flg": "1"
  • }

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 200 OK
  • Content-Type:application/json;charset=utf-8

レスポンスボディ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "reservation_id": 10003,
  • "customer_id": null,
  • "customer_login_id": "",
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": 2003,
  • "customer_birth_month": 8,
  • "customer_birth_day": 17,
  • "customer_extension_id": "",
  • "reservation_date": "2023/09/20",
  • "reservation_time": "15:00",
  • "category_id": null,
  • "category_name": "",
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "timetable_id": null,
  • "anyone_flg": 0,
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "equipment_id": null,
  • "equipment_name": "",
  • "staff_id": null,
  • "staff_name": "",
  • "options": [
  • {
  • "option_id": 1,
  • "option_name": "予約オプション8",
  • "option_num": 3,
  • "option_unit": "個"
  • },
  • {
  • "option_id": 2,
  • "option_name": "予約オプション7",
  • "option_num": 15,
  • "option_unit": "枚"
  • },
  • {
  • "option_id": 3,
  • "option_name": "予約オプション6",
  • "option_num": 14,
  • "option_unit": "人"
  • },
  • {
  • "option_id": 4,
  • "option_name": "予約オプション5",
  • "option_num": 18,
  • "option_unit": "台"
  • },
  • {
  • "option_id": 5,
  • "option_name": "予約オプション4",
  • "option_num": 20,
  • "option_unit": "件"
  • },
  • {
  • "option_id": 6,
  • "option_name": "予約オプション3",
  • "option_num": 6,
  • "option_unit": "本"
  • },
  • {
  • "option_id": 7,
  • "option_name": "予約オプション2",
  • "option_num": 4,
  • "option_unit": "席"
  • },
  • {
  • "option_id": 8,
  • "option_name": "予約オプション1",
  • "option_num": 2,
  • "option_unit": "人前"
  • }
  • ],
  • "required_minute": 60,
  • "reservation_number": 4,
  • "amount": 69000,
  • "payment_status": "",
  • "payment_transaction_id": "",
  • "reservation_message": "",
  • "registered_datetime": "2023/09/05 17:22:01",
  • "registered_operation_type": "API",
  • "update_datetime": "2023/09/05 17:22:01",
  • "memo": "",
  • "unfixed_flg": 0,
  • "unfixed_result_flg": 0,
  • "history_flg": 1,
  • "cancel_flg": 1,
  • "cancel_message": "",
  • "block_flg": 0,
  • "cancel_datetime": "2023/09/15 15:35:01",
  • "cancel_guest_code": "ul655mbk9u4h",
  • "online_meeting_info": "",
  • "google_meet_url": "",
  • "zoom_url": "https://us04web.zoom.us/j/xxxxxxxxx?pwd=xxxxxxxxxxxxxxx",
  • "zoom_id": "xxxxxxxxx",
  • "zoom_password": "xxxxxxxxx",
  • "zoom_url_host": "https://us04web.zoom.us/s/xxxxxxxxx?zak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "device": "PC",
  • "ip_address": "192.168.33.1",
  • "attr_orgd1_label": "",
  • "attr_orgd1_value": null,
  • "attr_orgd2_label": "",
  • "attr_orgd2_value": null,
  • "attr_orgd3_label": "",
  • "attr_orgd3_value": null,
  • "attr_orgd4_label": "",
  • "attr_orgd4_value": null,
  • "attr_orgd5_label": "",
  • "attr_orgd5_value": null,
  • "attr_org1_label": "カスタム属性1テキストボックス（１行）",
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_org2_label": "",
  • "attr_org2_value": "",
  • "attr_org3_label": "",
  • "attr_org3_value": "",
  • "attr_org4_label": "",
  • "attr_org4_value": "",
  • "attr_org5_label": "",
  • "attr_org5_value": "",
  • "attr_org6_label": "",
  • "attr_org6_value": "",
  • "attr_org7_label": "",
  • "attr_org7_value": "",
  • "attr_org8_label": "",
  • "attr_org8_value": "",
  • "attr_org9_label": "",
  • "attr_org9_value": "",
  • "attr_org10_label": "",
  • "attr_org10_value": "",
  • "attr_org11_label": "",
  • "attr_org11_value": "",
  • "attr_org12_label": "",
  • "attr_org12_value": "",
  • "attr_org13_label": "",
  • "attr_org13_value": "",
  • "attr_org14_label": "",
  • "attr_org14_value": "",
  • "attr_org15_label": "",
  • "attr_org15_value": "",
  • "attr_org16_label": "",
  • "attr_org16_value": "",
  • "attr_org17_label": "",
  • "attr_org17_value": "",
  • "attr_org18_label": "",
  • "attr_org18_value": "",
  • "attr_org19_label": "",
  • "attr_org19_value": "",
  • "attr_org20_label": "",
  • "attr_org20_value": "",
  • "attr_org21_label": "",
  • "attr_org21_value": "",
  • "attr_org22_label": "",
  • "attr_org22_value": "",
  • "attr_org23_label": "",
  • "attr_org23_value": "",
  • "attr_org24_label": "",
  • "attr_org24_value": "",
  • "attr_org25_label": "",
  • "attr_org25_value": "",
  • "attr_org26_label": "",
  • "attr_org26_value": "",
  • "attr_org27_label": "",
  • "attr_org27_value": "",
  • "attr_org28_label": "",
  • "attr_org28_value": "",
  • "attr_org29_label": "",
  • "attr_org29_value": "",
  • "attr_org30_label": "",
  • "attr_org30_value": "",
  • "attr_res1_label": "予約アンケートテキストボックス(１行)",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_label": "予約アンケートテキストエリア(複数行)",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_label": "予約アンケート日付",
  • "attr_res6_value": "2021/11/19",
  • "attr_res7_label": "",
  • "attr_res7_value": "",
  • "attr_res8_label": "",
  • "attr_res8_value": "",
  • "attr_res9_label": "",
  • "attr_res9_value": "",
  • "attr_res10_label": "",
  • "attr_res10_value": "",
  • "attr_res11_label": "",
  • "attr_res11_value": "",
  • "attr_res12_label": "",
  • "attr_res12_value": "",
  • "attr_res13_label": "",
  • "attr_res13_value": "",
  • "attr_res14_label": "",
  • "attr_res14_value": "",
  • "attr_res15_label": "",
  • "attr_res15_value": "",
  • "attr_res16_label": "",
  • "attr_res16_value": "",
  • "attr_res17_label": "",
  • "attr_res17_value": "",
  • "attr_res18_label": "",
  • "attr_res18_value": "",
  • "attr_res19_label": "",
  • "attr_res19_value": "",
  • "attr_res20_label": "",
  • "attr_res20_value": "",
  • "attr_res21_label": "",
  • "attr_res21_value": "",
  • "attr_res22_label": "",
  • "attr_res22_value": "",
  • "attr_res23_label": "",
  • "attr_res23_value": "",
  • "attr_res24_label": "",
  • "attr_res24_value": "",
  • "attr_res25_label": "",
  • "attr_res25_value": "",
  • "attr_res26_label": "",
  • "attr_res26_value": "",
  • "attr_res27_label": "",
  • "attr_res27_value": "",
  • "attr_res28_label": "",
  • "attr_res28_value": "",
  • "attr_res29_label": "",
  • "attr_res29_value": "",
  • "attr_res30_label": "",
  • "attr_res30_value": ""
  • }
  • ]
  • }

 

予約データを完了する

予約データを完了します。

メソッド

  • PATCH

URL

  • /api/v2/reservations/:reservation_id/complete

リクエストヘッダ

  • Content-Type: application/json; charset=utf-8

リクエスト例

URL

/api/v2/reservations/13529/complete

レスポンス例

ステータスライン / レスポンスヘッダ

  • HTTP/1.1 200 OK
  • Content-Type:application/json;charset=utf-8

レスポンスボディ

  • {
  • "total_number": 1,
  • "position": {
  • "number": 1,
  • "from": 1,
  • "to": 1
  • },
  • "results": [
  • {
  • "reservation_id": 10003,
  • "customer_id": null,
  • "customer_login_id": "",
  • "customer_name": "ゲスト 太郎",
  • "customer_kana": "ゲスト タロウ",
  • "customer_mail": "xxxx@xxxxxxx.jp",
  • "customer_zip": "0129876",
  • "customer_prefecture": "北海道",
  • "customer_address1": "札幌市中央区六条",
  • "customer_address2": "建物のなまえ",
  • "customer_tel": "0112223333",
  • "customer_sex": "男性",
  • "customer_birth_year": 2003,
  • "customer_birth_month": 8,
  • "customer_birth_day": 17,
  • "customer_extension_id": "",
  • "reservation_date": "2023/09/20",
  • "reservation_time": "15:00",
  • "category_id": null,
  • "category_name": "",
  • "main_menu_id": 2,
  • "main_menu_name": "メインメニュー2",
  • "timetable_id": null,
  • "anyone_flg": 0,
  • "sub_menu_id": 3,
  • "sub_menu_name": "サブメニュー3",
  • "equipment_id": null,
  • "equipment_name": "",
  • "staff_id": null,
  • "staff_name": "",
  • "options": [
  • {
  • "option_id": 1,
  • "option_name": "予約オプション8",
  • "option_num": 3,
  • "option_unit": "個"
  • },
  • {
  • "option_id": 2,
  • "option_name": "予約オプション7",
  • "option_num": 15,
  • "option_unit": "枚"
  • },
  • {
  • "option_id": 3,
  • "option_name": "予約オプション6",
  • "option_num": 14,
  • "option_unit": "人"
  • },
  • {
  • "option_id": 4,
  • "option_name": "予約オプション5",
  • "option_num": 18,
  • "option_unit": "台"
  • },
  • {
  • "option_id": 5,
  • "option_name": "予約オプション4",
  • "option_num": 20,
  • "option_unit": "件"
  • },
  • {
  • "option_id": 6,
  • "option_name": "予約オプション3",
  • "option_num": 6,
  • "option_unit": "本"
  • },
  • {
  • "option_id": 7,
  • "option_name": "予約オプション2",
  • "option_num": 4,
  • "option_unit": "席"
  • },
  • {
  • "option_id": 8,
  • "option_name": "予約オプション1",
  • "option_num": 2,
  • "option_unit": "人前"
  • }
  • ],
  • "required_minute": 60,
  • "reservation_number": 4,
  • "amount": 69000,
  • "payment_status": "",
  • "payment_transaction_id": "",
  • "reservation_message": "",
  • "registered_datetime": "2023/09/05 17:22:01",
  • "registered_operation_type": "API",
  • "update_datetime": "2023/09/05 17:22:01",
  • "memo": "",
  • "unfixed_flg": 0,
  • "unfixed_result_flg": 0,
  • "history_flg": 1,
  • "cancel_flg": 1,
  • "cancel_message": "",
  • "block_flg": 0,
  • "cancel_datetime": "2023/09/15 15:35:01",
  • "cancel_guest_code": "ul655mbk9u4h",
  • "online_meeting_info": "",
  • "google_meet_url": "",
  • "zoom_url": "https://us04web.zoom.us/j/xxxxxxxxx?pwd=xxxxxxxxxxxxxxx",
  • "zoom_id": "xxxxxxxxx",
  • "zoom_password": "xxxxxxxxx",
  • "zoom_url_host": "https://us04web.zoom.us/s/xxxxxxxxx?zak=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  • "device": "PC",
  • "ip_address": "192.168.33.1",
  • "attr_orgd1_label": "",
  • "attr_orgd1_value": null,
  • "attr_orgd2_label": "",
  • "attr_orgd2_value": null,
  • "attr_orgd3_label": "",
  • "attr_orgd3_value": null,
  • "attr_orgd4_label": "",
  • "attr_orgd4_value": null,
  • "attr_orgd5_label": "",
  • "attr_orgd5_value": null,
  • "attr_org1_label": "カスタム属性1テキストボックス（１行）",
  • "attr_org1_value": "カスタム属性1テキストボックス（１行）入力内容",
  • "attr_org2_label": "",
  • "attr_org2_value": "",
  • "attr_org3_label": "",
  • "attr_org3_value": "",
  • "attr_org4_label": "",
  • "attr_org4_value": "",
  • "attr_org5_label": "",
  • "attr_org5_value": "",
  • "attr_org6_label": "",
  • "attr_org6_value": "",
  • "attr_org7_label": "",
  • "attr_org7_value": "",
  • "attr_org8_label": "",
  • "attr_org8_value": "",
  • "attr_org9_label": "",
  • "attr_org9_value": "",
  • "attr_org10_label": "",
  • "attr_org10_value": "",
  • "attr_org11_label": "",
  • "attr_org11_value": "",
  • "attr_org12_label": "",
  • "attr_org12_value": "",
  • "attr_org13_label": "",
  • "attr_org13_value": "",
  • "attr_org14_label": "",
  • "attr_org14_value": "",
  • "attr_org15_label": "",
  • "attr_org15_value": "",
  • "attr_org16_label": "",
  • "attr_org16_value": "",
  • "attr_org17_label": "",
  • "attr_org17_value": "",
  • "attr_org18_label": "",
  • "attr_org18_value": "",
  • "attr_org19_label": "",
  • "attr_org19_value": "",
  • "attr_org20_label": "",
  • "attr_org20_value": "",
  • "attr_org21_label": "",
  • "attr_org21_value": "",
  • "attr_org22_label": "",
  • "attr_org22_value": "",
  • "attr_org23_label": "",
  • "attr_org23_value": "",
  • "attr_org24_label": "",
  • "attr_org24_value": "",
  • "attr_org25_label": "",
  • "attr_org25_value": "",
  • "attr_org26_label": "",
  • "attr_org26_value": "",
  • "attr_org27_label": "",
  • "attr_org27_value": "",
  • "attr_org28_label": "",
  • "attr_org28_value": "",
  • "attr_org29_label": "",
  • "attr_org29_value": "",
  • "attr_org30_label": "",
  • "attr_org30_value": "",
  • "attr_res1_label": "予約アンケートテキストボックス(１行)",
  • "attr_res1_value": "予約アンケートテキストボックス",
  • "attr_res2_label": "予約アンケートテキストエリア(複数行)",
  • "attr_res2_value": "予約アンケートテキストエリア１行目\n２行目\n３行目\n４行目",
  • "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
  • "attr_res3_value": "予約アンケートセレクトボックス選択肢4",
  • "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
  • "attr_res4_value": "予約アンケートラジオボタン選択肢3",
  • "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
  • "attr_res5_value": "#予約アンケートチェックボックス選択肢1#",
  • "attr_res6_label": "予約アンケート日付",
  • "attr_res6_value": "2021/11/19",
  • "attr_res7_label": "",
  • "attr_res7_value": "",
  • "attr_res8_label": "",
  • "attr_res8_value": "",
  • "attr_res9_label": "",
  • "attr_res9_value": "",
  • "attr_res10_label": "",
  • "attr_res10_value": "",
  • "attr_res11_label": "",
  • "attr_res11_value": "",
  • "attr_res12_label": "",
  • "attr_res12_value": "",
  • "attr_res13_label": "",
  • "attr_res13_value": "",
  • "attr_res14_label": "",
  • "attr_res14_value": "",
  • "attr_res15_label": "",
  • "attr_res15_value": "",
  • "attr_res16_label": "",
  • "attr_res16_value": "",
  • "attr_res17_label": "",
  • "attr_res17_value": "",
  • "attr_res18_label": "",
  • "attr_res18_value": "",
  • "attr_res19_label": "",
  • "attr_res19_value": "",
  • "attr_res20_label": "",
  • "attr_res20_value": "",
  • "attr_res21_label": "",
  • "attr_res21_value": "",
  • "attr_res22_label": "",
  • "attr_res22_value": "",
  • "attr_res23_label": "",
  • "attr_res23_value": "",
  • "attr_res24_label": "",
  • "attr_res24_value": "",
  • "attr_res25_label": "",
  • "attr_res25_value": "",
  • "attr_res26_label": "",
  • "attr_res26_value": "",
  • "attr_res27_label": "",
  • "attr_res27_value": "",
  • "attr_res28_label": "",
  • "attr_res28_value": "",
  • "attr_res29_label": "",
  • "attr_res29_value": "",
  • "attr_res30_label": "",
  • "attr_res30_value": ""
  • }
  • ]
  • }

 

      • Related Articles

      • Webhook

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ Webhook β版について Webhookはβ版として公開中です。 正式版に向けて、お客様からのフィードバックを参考に改善を進めていきます。ぜひご意見・ご要望をお寄せください。 β版のご利用にあたって β版は開発中の機能のため、以下の点にご注意ください。 ・仕様変更の可能性：正式版公開時に仕様が大きく変更になる場合があります。 ・サポートの制限：β版に関するサポートは限定的となる場合があります。 Webhookについて ...

      • 予約データの取得

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ 参照系API：予約データ 予約データの必要な情報だけを取得できます。 取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。 ※offsetは0が初期値となります。例：101行目からのデータを取得する場合はoffsetに100を指定します。 メソッド GET URL /api/v2/reservations クエリパラメータ パラメータ名 説明 型 例 補足 ...

      • 予約メニュー | カテゴリの取得

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/categories クエリパラメータ ...

      • 予約メニュー | 予約オプションの取得

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/options クエリパラメータ ...

      • 予約メニュー | 予約アンケートの取得

        時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/attr_res クエリパラメータ ...