-
時間タイプ
-
スクールタイプ
-
会議室タイプ
-
イベントタイプ
ご契約と料金に関して
ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。
尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。
メソッド
URL
クエリパラメータ
| パラメータ名 |
型 |
設定 |
説明 |
| offset |
数値 |
任意 |
取得データ開始位置(初期値:0) |
| count |
数値 |
任意 |
データ取得件数(初期値:100・最大値:100) |
| option_id |
数値 |
任意 |
予約オプションID |
| enable_flg |
数値 |
任意 |
ステータス(1:有効、2:無効) |
| registered_datetime_from |
日付 |
任意 |
登録日時From(yyyy/mm/dd HH:mm:ss 形式) |
| registered_datetime_to |
日付 |
任意 |
登録日時To(yyyy/mm/dd HH:mm:ss 形式) |
| update_datetime_from |
日付 |
任意 |
最終更新日時From(yyyy/mm/dd HH:mm:ss 形式) |
| update_datetime_to |
日付 |
任意 |
最終更新日時To(yyyy/mm/dd HH:mm:ss 形式) |
レスポンス例
ステータスライン / レスポンスヘッダ
- HTTP/1.1 200 OK
- Content-Type:application/json;charset=utf-8
レスポンスボディ
- {
-
"total_number": 4,
-
"position": {
-
"number": 4,
-
"from": 1,
-
"to": 4
- },
-
"results": [
- {
-
"option_id": 1,
-
"option_name": "オプション1",
-
"enable_flg": 1,
-
"kind_flg": 1,
-
"required_flg": 2,
-
"stock_number": 999,
-
"min_number": 1,
-
"max_number": 20,
-
"unit": "個",
-
"price": 500,
-
"form_order": 1,
-
"registered_datetime": "2023/05/19 10:49:47",
-
"update_datetime": "2023/06/08 15:58:09"
- },
- {
-
"option_id": 2,
-
"option_name": "オプション2",
-
"enable_flg": 1,
-
"kind_flg": 1,
-
"required_flg": 2,
-
"stock_number": 999,
-
"min_number": 0,
-
"max_number": 0,
-
"unit": "",
-
"price": 0,
-
"form_order": 2,
-
"registered_datetime": "2023/05/19 10:50:17",
-
"update_datetime": "2023/05/31 16:02:37"
- }
- ・・・
- ]
- }
予約オプション 取得項目
取得件数は1リクエストあたり最大100件となりますが、offset を利用し複数回のリクエストをする事で全件の取得が可能です。
※offsetは0が初期値となります。例:101行目からのデータを取得する場合はoffsetに100を指定します。
| キー |
説明 |
型 |
例 |
補足 |
| total_number |
対象件数 |
数値 |
150 |
|
| number |
取得件数 |
数値 |
100 |
|
| from |
開始行 |
数値 |
1 |
|
| to |
終了行 |
数値 |
100 |
|
| option_id |
予約オプションID |
数値 |
1 |
|
| option_name |
予約オプション名 |
文字列 |
予約オプション1 |
|
| enable_flg |
ステータス |
数値 |
1 |
1:有効 / 2:無効 |
| kind_flg |
種別 |
数値 |
1 |
1:通常 / 2:団体予約と連動 / 3:在庫管理 |
| required_flg |
入力条件 |
数値 |
1 |
1:必須入力 / 2:任意入力 |
| stock_number |
数量 |
数値 |
1 |
|
| min_number |
選択可能数 最小 |
数値 |
1 |
|
| max_number |
選択可能数 最大 |
数値 |
5 |
|
| unit |
単位 |
文字列 |
個 |
|
| price |
料金単価 |
数値 |
1500 |
|
| form_order |
表示順 |
数値 |
1 |
|
| registered_datetime |
登録日時 |
日付 |
2023/05/15 10:47:41 |
yyyy/mm/dd HH:mm:ss 形式 |
| update_datetime |
最終更新日時 |
日付 |
2023/05/24 15:16:59 |
yyyy/mm/dd HH:mm:ss 形式 |
Related Articles
予約メニュー | カテゴリの取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/categories クエリパラメータ ...
予約メニュー | 予約アンケートの取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/attr_res クエリパラメータ ...
予約メニュー|メインメニューの取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/mainmenus クエリパラメータ ...
予約メニュー | 対応予約アンケート(メインメニュー)の取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL ...
予約メニュー | 対応予約オプション(メインメニュー)の取得
時間タイプ スクールタイプ 会議室タイプ イベントタイプ ご契約と料金に関して ChoiceRESERVE APIをご利用になるには、ChoiceRESERVEのご契約に加え有償オプションのお申し込みが必要となります。また、参照系APIは予約データ、予約メニュー、時間割(スクールタイプのみ)と3種類あり、それぞれでご契約が必要です。 尚、ご契約前にAPIをお試しされたい場合や料金についてはお問い合わせください。 メソッド GET URL /api/v2/main_option_relations ...