予約一覧

{{method}} {{url}}
アクセストークン
項目 フィールド名 データ型 パラメータ設定
検索方法 search_type string

検索方法の設定
未設定時はstart_date
設定可能リスト
start_date:宿泊開始日を基準に予約を検索
stay_date:宿泊中の予約を検索

日付 date date

未設定時は本日(2026-04-28)

終了日付 until_date date

未設定時は日付(date)と同じ

32日を超える日数は設定できません

更新日時 updated_time datetime

設定時は更新日時(Y-m-d H:i:s)以降に
作成また更新された予約のみ取得します

予約番号 booking_number string
部屋ID room_id int
名前 name string
電話番号 tel string
子要素 children string

追加で出力する子要素設定(カンマ区切り)
未設定時はallocate_rooms
設定可能リスト
none:追加で出力しない(他の要素と併用不可)
allocate_rooms:部屋割当情報
package:企画情報

{{curl_command}}
出力結果
[
  {
    "id": 2050244,                        // 予約ID(Staysee上のID)
    "booking_number": "A12345EXAMPLE",    // 予約番号
    "status": 4,                          // 予約ステータス(下記参照:現状は領収書発行済み状態と予約状態を区別できません)
    /*
        10 => インポート
        1  => 未設定
        2  => 仮予約
        3  => 未確認
        4  => 予約確定
        13 => 日帰り確定
        11 => 部屋確定
        12 => 重要
        5  => チェックイン
        6  => 領収書発行済み
        7  => チェックアウト
        14 => 空部屋
        15 => 販売不可
        9  => キャンセル
    */
    "name_kanji": "宿泊太郎",             // 利用者名(漢字)
    "name_kana": "しゅくはくたろう",      // 利用者名(かな)
    "tel": "090-0001-0001",               // 電話番号
    "email": "syukuhaku@example.com",     // メールアドレス
    "zip_code": "123-0001",               // 郵便番号
    "address": "大阪府大阪市XXX区X番地",  // 住所
    "start_date": "2023-01-16",           // 宿泊開始日
    "end_date": "2023-01-17",             // 宿泊終了日
    "check_in_time": "18:00",                   // 時刻(時刻形式でない場合やデータが存在しない場合は00:00で返却されます)
    "check_out_time": "20:00",                  // 時刻(時刻形式でない場合やデータが存在しない場合は23:59で返却されます)
    "check_in_date_time": "2023-01-16 18:00",   // 宿泊開始日時
    "check_out_date_time": "2023-01-17 20:00",  // 宿泊終了日時
    "canceled": false,                    // true = キャンセルされた予約 false = キャンセルされていない予約
    "canceled_at": null,                  // キャンセル日時(キャンセルでない場合はnull)
    "paid": false,                        // true = 精算済み false = 未精算
    "send_news": 1,                       // お知らせ送付 0 = 無回答 1 = はい 2 = いいえ
    "person_number": 2,                   // 利用者人数
    "adult_number": 2,                    // 大人人数
    "man_number": 1,                      // 大人男人数
    "woman_number": 1,                    // 大人女人数
    "child_number": 0,                    // 子供人数
    "front_remarks": "フロント備考、フロント備考、フロント備考、フロント備考、フロント備考",          // フロント用備考
    "food_remarks": "飲食備考、飲食備考、飲食備考、飲食備考、飲食備考、飲食備考、飲食備考、飲食備考", // 飲食備考
    "accounting_remarks": "会計備考、会計備考、会計備考、会計備考、会計備考、会計備考",               // 会計備考
    "cleaning_remarks": "予約清掃備考、予約清掃備考、予約清掃備考、予約清掃備考、予約清掃備考",       // 予約清掃備考
    "total_price": "21000",               // 合計[基本商品+その他商品](消費税含む,入湯税宿泊税含まず)
    "bath_tax": "300",                    // 入湯税
    "accommodation_tax": "0",             // 宿泊税
    "consumption_tax": "1908",            // 消費税
    "payment_amount": "21000",            // 入金金額
    "billing_amount": "300",              // 請求金額[(total_price + bath_tax + accommodation_tax) - payment_amount]
    "created_at": "2023-01-16 16:26:50",  // 予約作成日時
    "updated_at": "2023-01-16 16:29:18",  // 予約更新日時
    "allocate_rooms": [                   // 割当部屋
      {
        "room_id": 1,                     // 部屋ID
        "date": "2023-01-16",             // 割当日
        "adult_number": 2,                // 大人人数
        "child_number": 0,                // 子供人数
        "man_number": 1,                  // 男性人数
        "woman_number": 1,                // 女性人数
        "unknown_number": 0,              // 性別不明人数
        "child_a_number": 0,              // 子供A人数
        "child_b_number": 0,              // 子供B人数
        "child_c_number": 0,              // 子供C人数
        "child_d_number": 0,              // 子供D人数
        "child_o_number": 0,              // 子供その他人数
        "bedding_number": 2               // 布団
      }
    ],
    "package": {                        // 企画情報
      "id": 1,                          // 企画ID
      "name": "GW特別会席プラン"        // 企画名
    }
  }
]
エラー時出力結果
{
  "message": "The given data was invalid.",
  "errors": [
    {
      "date": [
        "日付はY-m-d形式で指定してください。"
      ]
    }
  ]
}