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

ご契約と料金に関して

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

メソッド

• GET

URL

• /api/v2/options

クエリパラメータ

レスポンス例

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

• 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を指定します。