予約詳細(複数取得)

※最大30件の予約詳細を取得します。
取得対象の予約情報が多く、まとめて予約詳細を取得したい時にご使用ください。

{{method}} {{url}}
アクセストークン
項目 フィールド名 データ型 パラメータ設定
予約ID(Staysee上のID) ids 必須 int

最大30件まで指定可能(カンマ区切り)

子要素 children string

追加で出力する子要素設定(カンマ区切り)
未設定時はallocate_rooms
設定可能リスト
none:追加で出力しない(他の要素と併用不可)
allocate_rooms:部屋割当情報
reservation_members:代表者を含む同行者情報
reservation_regular_products:宿泊基本商品情報
reservation_optional_products:その他商品情報
reservation_payments:入金情報
reservation_days:予約の日毎の情報
agent:扱先情報
package:企画情報

追加項目 additional string

追加で出力する項目設定(カンマ区切り)
設定可能リスト
free_comment:予約情報のフリーコメント
custom_field:追加保存項目(利用者情報の項目追加設定にて、利用中のフィールドのみ返却されます)

{{curl_command}}
出力結果
[
  {
    "id": 2699974,                        // 予約ID(Staysee上のID)
    "booking_number": "A12346EXAMPLE",    // 予約番号
    "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": "5510001",                           // 郵便番号
    "address": "大阪府大阪市大正区三軒家西XXX番地",  // 住所
    "start_date": "2023-08-15",                      // 宿泊開始日
    "end_date": "2023-08-16",                        // 宿泊終了日
    "check_in_time": "18:00",                        // 時刻(時刻形式でない場合やデータが存在しない場合は00:00で返却されます)
    "check_out_time": "10:00",                       // 時刻(時刻形式でない場合やデータが存在しない場合は23:59で返却されます)
    "check_in_date_time": "2023-08-15 18:00",        // 宿泊開始日時
    "check_out_date_time": "2023-08-16 10: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": "1892",                       // 消費税
    "payment_amount": "20000",                       // 入金金額
    "billing_amount": "1300",                        // 請求金額[(total_price + bath_tax + accommodation_tax) - payment_amount]
    "created_at": "2023-06-28 16:49:45",             // 予約作成日時
    "updated_at": "2023-06-28 17:01:14",             // 予約更新日時
    "free_comment": "奥様誕生日",                    // フリーコメント(additional指定時のみ追加)
    "custom_field_1": "タロウ",                      // 追加保存項目(利用者情報のみ)項目タイトル1(additional指定時のみ追加)
    "custom_field_2": "2",                           // 追加保存項目(利用者情報のみ)項目タイトル2(additional指定時のみ追加)
    "custom_field_3": "",                            // 追加保存項目(利用者情報のみ)項目タイトル3(additional指定時のみ追加)
    "custom_field_4": "",                            // 追加保存項目(利用者情報のみ)項目タイトル4(additional指定時のみ追加)
    "custom_field_5": "",                            // 追加保存項目(利用者情報のみ)項目タイトル5(additional指定時のみ追加)
    "custom_field_6": "",                            // 追加保存項目(利用者情報のみ)項目タイトル6(additional指定時のみ追加)
    "checkin_field_1": "スノーボード",               // 追加保存項目(利用者情報・チェックインカード)タイトル1(additional指定時のみ追加)
    "checkin_field_2": "",                           // 追加保存項目(利用者情報・チェックインカード)タイトル2(additional指定時のみ追加)
    "checkin_field_3": "",                           // 追加保存項目(利用者情報・チェックインカード)タイトル3(additional指定時のみ追加)
    "checkin_field_4": "",                           // 追加保存項目(利用者情報・チェックインカード)タイトル4(additional指定時のみ追加)
    "checkin_remarks": "テキストテキストテキストテキストテキスト",     // 備考欄(additional指定時のみ追加)
    "allocate_rooms": [                              // 割当部屋
      {
        "room_id": 1,                                // 部屋ID
        "date": "2023-08-15",                        // 割当日
        "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                          // 布団
      }
    ],
    "reservation_members": [
      {
        "id": 109388,                                       // 予約同行者ID
        "member_type": 1,                                   // 1:代表者 または 2:同行者
        "member_type_string": "代表者",                     // 代表者 または 同行者
        "name": "宿泊太郎",                                 // 名前
        "sex": 1,                                           // 性別(0=未設定,1=男性,2=女性,3=その他)
        "sex_string": "男性",                               // 性別文字列(空白、男性、女性、不明)
        "occupation": "営業事務",                           // 職業
        "address": "大阪府大阪市大正区三軒家西XXX番地",     // 住所
        // 顔写真 一定期間後閲覧できなくなります
        "face_url": "https://xxxxx.example.com/uploads/xxxxx_staysee_com/1/attachments/202111/28240.jpg?t=20211110184228&s=XXXXXXXXXXXX&e=1605005075",
        // 身分証明書 一定期間後閲覧できなくなります
        "passport_url": "https://xxxxx.example.com/uploads/xxxxx_staysee_com/1/attachments/202111/28241.png?t=20211110184228&s=YYYYYYYYYYYY&e=1605005075",
        "nationality": "日本",                              // 国籍
        "passport_no": "123450000",                         // 旅券番号
        "previous_place": "大阪",                           // 前宿泊地
        "next_destination": "大阪",                         // 次宿泊地
        "arrival_time": "18:00",                            // 到着日時
        "departure_time": "10:00",                          // 出発日時
        "age": 30,                                          // 年齢
        "tel1": 12345678900,                                // 電話番号
        "zip_code": 1234567,                                // 郵便番号
        "place": "大阪府"                                   // 発信地
      },
      {
        "id": 109389,
        "member_type": 2,
        "member_type_string": "同行者",
        "name": "宿泊花子",
        "sex": 2,
        "sex_string": "女性",
        "occupation": "主婦",
        "address": "大阪府大阪市大正区三軒家西XXX番地",
        "face_url": "",
        "passport_url": "",
        "nationality": "",
        "passport_no": "",
        "previous_place": "自宅",
        "next_destination": "岐阜県",
        "arrival_time": "20:00",
        "departure_time": "11:00"
      }
    ],
    "reservation_regular_products": [         // 宿泊基本商品
      {
        "id": 3044211,                        // 予約宿泊基本商品ID
        "page": 1,                            // 領収書ページ数
        "date": "2023-08-15",                 // 対象日付
        "regular_product_id": 1575,           // 宿泊基本商品ID
        "name": "1泊夕朝食付き",              // 宿泊基本商品名
        "notation_name": "宿泊",              // 領収書表記名
        "unit_price": "10000",                // 宿泊基本商品単価
        "number": 2,                          // 人数
        "tax_rate": "0.1",                    // 消費税率
        "consumption_tax": "1818",            // 消費税
        "bath_tax": "300",                    // 入湯税
        "accommodation_tax": "0",             // 宿泊税
        "total_price": "20000",               // 小計(消費税含む,入湯税宿泊税含まず)
        "dinner_product_id": 1,               // 料理品目(夕食)マスタID
        "breakfast_product_id": 2,            // 料理品目(朝食)マスタID
        "lunch_product_id": 0                 // 料理品目(昼食)マスタID
      }
    ],
    "reservation_optional_products": [        // その他商品
      {
        "id": 3049935,                        // 予約その他商品ID
        "page": 1,                            // 領収書ページ数
        "date": "2023-08-15",                 // 対象日付
        "optional_product_id": 3642,          // その他商品ID
        "name": "お土産",                     // その他商品名
        "notation_name": "お土産",            // 領収書表記名
        "unit_price": "1000",                 // 宿泊基本商品単価
        "number": 1,                          // 数量
        "tax_rate": "0.08",                   // 消費税率
        "consumption_tax": "74",              // 消費税
        "total_price": "1000"                 // 小計(消費税含む)
      }
    ],
    "reservation_payments": [                 // 入金情報
      {
        "id": 1510194,                        // 予約入金ID
        "page": 1,                            // 領収書ページ数
        "date": "2023-08-15",                 // 対象日付
        "payment_id": 13752,                  // 金種ID
        "name": "前受金(ネット)",             // 金種名
        "notation_name": "前受金(ネット)",    // 領収書表記名
        "payment_amount": "20000",            // 入金金額
        "payment_kind": 7,                    // 金種区分(1=現金,2=クレジットカード,3=クーポン,4=ポイント,5=売掛金,7=前受金,8=電子マネー,9=その他)
        "payment_receipt_display": 1          // 金種領収書への表示(0=表示しない,1=表示する)
      }
    ],
    "reservation_days": [                     // 予約の日毎の情報
      {
        "date": "2023-08-15",                 // 対象日付
        "dinner_time": "17:00",               // 夕食時間
        "breakfast_time": "07:00",            // 朝食時間
        "lunch_time": ""                      // 昼食時間
      }
    ],
    "agent": {                                // 扱先情報
      "agent_id": 1,                          // 扱先ID
      "agent_name": "ステイシー観光"          // 扱先名
    },
    "package": {                              // 企画情報
      "id": 1,                                // 企画ID
      "name": "GW特別会席プラン"              // 企画名
    }
  },
  {
    "id": 47700,
    "booking_number": "ABCDEFGH111",
    "status": 4,
    "name_kanji": "宿泊二郎",
    "name_kana": "しゅくはくじろう",
    "tel": "090-0000-0000",
    "email": "",
    "zip_code": "5520021",
    "address": "大阪府大阪市港区築港xxx番地",
    "start_date": "2023-07-26",
    "end_date": "2023-07-27",
    "check_in_time": "00:00",
    "check_out_time": "23:59",
    "check_in_date_time": "2023-07-26 00:00",
    "check_out_date_time": "2023-07-27 23:59",
    "canceled": false,
    "canceled_at": null,
    "paid": false,
    "send_news": 1,
    "person_number": 1,
    "adult_number": 1,
    "man_number": 1,
    "woman_number": 0,
    "child_number": 0,
    "front_remarks": "",
    "food_remarks": "",
    "accounting_remarks": "",
    "total_price": "1100",
    "bath_tax": "0",
    "accommodation_tax": "0",
    "consumption_tax": "100",
    "payment_amount": "1000",
    "billing_amount": "100",
    "created_at": "2023-07-26 11:37:03",
    "updated_at": "2023-07-26 11:39:56",
    "free_comment": "",
    "allocate_rooms": [
      {
        "room_id": 20,
        "date": "2023-07-26",
        "adult_number": 1,
        "child_number": 0,
        "man_number": 0,
        "woman_number": 0,
        "unknown_number": 1,
        "child_a_number": 0,
        "child_b_number": 0,
        "child_c_number": 0,
        "child_d_number": 0,
        "child_o_number": 0,
        "bedding_number": 1
      }
    ],
    "reservation_members": [
      {
        "id": 35,
        "member_type": 1,
        "member_type_string": "代表者",
        "name": "宿泊二郎",
        "sex": 0,
        "sex_string": "",
        "occupation": "",
        "address": "大阪府大阪市港区築港xxx番地",
        "face_url": "",
        "passport_url": "",
        "nationality": "",
        "passport_no": "",
        "previous_place": "",
        "next_destination": "",
        "arrival_time": "",
        "departure_time": "",
        "age": "",
        "tel1": "",
        "zip_code": "5520021",
        "place": "大阪府"
      }
    ],
    "reservation_regular_products": [
      {
        "id": 47868,
        "date": "2023-07-26",
        "regular_product_id": 33,
        "name": "1泊夕食(大人)",
        "notation_name": "1泊夕食(大人)",
        "unit_price": "1000",
        "number": 1,
        "tax_rate": "0.1",
        "consumption_tax": "91",
        "bath_tax": "0",
        "accommodation_tax": "0",
        "total_price": "1000",
        "dinner_product_id": 1,
        "breakfast_product_id": 0,
        "lunch_product_id": 0
      }
    ],
    "reservation_optional_products": [
      {
        "id": 104,
        "date": "2023-07-26",
        "optional_product_id": 28,
        "name": "花束代",
        "notation_name": "花束代",
        "unit_price": "100",
        "number": 1,
        "tax_rate": "0.1",
        "consumption_tax": "9",
        "total_price": "100"
      }
    ],
    "reservation_payments": [
      {
        "id": 46770,
        "date": "2023-07-26",
        "payment_id": 1,
        "name": "現金",
        "notation_name": "現金",
        "payment_amount": 1000,
        "payment_kind": 1,
        "payment_receipt_display": 1
      }
    ],
    "reservation_days": [
      {
        "date": "2023-07-26",
        "dinner_time": "17:00",
        "breakfast_time": "",
        "lunch_time": ""
      }
    ],
    "agent": {
      "agent_id": "",
      "agent_name": ""
    },
    "package": {
      "id": "",
      "name": ""
    }
  }
]
エラー時出力結果
{
  "message": "Not Found",
  "errors": [
    {
      "message": "対象の予約は存在しません"
    }
  ]
}
{
  "message": "The given data was invalid.",
  "errors": [
    {
      "children": [
        "子要素は「none,allocate_rooms,reservation_members,reservation_regular_products,reservation_optional_products,reservation_payments,regular_products,optional_products,payments」以外設定できません"
      ]
    }
  ]
}
{
  "message": "The given data was invalid.",
  "errors": [
    {
      "ids": [
        "予約IDは10個以下指定してください。"
      ]
    }
  ]
}