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

参照系API：予約データ

予約データの必要な情報だけを取得できます。
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例：101行目からのデータを取得する場合はoffsetに100を指定します。

メソッド

• GET

URL

• /api/v2/reservations

クエリパラメータ

※1 block_flg（予約ブロックフラグ）について
値（1）をセットすると、予約ブロックされたレコードを含む予約データがレスポンス対象となります。（予約ブロックされたレコードのみをレスポンスとするパラメータではありません。）

※2 fields（取得項目）について
未指定の場合はすべての項目を返します。
「reservation_id」は必ず返します。「options」の詳細項目は指定できません。
スペースは含めないでください。

レスポンス例

レスポンスヘッダ

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

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

レスポンスボディ

• {
• "total_number": 2,
• "position": {
• "number":2,
• "from":1,
• "to":2
• },
• "results": [
• {
• "reservation_id": 10001,
• "customer_id": null,
• "customer_login_id": "user_login",
• "customer_name": "user_name",
• "customer_kana": "string",
• "customer_mail": "xxx@xxxx.jp",
• "customer_zip": "string",
• "customer_prefecture": "",
• "customer_address1": "",
• "customer_address2": "",
• "customer_tel": "",
• "customer_sex": "",
• "customer_birth_year": null,
• "customer_birth_month": null,
• "customer_birth_day": null,
• "customer_extension_id": "",
• "reservation_date": "2021/12/01",
• "reservation_time": "12:00",
• "category_id": null,
• "category_name": "",
• "main_menu_id": 1,
• "main_menu_name": "メインメニュー",
• "timetable_id": null,
• "anyone_flg": 0,
• "sub_menu_id": 1,
• "sub_menu_name": "サブメニュー",
• "equipment_id": null,
• "equipment_name": "",
• "staff_id": null,
• "staff_name": "",
• "options": [],
• "required_minute": 60,
• "reservation_number": 1,
• "amount": 0,
• "payment_status": "",
• "payment_transaction_id": "",
• "reservation_message": "",
• "registered_datetime": "2021/11/25 12:47:00",
• "registered_operation_type": "予約サイト",
• "update_datetime": "2021/11/25 12:47:00",
• "memo": "",
• "unfixed_flg": 0,
• "unfixed_result_flg": 1,
• "history_flg": 0,
• "cancel_flg": 0,
• "cancel_message": "",
• "block_flg": 0,
• "cancel_datetime": null,
• "cancel_guest_code": "",
• "online_meeting_info": "",
• "google_event_id": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
• "google_meet_url": "https://meet.google.com/xxxxxxxxxxxx",
• "zoom_url": "",
• "zoom_id": "",
• "zoom_password": "",
• "zoom_url_host": "",
• "device": "スマホ",
• "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": "",
• "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": "",
• "attr_res3_label": "予約アンケートセレクトボックス(択一選択)",
• "attr_res3_value": "",
• "attr_res4_label": "予約アンケートラジオボタン（択一チェック）",
• "attr_res4_value": "",
• "attr_res5_label": "予約アンケートチェックボックス(複数選択)",
• "attr_res5_value": "",
• "attr_res6_label": "予約アンケート日付",
• "attr_res6_value": "",
• "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": ""
• },
• {
• "reservation_id": 10002,
• "customer_id": null,
• "customer_login_id": "",
• "customer_name": "ゲスト 太郎",
• "customer_kana": "ゲスト タロウ",
• "customer_mail": "xxxx@xxxxxx.jp",
• "customer_zip": "",
• "customer_prefecture": "",
• "customer_address1": "",
• "customer_address2": "",
• "customer_tel": "",
• "customer_sex": "",
• "customer_birth_year": null,
• "customer_birth_month": null,
• "customer_birth_day": null,
• "customer_extension_id": "",
• "reservation_date": "2021/11/28",
• "reservation_time": "10: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": 8,
• "option_name": "予約オプション1",
• "option_num": 2,
• "option_unit": "人前"
• },
• {
• "option_id": 7,
• "option_name": "予約オプション2",
• "option_num": 4,
• "option_unit": "席"
• }
• ],
• "required_minute": 60,
• "reservation_number": 4,
• "amount": 17250,
• "payment_status": "",
• "payment_transaction_id": "",
• "reservation_message": "",
• "registered_datetime": "2021/11/25 12:47:00",
• "registered_operation_type": "予約サイト",
• "update_datetime": "2021/11/25 12:47:00",
• "memo": "",
• "unfixed_flg": 0,
• "history_flg": 0,
• "cancel_flg": 0,
• "cancel_message": "",
• "block_flg": 0,
• "cancel_datetime": null,
• "cancel_guest_code": "jixphi649bt9",
• "online_meeting_info": "",
• "google_event_id": "",
• "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=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
• "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#予約アンケートチェックボックス選択肢2#予約アンケートチェックボックス選択肢3#",
• "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": ""
• }
• ]
• }

予約データ取得項目

キャンセル待ちデータ

キャンセル待ちリストを取得します。

メソッド

• GET

URL

• /api/v2/waitlists

クエリパラメータ

レスポンス例

レスポンスヘッダ

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

レスポンスボディ

• {
• "total_number": 2,
• "position": {
• "number":2,
• "from":1,
• "to":2
• },
• "results": [
• {
• "reservation_id": 10015,
• "customer_mail": "xxxxxxxxxxx@example.com",
• "customer_extension_id": "",
• "reservation_date": "2025/05/04",
• "reservation_time": "11:00",
• "category_id": null,
• "category_name": "",
• "main_menu_id": 4,
• "main_menu_name": "メインメニュー4",
• "timetable_id": null,
• "sub_menu_id": 1,
• "sub_menu_name": "サブメニュー1",
• "staff_id": null,
• "staff_name": "",
• "options": [],
• "required_minute": 60,
• "registered_datetime": "2025/05/01 14:22:13",
• "update_datetime": "2025/05/01 14:22:13",
• "device": "PC",
• "notified_flg": 1,
• "notified_datetime": "2025/05/02 14:25:39"
• },
• {
• "reservation_id": 10016,
• "customer_mail": "xxxxxxxxxxx@example.com",
• "customer_extension_id": "",
• "reservation_date": "2025/05/05",
• "reservation_time": "14:00",
• "category_id": null,
• "category_name": "",
• "main_menu_id": 4,
• "main_menu_name": "メインメニュー4",
• "timetable_id": null,
• "sub_menu_id": 2,
• "sub_menu_name": "サブメニュー2",
• "staff_id": null,
• "staff_name": "",
• "options": [],
• "required_minute": 60,
• "registered_datetime": "2025/05/01 14:22:40",
• "update_datetime": "2025/05/01 14:22:40",
• "device": "PC",
• "notified_flg": 0,
• "notified_datetime": null
• }
• ]
• }

キャンセル待ちデータ取得項目

ご契約と料金に関して

ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系・更新系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と4種類あり、それぞれでご契約が必要です。

尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。