Download OpenAPI specification:Download
suitebook API for third party developers
予約の状態が変更になった際のWebhook通知です。
type | string Enum: "reservation_acceptance_confirmation" "reservation_alteration_confirmation" "reservation_cancellation_confirmation" "reservation_checked_in" "reservation_checked_out" 通知イベント
|
version | string Value: "v1" バージョン |
object (Reservation) 予約 |
{- "type": "reservation_acceptance_confirmation",
- "version": "v1",
- "reservation": {
- "id": 0,
- "building": {
- "id": 0,
- "name": "string"
}, - "listingId": 0,
- "listing": {
- "id": 0,
- "propertyName": "string"
}, - "listingRoomId": 0,
- "listingRoom": {
- "id": 0,
- "name": "string"
}, - "confirmationCode": "string",
- "checkInDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutDate": "2019-08-24",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "numberOfGuests": 0,
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "isCancelled": true,
- "isSelfCleaning": true,
- "isClosed": true,
- "platform": 1,
- "channel": 0,
- "channelName": "string",
- "otherServiceInformation": "string",
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "planGroup": {
- "code": "string",
- "name": "string"
}, - "contractType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "cancelledAt": "2019-08-24T14:15:22Z",
- "qrCode": "string",
- "qrCodeUrls": [
- {
- "url": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
], - "qrCodeListUrl": "string",
- "primaryReservationId": 0,
- "payment": "string",
- "redirectionUrlAfterPayment": "string",
- "advancedCheckedInGuestUrl": "string",
- "guest": {
- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}, - "payout": {
- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}, - "account": {
- "totalSalesPriceExcludingTax": 0,
- "totalSalesPrice": 0,
- "totalConsumptionTax": 0,
- "totalPayment": 0,
- "receivable": 0,
- "isPaid": true
}, - "paymentUrls": [
- {
- "type": "takemepay",
- "url": "string",
- "title": "string",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiredAt": "2019-08-24T14:15:22Z"
}
], - "smartLockCodes": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "type": "igloohome",
- "code": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
]
}
}
在庫の状況が変更になった際のWebhook通知です。
type | string Value: "inventories_alteration_confirmation" 通知イベント
|
version | string Value: "v1" バージョン |
object (Inventories) |
{- "type": "inventories_alteration_confirmation",
- "version": "v1",
- "reservation": {
- "listingId": 0,
- "days": [
- {
- "date": "2019-08-24",
- "available": 0,
- "comment": "string"
}
]
}
}
予約の一覧を取得します。
offset | integer 開始位置
|
limit | integer 取得件数
|
check_in_date_from | string <date> チェックイン日( |
check_in_date_to | string <date> チェックイン日( |
check_out_date_from | string <date> チェックアウト日( |
check_out_date_to | string <date> チェックアウト日( |
create_date_from | string <date> 予約作成日( |
create_date_to | string <date> 予約作成日( |
update_date_from | string <date> 予約更新日( |
update_date_to | string <date> 予約更新日( |
channel | integer 予約経路 |
confirmation_code | string 予約コード(完全一致) |
confirmation_code_startswith | string >= 5 characters 予約コード(前方部分一致) |
is_cancelled | boolean キャンセル済みかどうか |
is_checked_in | boolean チェックイン済みかどうか |
is_checked_out | boolean チェックアウト済みかどうか |
building_id | integer 施設ID |
listing_id | integer 物件ID |
listing_room_id | integer 部屋ID |
listing_room_name | string 部屋名(完全一致) |
guest_name_kana_alphabet | string ゲスト名フリガナ
|
phone_endswith | string >= 8 characters 代表者電話番号
|
customer_phone_endswith | string >= 8 characters 顧客電話番号
|
string <email> 代表者メールアドレス(完全一致) | |
customer_email | string <email> 顧客メールアドレス(完全一致) |
order | string Enum: "created_at" "-created_at" "updated_at" "-updated_at" "cancelled_at" "-cancelled_at" "listing_id" "-listing_id" "check_in_date" "-check_in_date" "check_out_date" "-check_out_date" 並べ替えの順番
|
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "building": {
- "id": 0,
- "name": "string"
}, - "listingId": 0,
- "listing": {
- "id": 0,
- "propertyName": "string"
}, - "listingRoomId": 0,
- "listingRoom": {
- "id": 0,
- "name": "string"
}, - "confirmationCode": "string",
- "checkInDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutDate": "2019-08-24",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "numberOfGuests": 0,
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "isCancelled": true,
- "isSelfCleaning": true,
- "isClosed": true,
- "platform": 1,
- "channel": 0,
- "channelName": "string",
- "otherServiceInformation": "string",
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "planGroup": {
- "code": "string",
- "name": "string"
}, - "contractType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "cancelledAt": "2019-08-24T14:15:22Z",
- "qrCode": "string",
- "qrCodeUrls": [
- {
- "url": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
], - "qrCodeListUrl": "string",
- "primaryReservationId": 0,
- "payment": "string",
- "redirectionUrlAfterPayment": "string",
- "advancedCheckedInGuestUrl": "string",
- "guest": {
- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}, - "payout": {
- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}, - "account": {
- "totalSalesPriceExcludingTax": 0,
- "totalSalesPrice": 0,
- "totalConsumptionTax": 0,
- "totalPayment": 0,
- "receivable": 0,
- "isPaid": true
}, - "paymentUrls": [
- {
- "type": "takemepay",
- "url": "string",
- "title": "string",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiredAt": "2019-08-24T14:15:22Z"
}
], - "smartLockCodes": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "type": "igloohome",
- "code": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
]
}
]
}
新しい予約を作成します。
listingId required | integer 物件ID |
primaryReservationId | integer or null 本予約ID(複数部屋予約時のみ適用) |
checkInDate required | string <date> チェックイン日( |
checkOutDate required | string <date> チェックアウト日( |
checkInTime | string or null チェックイン予定時間( |
checkInTimeStr | string or null 予約サイトで登録されたチェックイン予定時間 チェックインが25時の場合: |
checkOutTime | string or null チェックアウト予定時間( |
channel required | integer 予約チャネル |
confirmationCode | string [ 5 .. 32 ] characters 予約コード(指定が無い場合は自動生成) |
currencyCode required | string 通貨コード(
|
basePrice required | number 宿泊料金 |
extrasPrice | number 清掃料金
|
serviceFee | number 予約手数料
|
userUsePoints | number ポイント使用料
|
payment | string 決済手段 |
guestFullName required | string 代表者の名前 |
guestFullNameFurigana | string 代表者のフリガナ
|
guestEmail | string <email> 代表者のメールアドレス |
guestPhone | string 代表者の電話番号 |
guestPostalCode | string 代表者の郵便番号 |
guestAddress | string 代表者の住所 |
guestPrefecture | string [ 3 .. 4 ] characters 代表者の都道府県(北海道, 青森県, etc.) |
numberOfAdults required | integer >= 0 宿泊人数(大人) |
numberOfChildren required | integer >= 0 宿泊人数(子供) |
numberOfInfants | integer >= 0 宿泊人数(幼児)
|
contractType | integer Enum: 1 2 99 契約形態
|
memo | string 予約メモ |
document | string 予約ドキュメント |
packagePlanName | string プラン名 |
packagePlanCode | string プランコード |
{- "listingId": 0,
- "primaryReservationId": 0,
- "checkInDate": "2019-08-24",
- "checkOutDate": "2019-08-24",
- "checkInTime": "string",
- "checkInTimeStr": "string",
- "checkOutTime": "string",
- "channel": 0,
- "confirmationCode": "string",
- "currencyCode": "string",
- "basePrice": 0,
- "extrasPrice": 0,
- "serviceFee": 0,
- "userUsePoints": 0,
- "payment": "string",
- "guestFullName": "string",
- "guestFullNameFurigana": "string",
- "guestEmail": "user@example.com",
- "guestPhone": "string",
- "guestPostalCode": "string",
- "guestAddress": "string",
- "guestPrefecture": "stri",
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "contractType": 1,
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string"
}
{- "id": 0,
- "building": {
- "id": 0,
- "name": "string"
}, - "listingId": 0,
- "listing": {
- "id": 0,
- "propertyName": "string"
}, - "listingRoomId": 0,
- "listingRoom": {
- "id": 0,
- "name": "string"
}, - "confirmationCode": "string",
- "checkInDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutDate": "2019-08-24",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "numberOfGuests": 0,
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "isCancelled": true,
- "isSelfCleaning": true,
- "isClosed": true,
- "platform": 1,
- "channel": 0,
- "channelName": "string",
- "otherServiceInformation": "string",
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "planGroup": {
- "code": "string",
- "name": "string"
}, - "contractType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "cancelledAt": "2019-08-24T14:15:22Z",
- "qrCode": "string",
- "qrCodeUrls": [
- {
- "url": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
], - "qrCodeListUrl": "string",
- "primaryReservationId": 0,
- "payment": "string",
- "redirectionUrlAfterPayment": "string",
- "advancedCheckedInGuestUrl": "string",
- "guest": {
- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}, - "payout": {
- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}, - "account": {
- "totalSalesPriceExcludingTax": 0,
- "totalSalesPrice": 0,
- "totalConsumptionTax": 0,
- "totalPayment": 0,
- "receivable": 0,
- "isPaid": true
}, - "paymentUrls": [
- {
- "type": "takemepay",
- "url": "string",
- "title": "string",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiredAt": "2019-08-24T14:15:22Z"
}
], - "smartLockCodes": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "type": "igloohome",
- "code": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
]
}
idで指定した予約の詳細を取得します。
id required | integer 予約ID |
{- "id": 0,
- "building": {
- "id": 0,
- "name": "string"
}, - "listingId": 0,
- "listing": {
- "id": 0,
- "propertyName": "string"
}, - "listingRoomId": 0,
- "listingRoom": {
- "id": 0,
- "name": "string"
}, - "confirmationCode": "string",
- "checkInDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutDate": "2019-08-24",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "numberOfGuests": 0,
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "isCancelled": true,
- "isSelfCleaning": true,
- "isClosed": true,
- "platform": 1,
- "channel": 0,
- "channelName": "string",
- "otherServiceInformation": "string",
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "planGroup": {
- "code": "string",
- "name": "string"
}, - "contractType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "cancelledAt": "2019-08-24T14:15:22Z",
- "qrCode": "string",
- "qrCodeUrls": [
- {
- "url": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
], - "qrCodeListUrl": "string",
- "primaryReservationId": 0,
- "payment": "string",
- "redirectionUrlAfterPayment": "string",
- "advancedCheckedInGuestUrl": "string",
- "guest": {
- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}, - "payout": {
- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}, - "account": {
- "totalSalesPriceExcludingTax": 0,
- "totalSalesPrice": 0,
- "totalConsumptionTax": 0,
- "totalPayment": 0,
- "receivable": 0,
- "isPaid": true
}, - "paymentUrls": [
- {
- "type": "takemepay",
- "url": "string",
- "title": "string",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiredAt": "2019-08-24T14:15:22Z"
}
], - "smartLockCodes": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "type": "igloohome",
- "code": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
]
}
idで指定した予約を更新します。
id required | integer 予約ID |
listingId | integer 物件ID |
checkInDate | string <date> チェックイン日( |
checkOutDate | string <date> チェックアウト日( |
checkInTime | string or null チェックイン予定時間( |
checkOutTime | string or null チェックアウト予定時間( |
checkedInAt | string or null <date-time> チェックイン日時( |
checkedOutAt | string or null <date-time> チェックアウト日時( |
advancedCheckedInAt | string or null <date-time> 事前チェックイン日時( |
advancedCheckedInUrl | string or null 事前チェックインを確認できる管理画面URL |
advancedCheckedInGuestUrl | string or null 事前チェックインのゲスト向けURL |
numberOfAdults | integer >= 0 宿泊人数(大人) |
numberOfChildren | integer >= 0 宿泊人数(子供) |
numberOfInfants | integer >= 0 宿泊人数(幼児) |
contractType | integer Enum: 1 2 99 契約形態
|
memo | string 予約メモ |
document | string オーナー向けドキュメント |
payment | string 決済手段 |
packagePlanName | string or null プラン名 |
packagePlanCode | string or null プランコード |
redirectionUrlAfterPayment | string or null 決済完了後のリダイレクトURL |
qrCodeListUrl | string or null 入場用QRコード一覧URL |
{- "listingId": 0,
- "checkInDate": "2019-08-24",
- "checkOutDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "advancedCheckedInGuestUrl": "string",
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "contractType": 1,
- "memo": "string",
- "document": "string",
- "payment": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "redirectionUrlAfterPayment": "string",
- "qrCodeListUrl": "string"
}
{- "id": 0,
- "building": {
- "id": 0,
- "name": "string"
}, - "listingId": 0,
- "listing": {
- "id": 0,
- "propertyName": "string"
}, - "listingRoomId": 0,
- "listingRoom": {
- "id": 0,
- "name": "string"
}, - "confirmationCode": "string",
- "checkInDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutDate": "2019-08-24",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "numberOfGuests": 0,
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "isCancelled": true,
- "isSelfCleaning": true,
- "isClosed": true,
- "platform": 1,
- "channel": 0,
- "channelName": "string",
- "otherServiceInformation": "string",
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "planGroup": {
- "code": "string",
- "name": "string"
}, - "contractType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "cancelledAt": "2019-08-24T14:15:22Z",
- "qrCode": "string",
- "qrCodeUrls": [
- {
- "url": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
], - "qrCodeListUrl": "string",
- "primaryReservationId": 0,
- "payment": "string",
- "redirectionUrlAfterPayment": "string",
- "advancedCheckedInGuestUrl": "string",
- "guest": {
- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}, - "payout": {
- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}, - "account": {
- "totalSalesPriceExcludingTax": 0,
- "totalSalesPrice": 0,
- "totalConsumptionTax": 0,
- "totalPayment": 0,
- "receivable": 0,
- "isPaid": true
}, - "paymentUrls": [
- {
- "type": "takemepay",
- "url": "string",
- "title": "string",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiredAt": "2019-08-24T14:15:22Z"
}
], - "smartLockCodes": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "type": "igloohome",
- "code": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
]
}
idで指定した予約をキャンセルします。
id required | integer 予約ID |
{- "id": 0,
- "building": {
- "id": 0,
- "name": "string"
}, - "listingId": 0,
- "listing": {
- "id": 0,
- "propertyName": "string"
}, - "listingRoomId": 0,
- "listingRoom": {
- "id": 0,
- "name": "string"
}, - "confirmationCode": "string",
- "checkInDate": "2019-08-24",
- "checkInTime": "string",
- "checkOutDate": "2019-08-24",
- "checkOutTime": "string",
- "checkedInAt": "2019-08-24T14:15:22Z",
- "checkedOutAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInAt": "2019-08-24T14:15:22Z",
- "advancedCheckedInUrl": "string",
- "numberOfGuests": 0,
- "numberOfAdults": 0,
- "numberOfChildren": 0,
- "numberOfInfants": 0,
- "isCancelled": true,
- "isSelfCleaning": true,
- "isClosed": true,
- "platform": 1,
- "channel": 0,
- "channelName": "string",
- "otherServiceInformation": "string",
- "memo": "string",
- "document": "string",
- "packagePlanName": "string",
- "packagePlanCode": "string",
- "planGroup": {
- "code": "string",
- "name": "string"
}, - "contractType": 1,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "cancelledAt": "2019-08-24T14:15:22Z",
- "qrCode": "string",
- "qrCodeUrls": [
- {
- "url": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
], - "qrCodeListUrl": "string",
- "primaryReservationId": 0,
- "payment": "string",
- "redirectionUrlAfterPayment": "string",
- "advancedCheckedInGuestUrl": "string",
- "guest": {
- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}, - "payout": {
- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}, - "account": {
- "totalSalesPriceExcludingTax": 0,
- "totalSalesPrice": 0,
- "totalConsumptionTax": 0,
- "totalPayment": 0,
- "receivable": 0,
- "isPaid": true
}, - "paymentUrls": [
- {
- "type": "takemepay",
- "url": "string",
- "title": "string",
- "amount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "expiredAt": "2019-08-24T14:15:22Z"
}
], - "smartLockCodes": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "type": "igloohome",
- "code": "string",
- "startDateAt": "2019-08-24T14:15:22Z",
- "endDateAt": "2019-08-24T14:15:22Z"
}
]
}
idで指定した予約の物件・チェックイン日・チェックアウト日が変更可能かチェックします。
id required | integer 予約ID |
listingId required | integer 物件ID |
checkInDate required | string <date> チェックイン日( |
checkOutDate required | string <date> チェックアウト日( |
{- "listingId": 0,
- "checkInDate": "2019-08-24",
- "checkOutDate": "2019-08-24"
}
{- "reservationId": 0,
- "checkInDate": "2019-08-24",
- "checkOutDate": "2019-08-24",
- "isUpdatable": true,
- "listingId": 0
}
idで指定した代表者を更新します。
id required | integer 予約ID |
guestId required | integer 代表者ID |
fullName | string 名前 |
fullNameFurigana | string フリガナ(カタカナ・アルファベットで姓・名をスペース区切り) |
string <email> メールアドレス | |
phone | string 電話番号 |
postalCode | string 郵便番号 |
address | string 住所 |
prefecture | string [ 3 .. 4 ] characters 都道府県 |
country | string or null = 2 characters 国籍 ( |
region | integer or null Enum: 1 2 3 4 5 大陸:
|
subregion | integer or null Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 地域:
|
{- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1
}
{- "id": 0,
- "fullName": "string",
- "fullNameFurigana": "string",
- "email": "user@example.com",
- "phone": "string",
- "postalCode": "string",
- "dateOfBirth": "2019-08-24",
- "address": "string",
- "prefecture": "stri",
- "country": "st",
- "region": 1,
- "subregion": 1,
- "receipt": "string",
- "customerId": 0
}
idで指定した売上を更新します。
id required | integer 予約ID |
payoutId required | integer 売上ID |
currencyCode | string 通貨コード( |
basePrice | number 宿泊料金 |
extrasPrice | number 清掃料金 |
serviceFee | number 予約チャネル手数料 |
userUsePoints | number ポイント使用料 |
{- "currencyCode": "string",
- "basePrice": 0,
- "extrasPrice": 0,
- "serviceFee": 0,
- "userUsePoints": 0
}
{- "id": 0,
- "nights": 0,
- "currencyCode": "str",
- "basePrice": 0,
- "extrasPrice": 0,
- "standardFee": 0,
- "subtotal": 0,
- "serviceFee": 0,
- "total": 0,
- "amountClaimed": 0,
- "userUsePoints": 0
}
建物の一覧を取得します。
created_at
(作成日時昇順)offset | integer 開始位置
|
limit | integer 取得件数
|
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "name": "string"
}
]
}
物件の一覧を取得します。
created_at
(作成日時昇順)offset | integer 開始位置
|
limit | integer 取得件数
|
building_id | integer 施設ID |
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "propertyName": "string",
- "published": true,
- "memo": "string",
- "licenseType": "hotel",
- "platformListings": [
- {
- "platform": 1,
- "platformListingId": "string",
- "platformListingName": "string",
- "roomTypeCode": "string",
- "platformAccount": {
- "platformUserId": "string",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "hotelCode": "string"
}
}
], - "buildingId": 0
}
]
}
idで指定した物件の詳細を取得します
id required | integer 物件のID |
{- "id": 0,
- "propertyName": "string",
- "published": true,
- "memo": "string",
- "licenseType": "hotel",
- "platformListings": [
- {
- "platform": 1,
- "platformListingId": "string",
- "platformListingName": "string",
- "roomTypeCode": "string",
- "platformAccount": {
- "platformUserId": "string",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "hotelCode": "string"
}
}
], - "buildingId": 0
}
idで指定した物件の在庫一覧を取得します。
id required | integer 物件ID |
start_date required | string <date> 絞り込み範囲開始日( |
end_date required | string <date> 絞り込み範囲終了日( |
{- "listingId": 0,
- "days": [
- {
- "date": "2019-08-24",
- "available": 0,
- "comment": "string"
}
]
}
idで指定した物件の在庫を更新
id required | integer 物件のID |
startDate required | string <date> 更新範囲開始日( |
endDate required | string <date> 更新範囲開始日( |
available required | integer 在庫状況
|
comment | string コメント |
{- "startDate": "2019-08-24",
- "endDate": "2019-08-24",
- "available": 0,
- "comment": "string"
}
{- "listingId": 0,
- "days": [
- {
- "date": "2019-08-24",
- "available": 0,
- "comment": "string"
}
]
}
部屋の一覧を取得します。
created_at
(作成日時昇順)offset | integer 開始位置
|
limit | integer 取得件数
|
building_id | integer 施設ID |
listing_id | integer 物件ID |
{- "count": 0,
- "next": "string",
- "previous": "string",
- "results": [
- {
- "id": 0,
- "name": "string",
- "wifiSsid": "string",
- "wifiPassword": "string",
- "listingId": 0
}
]
}