SQUEEZE suitebook API v2 (0.0.3)

Download OpenAPI specification:Download

Support Team: support@suitebook.io Terms of Service

suitebook API for third party developers

webhook

reservation Webhook

Authorizations:

None

Request Body schema: application/json

予約の状態が変更になった際のWebhook通知です。

type	string Enum: "reservation_acceptance_confirmation" "reservation_alteration_confirmation" "reservation_cancellation_confirmation" "reservation_checked_in" "reservation_checked_out" 通知イベント reservation_acceptance_confirmation - 新規予約 reservation_alteration_confirmation - 予約更新 reservation_cancellation_confirmation - 予約キャンセル reservation_checked_in - チェックイン reservation_checked_out - チェックアウト
version	string Value: "v2" バージョン
	object (Reservation) 予約

Responses

Request samples

Payload

Content type

application/json

{"type": "reservation_acceptance_confirmation",
"version": "v2",
"reservation": {"id": 0,
"confirmationCode": "string",
"checkInDate": "2019-08-24",
"checkInTime": "string",
"checkInTimeStr": "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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"numberOfGuests": 0,
"numberOfAdults": 0,
"numberOfChildren": 0,
"numberOfInfants": 0,
"numberOfMales": 0,
"numberOfFemales": 0,
"platform": 1,
"channel": 0,
"channelName": "string",
"billingChannel": 0,
"billingChannelName": "string",
"cancelReason": 0,
"isCancelled": true,
"isNoShow": true,
"isClosed": true,
"isRepeater": true,
"isRoomUpgraded": true,
"isParent": true,
"isChild": true,
"canCheckIn": true,
"usesParking": true,
"needsAttention": true,
"parentReservationId": 0,
"messageSendType": 1,
"contractType": 1,
"memo": "string",
"document": "string",
"mealCondition": "string",
"specificMealCondition": "string",
"specialServiceRequest": "string",
"otherServiceInformation": "string",
"advancedCheckedInGuestUrl": "string",
"redirectionUrlAfterPayment": "string",
"payment": "string",
"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"
}
],
"guestNotices": [{"id": 0,
"message": "string"
}
],
"qrCode": "string",
"qrCodeUrls": [{"url": "string",
"startDateAt": "2019-08-24T14:15:22Z",
"endDateAt": "2019-08-24T14:15:22Z",
"startNote": "string",
"endNote": "string"
}
],
"qrCodeListUrl": "string",
"tags": ["string"
],
"packagePlanName": "string",
"packagePlanCode": "string",
"packages": [{"id": 0,
"name": "string",
"code": "string"
}
],
"planGroup": {"id": 0,
"name": "string",
"code": "string",
"checkInTimeStart": "string",
"checkInTimeEnd": "string",
"checkOutTimeEnd": "string"
},
"guest": {"id": 0,
"fullName": "string",
"fullNameFurigana": "string",
"email": "user@example.com",
"phone": "string",
"dateOfBirth": "2019-08-24",
"postalCode": "string",
"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,
"cancellationFee": 0,
"cancellationServiceFee": 0,
"cancellationPayout": 0
},
"account": {"id": 0,
"currencyCode": "str",
"totalSalesPrice": 0,
"totalSalesPriceExcludingTax": 0,
"totalSalesPriceExcludingJpy": 0,
"totalPayment": 0,
"totalPaymentPriceExcludingJpy": 0,
"totalReceived": 0,
"totalReceivedPriceExcludingJpy": 0,
"totalBillingPrice": 0,
"totalBillingPriceExcludingJpy": 0,
"totalConsumptionTax": 0,
"totalConsumptionTaxForBilling": 0,
"receivableTotalConsumptionTaxForBilling": 0,
"totalAccommodationTax": 0,
"receivableAccommodationTax": 0,
"isPaid": true,
"receivable": 0,
"paymentDetails": [{"id": 0,
"isForCash": true,
"isForReceipt": true,
"isUserPoints": 0,
"channel": 0,
"channelName": "string",
"paymentDate": "2019-08-24",
"paymentName": "string",
"paymentPrice": 0,
"paymentNo": "string",
"isPaid": true
}
],
"salesDetails": [{"id": 0,
"salesDate": "2019-08-24",
"productName": "string",
"unitSellingPrice": 0,
"salesQuantity": 0,
"salesPrice": 0,
"originalPrice": 0,
"consumptionTaxType": 1,
"consumptionTaxRate": 0,
"consumptionTaxAmount": 0,
"salesNo": "string",
"routedTo": 0,
"packageId": 0,
"showOnReceipt": true,
"receiptPrice": 0,
"receiptConsumptionTaxAmount": 0,
"isPaid": true
}
],
"mealTickets": [{"id": 0,
"mealDate": "2019-08-24",
"mealMenu": {"id": 0,
"name": "string",
"publicationName": "string"
}
}
]
},
"building": {"id": 0,
"name": "string"
},
"listing": {"id": 0,
"name": "string",
"slug": "string",
"buildingId": 0
},
"room": {"id": 0,
"name": "string",
"listingId": 0
},
"booker": {"id": 0,
"name": "string",
"kana": "string",
"phone": "string",
"email": "string"
}
}
}

inventory Webhook

Authorizations:

None

Request Body schema: application/json

在庫の状況が変更になった際のWebhook通知です。

type	string Value: "inventories_alteration_confirmation" 通知イベント inventories_alteration_confirmation - 在庫更新
version	string Value: "v2" バージョン
	Array of objects (Inventory)

Responses

Request samples

Payload

Content type

application/json

{"type": "inventories_alteration_confirmation",
"version": "v2",
"reservation": [{"listing": 0,
"date": "2019-08-24",
"availableCount": 0,
"reservationCount": 0,
"comment": "string"
}
]
}

status

getStatus

APIが稼働しているかどうかを確認します。

Responses

qrCode

getQrCode

shortCodeに紐付いた予約の状態を取得します。

path Parameters

shortCode

required

string

予約のハッシュ値

Responses

Response samples

Content type

application/json

{"isValid": true,
"error": "unavailable",
"advancedCheckedInUrl": "string",
"reservationUrl": "string",
"verificationUrl": "string"
}

verifyQrCode

shortCodeに紐付いた予約のチェックイン処理をします。

path Parameters

shortCode

required

string

予約のハッシュ値

Responses

Response samples

Content type

application/json

{"isValid": true,
"error": "unavailable",
"advancedCheckedInUrl": "string",
"reservationUrl": "string",
"verificationUrl": "string"
}

reservation

getReservations

予約の一覧を取得します。

Authorizations:

AuthToken

query Parameters

offset	integer 開始位置デフォルト値: 0
limit	integer 取得件数デフォルト値: 100 最大値: 1000
check_in_date_from	string <date> チェックイン日（`yyyy-MM-dd`）
check_in_date_to	string <date> チェックイン日（`yyyy-MM-dd`）
check_out_date_from	string <date> チェックアウト日（`yyyy-MM-dd`）
check_out_date_to	string <date> チェックアウト日（`yyyy-MM-dd`）
created_date_from	string <date> 予約作成日（`yyyy-MM-dd`）
created_date_to	string <date> 予約作成日（`yyyy-MM-dd`）
updated_date_from	string <date> 予約更新日（`yyyy-MM-dd`）
updated_date_to	string <date> 予約更新日（`yyyy-MM-dd`）
channel	integer 予約経路
confirmation_code	string 予約コード（完全一致）
confirmation_code_startswith	string >= 5 characters 予約コード（前方部分一致）
booking_code	string 予約コードまたは予約ID（完全一致）
qr_code	string suitebook または予約サイトが発行したQRコード文字列（完全一致）
is_cancelled	boolean キャンセル済みかどうか
is_checked_in	boolean チェックイン済みかどうか
is_checked_out	boolean チェックアウト済みかどうか
building	integer 施設ID
listing	integer 部屋タイプID
room	integer 部屋ID
room_name	string 部屋名（完全一致）
guest_name_kana_alphabet	string ゲスト名フリガナカタカナまたはアルファベットで、姓・名をスペース区切りあいまい検索
phone_endswith	string >= 8 characters 代表者電話番号数字のみで指定後方部分一致
customer_phone_endswith	string >= 8 characters 顧客電話番号数字のみで指定後方部分一致
email	string <email> 代表者メールアドレス（完全一致）
customer_email	string <email> 顧客メールアドレス（完全一致）
fid	integer FID（完全一致）
contract_type	integer Enum: 1 2 99 契約形態 1 - 宿泊契約 2 - 賃貸借契約 99 - その他
order	string Enum: "created_at" "-created_at" "updated_at" "-updated_at" "cancelled_at" "-cancelled_at" "check_in_date" "-check_in_date" "check_out_date" "-check_out_date" 並べ替えの順番デフォルト値: `-updated_at`（更新日時降順）

Responses

Response samples

Content type

application/json

{"count": 0,
"next": "string",
"previous": "string",
"results": [{"id": 0,
"confirmationCode": "string",
"checkInDate": "2019-08-24",
"checkInTime": "string",
"checkInTimeStr": "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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"numberOfGuests": 0,
"numberOfAdults": 0,
"numberOfChildren": 0,
"numberOfInfants": 0,
"numberOfMales": 0,
"numberOfFemales": 0,
"platform": 1,
"channel": 0,
"channelName": "string",
"billingChannel": 0,
"billingChannelName": "string",
"cancelReason": 0,
"isCancelled": true,
"isNoShow": true,
"isClosed": true,
"isRepeater": true,
"isRoomUpgraded": true,
"isParent": true,
"isChild": true,
"canCheckIn": true,
"usesParking": true,
"needsAttention": true,
"parentReservationId": 0,
"messageSendType": 1,
"contractType": 1,
"memo": "string",
"document": "string",
"mealCondition": "string",
"specificMealCondition": "string",
"specialServiceRequest": "string",
"otherServiceInformation": "string",
"advancedCheckedInGuestUrl": "string",
"redirectionUrlAfterPayment": "string",
"payment": "string",
"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"
}
],
"guestNotices": [{"id": 0,
"message": "string"
}
],
"qrCode": "string",
"qrCodeUrls": [{"url": "string",
"startDateAt": "2019-08-24T14:15:22Z",
"endDateAt": "2019-08-24T14:15:22Z",
"startNote": "string",
"endNote": "string"
}
],
"qrCodeListUrl": "string",
"tags": ["string"
],
"packagePlanName": "string",
"packagePlanCode": "string",
"packages": [{"id": 0,
"name": "string",
"code": "string"
}
],
"planGroup": {"id": 0,
"name": "string",
"code": "string",
"checkInTimeStart": "string",
"checkInTimeEnd": "string",
"checkOutTimeEnd": "string"
},
"guest": {"id": 0,
"fullName": "string",
"fullNameFurigana": "string",
"email": "user@example.com",
"phone": "string",
"dateOfBirth": "2019-08-24",
"postalCode": "string",
"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,
"cancellationFee": 0,
"cancellationServiceFee": 0,
"cancellationPayout": 0
},
"account": {"id": 0,
"currencyCode": "str",
"totalSalesPrice": 0,
"totalSalesPriceExcludingTax": 0,
"totalSalesPriceExcludingJpy": 0,
"totalPayment": 0,
"totalPaymentPriceExcludingJpy": 0,
"totalReceived": 0,
"totalReceivedPriceExcludingJpy": 0,
"totalBillingPrice": 0,
"totalBillingPriceExcludingJpy": 0,
"totalConsumptionTax": 0,
"totalConsumptionTaxForBilling": 0,
"receivableTotalConsumptionTaxForBilling": 0,
"totalAccommodationTax": 0,
"receivableAccommodationTax": 0,
"isPaid": true,
"receivable": 0,
"paymentDetails": [{"id": 0,
"isForCash": true,
"isForReceipt": true,
"isUserPoints": 0,
"channel": 0,
"channelName": "string",
"paymentDate": "2019-08-24",
"paymentName": "string",
"paymentPrice": 0,
"paymentNo": "string",
"isPaid": true
}
],
"salesDetails": [{"id": 0,
"salesDate": "2019-08-24",
"productName": "string",
"unitSellingPrice": 0,
"salesQuantity": 0,
"salesPrice": 0,
"originalPrice": 0,
"consumptionTaxType": 1,
"consumptionTaxRate": 0,
"consumptionTaxAmount": 0,
"salesNo": "string",
"routedTo": 0,
"packageId": 0,
"showOnReceipt": true,
"receiptPrice": 0,
"receiptConsumptionTaxAmount": 0,
"isPaid": true
}
],
"mealTickets": [{"id": 0,
"mealDate": "2019-08-24",
"mealMenu": {"id": 0,
"name": "string",
"publicationName": "string"
}
}
]
},
"building": {"id": 0,
"name": "string"
},
"listing": {"id": 0,
"name": "string",
"slug": "string",
"buildingId": 0
},
"room": {"id": 0,
"name": "string",
"listingId": 0
},
"booker": {"id": 0,
"name": "string",
"kana": "string",
"phone": "string",
"email": "string"
}
}
]
}

getReservation

idで指定した予約の詳細を取得します。

Authorizations:

AuthToken

path Parameters

required

integer

予約ID

Responses

Response samples

Content type

application/json

{"id": 0,
"confirmationCode": "string",
"checkInDate": "2019-08-24",
"checkInTime": "string",
"checkInTimeStr": "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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"numberOfGuests": 0,
"numberOfAdults": 0,
"numberOfChildren": 0,
"numberOfInfants": 0,
"numberOfMales": 0,
"numberOfFemales": 0,
"platform": 1,
"channel": 0,
"channelName": "string",
"billingChannel": 0,
"billingChannelName": "string",
"cancelReason": 0,
"isCancelled": true,
"isNoShow": true,
"isClosed": true,
"isRepeater": true,
"isRoomUpgraded": true,
"isParent": true,
"isChild": true,
"canCheckIn": true,
"usesParking": true,
"needsAttention": true,
"parentReservationId": 0,
"messageSendType": 1,
"contractType": 1,
"memo": "string",
"document": "string",
"mealCondition": "string",
"specificMealCondition": "string",
"specialServiceRequest": "string",
"otherServiceInformation": "string",
"advancedCheckedInGuestUrl": "string",
"redirectionUrlAfterPayment": "string",
"payment": "string",
"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"
}
],
"guestNotices": [{"id": 0,
"message": "string"
}
],
"qrCode": "string",
"qrCodeUrls": [{"url": "string",
"startDateAt": "2019-08-24T14:15:22Z",
"endDateAt": "2019-08-24T14:15:22Z",
"startNote": "string",
"endNote": "string"
}
],
"qrCodeListUrl": "string",
"tags": ["string"
],
"packagePlanName": "string",
"packagePlanCode": "string",
"packages": [{"id": 0,
"name": "string",
"code": "string"
}
],
"planGroup": {"id": 0,
"name": "string",
"code": "string",
"checkInTimeStart": "string",
"checkInTimeEnd": "string",
"checkOutTimeEnd": "string"
},
"guest": {"id": 0,
"fullName": "string",
"fullNameFurigana": "string",
"email": "user@example.com",
"phone": "string",
"dateOfBirth": "2019-08-24",
"postalCode": "string",
"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,
"cancellationFee": 0,
"cancellationServiceFee": 0,
"cancellationPayout": 0
},
"account": {"id": 0,
"currencyCode": "str",
"totalSalesPrice": 0,
"totalSalesPriceExcludingTax": 0,
"totalSalesPriceExcludingJpy": 0,
"totalPayment": 0,
"totalPaymentPriceExcludingJpy": 0,
"totalReceived": 0,
"totalReceivedPriceExcludingJpy": 0,
"totalBillingPrice": 0,
"totalBillingPriceExcludingJpy": 0,
"totalConsumptionTax": 0,
"totalConsumptionTaxForBilling": 0,
"receivableTotalConsumptionTaxForBilling": 0,
"totalAccommodationTax": 0,
"receivableAccommodationTax": 0,
"isPaid": true,
"receivable": 0,
"paymentDetails": [{"id": 0,
"isForCash": true,
"isForReceipt": true,
"isUserPoints": 0,
"channel": 0,
"channelName": "string",
"paymentDate": "2019-08-24",
"paymentName": "string",
"paymentPrice": 0,
"paymentNo": "string",
"isPaid": true
}
],
"salesDetails": [{"id": 0,
"salesDate": "2019-08-24",
"productName": "string",
"unitSellingPrice": 0,
"salesQuantity": 0,
"salesPrice": 0,
"originalPrice": 0,
"consumptionTaxType": 1,
"consumptionTaxRate": 0,
"consumptionTaxAmount": 0,
"salesNo": "string",
"routedTo": 0,
"packageId": 0,
"showOnReceipt": true,
"receiptPrice": 0,
"receiptConsumptionTaxAmount": 0,
"isPaid": true
}
],
"mealTickets": [{"id": 0,
"mealDate": "2019-08-24",
"mealMenu": {"id": 0,
"name": "string",
"publicationName": "string"
}
}
]
},
"building": {"id": 0,
"name": "string"
},
"listing": {"id": 0,
"name": "string",
"slug": "string",
"buildingId": 0
},
"room": {"id": 0,
"name": "string",
"listingId": 0
},
"booker": {"id": 0,
"name": "string",
"kana": "string",
"phone": "string",
"email": "string"
}
}

canCheckInReservation

idで指定した予約がチェックイン可能かどうかを返します。

Authorizations:

AuthToken

path Parameters

required

integer

予約ID

Responses

Response samples

Content type

application/json

{"canCheckIn": true
}

preCheckInReservation

idで指定した予約の事前チェックイン処理をします。

Authorizations:

AuthToken

path Parameters

required

integer

予約ID

Request Body schema: application/json

advancedCheckedInAt

string <date-time>

事前チェックイン日時

Responses

Request samples

Payload

Content type

application/json

{"advancedCheckedInAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"confirmationCode": "string",
"checkInDate": "2019-08-24",
"checkInTime": "string",
"checkInTimeStr": "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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"numberOfGuests": 0,
"numberOfAdults": 0,
"numberOfChildren": 0,
"numberOfInfants": 0,
"numberOfMales": 0,
"numberOfFemales": 0,
"platform": 1,
"channel": 0,
"channelName": "string",
"billingChannel": 0,
"billingChannelName": "string",
"cancelReason": 0,
"isCancelled": true,
"isNoShow": true,
"isClosed": true,
"isRepeater": true,
"isRoomUpgraded": true,
"isParent": true,
"isChild": true,
"canCheckIn": true,
"usesParking": true,
"needsAttention": true,
"parentReservationId": 0,
"messageSendType": 1,
"contractType": 1,
"memo": "string",
"document": "string",
"mealCondition": "string",
"specificMealCondition": "string",
"specialServiceRequest": "string",
"otherServiceInformation": "string",
"advancedCheckedInGuestUrl": "string",
"redirectionUrlAfterPayment": "string",
"payment": "string",
"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"
}
],
"guestNotices": [{"id": 0,
"message": "string"
}
],
"qrCode": "string",
"qrCodeUrls": [{"url": "string",
"startDateAt": "2019-08-24T14:15:22Z",
"endDateAt": "2019-08-24T14:15:22Z",
"startNote": "string",
"endNote": "string"
}
],
"qrCodeListUrl": "string",
"tags": ["string"
],
"packagePlanName": "string",
"packagePlanCode": "string",
"packages": [{"id": 0,
"name": "string",
"code": "string"
}
],
"planGroup": {"id": 0,
"name": "string",
"code": "string",
"checkInTimeStart": "string",
"checkInTimeEnd": "string",
"checkOutTimeEnd": "string"
},
"guest": {"id": 0,
"fullName": "string",
"fullNameFurigana": "string",
"email": "user@example.com",
"phone": "string",
"dateOfBirth": "2019-08-24",
"postalCode": "string",
"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,
"cancellationFee": 0,
"cancellationServiceFee": 0,
"cancellationPayout": 0
},
"account": {"id": 0,
"currencyCode": "str",
"totalSalesPrice": 0,
"totalSalesPriceExcludingTax": 0,
"totalSalesPriceExcludingJpy": 0,
"totalPayment": 0,
"totalPaymentPriceExcludingJpy": 0,
"totalReceived": 0,
"totalReceivedPriceExcludingJpy": 0,
"totalBillingPrice": 0,
"totalBillingPriceExcludingJpy": 0,
"totalConsumptionTax": 0,
"totalConsumptionTaxForBilling": 0,
"receivableTotalConsumptionTaxForBilling": 0,
"totalAccommodationTax": 0,
"receivableAccommodationTax": 0,
"isPaid": true,
"receivable": 0,
"paymentDetails": [{"id": 0,
"isForCash": true,
"isForReceipt": true,
"isUserPoints": 0,
"channel": 0,
"channelName": "string",
"paymentDate": "2019-08-24",
"paymentName": "string",
"paymentPrice": 0,
"paymentNo": "string",
"isPaid": true
}
],
"salesDetails": [{"id": 0,
"salesDate": "2019-08-24",
"productName": "string",
"unitSellingPrice": 0,
"salesQuantity": 0,
"salesPrice": 0,
"originalPrice": 0,
"consumptionTaxType": 1,
"consumptionTaxRate": 0,
"consumptionTaxAmount": 0,
"salesNo": "string",
"routedTo": 0,
"packageId": 0,
"showOnReceipt": true,
"receiptPrice": 0,
"receiptConsumptionTaxAmount": 0,
"isPaid": true
}
],
"mealTickets": [{"id": 0,
"mealDate": "2019-08-24",
"mealMenu": {"id": 0,
"name": "string",
"publicationName": "string"
}
}
]
},
"building": {"id": 0,
"name": "string"
},
"listing": {"id": 0,
"name": "string",
"slug": "string",
"buildingId": 0
},
"room": {"id": 0,
"name": "string",
"listingId": 0
},
"booker": {"id": 0,
"name": "string",
"kana": "string",
"phone": "string",
"email": "string"
}
}

checkInReservation

idで指定した予約のチェックイン処理をします。

Authorizations:

AuthToken

path Parameters

required

integer

予約ID

Request Body schema: application/json

checkedInAt

string <date-time>

チェックイン日時

Responses

Request samples

Payload

Content type

application/json

{"checkedInAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"confirmationCode": "string",
"checkInDate": "2019-08-24",
"checkInTime": "string",
"checkInTimeStr": "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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"numberOfGuests": 0,
"numberOfAdults": 0,
"numberOfChildren": 0,
"numberOfInfants": 0,
"numberOfMales": 0,
"numberOfFemales": 0,
"platform": 1,
"channel": 0,
"channelName": "string",
"billingChannel": 0,
"billingChannelName": "string",
"cancelReason": 0,
"isCancelled": true,
"isNoShow": true,
"isClosed": true,
"isRepeater": true,
"isRoomUpgraded": true,
"isParent": true,
"isChild": true,
"canCheckIn": true,
"usesParking": true,
"needsAttention": true,
"parentReservationId": 0,
"messageSendType": 1,
"contractType": 1,
"memo": "string",
"document": "string",
"mealCondition": "string",
"specificMealCondition": "string",
"specialServiceRequest": "string",
"otherServiceInformation": "string",
"advancedCheckedInGuestUrl": "string",
"redirectionUrlAfterPayment": "string",
"payment": "string",
"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"
}
],
"guestNotices": [{"id": 0,
"message": "string"
}
],
"qrCode": "string",
"qrCodeUrls": [{"url": "string",
"startDateAt": "2019-08-24T14:15:22Z",
"endDateAt": "2019-08-24T14:15:22Z",
"startNote": "string",
"endNote": "string"
}
],
"qrCodeListUrl": "string",
"tags": ["string"
],
"packagePlanName": "string",
"packagePlanCode": "string",
"packages": [{"id": 0,
"name": "string",
"code": "string"
}
],
"planGroup": {"id": 0,
"name": "string",
"code": "string",
"checkInTimeStart": "string",
"checkInTimeEnd": "string",
"checkOutTimeEnd": "string"
},
"guest": {"id": 0,
"fullName": "string",
"fullNameFurigana": "string",
"email": "user@example.com",
"phone": "string",
"dateOfBirth": "2019-08-24",
"postalCode": "string",
"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,
"cancellationFee": 0,
"cancellationServiceFee": 0,
"cancellationPayout": 0
},
"account": {"id": 0,
"currencyCode": "str",
"totalSalesPrice": 0,
"totalSalesPriceExcludingTax": 0,
"totalSalesPriceExcludingJpy": 0,
"totalPayment": 0,
"totalPaymentPriceExcludingJpy": 0,
"totalReceived": 0,
"totalReceivedPriceExcludingJpy": 0,
"totalBillingPrice": 0,
"totalBillingPriceExcludingJpy": 0,
"totalConsumptionTax": 0,
"totalConsumptionTaxForBilling": 0,
"receivableTotalConsumptionTaxForBilling": 0,
"totalAccommodationTax": 0,
"receivableAccommodationTax": 0,
"isPaid": true,
"receivable": 0,
"paymentDetails": [{"id": 0,
"isForCash": true,
"isForReceipt": true,
"isUserPoints": 0,
"channel": 0,
"channelName": "string",
"paymentDate": "2019-08-24",
"paymentName": "string",
"paymentPrice": 0,
"paymentNo": "string",
"isPaid": true
}
],
"salesDetails": [{"id": 0,
"salesDate": "2019-08-24",
"productName": "string",
"unitSellingPrice": 0,
"salesQuantity": 0,
"salesPrice": 0,
"originalPrice": 0,
"consumptionTaxType": 1,
"consumptionTaxRate": 0,
"consumptionTaxAmount": 0,
"salesNo": "string",
"routedTo": 0,
"packageId": 0,
"showOnReceipt": true,
"receiptPrice": 0,
"receiptConsumptionTaxAmount": 0,
"isPaid": true
}
],
"mealTickets": [{"id": 0,
"mealDate": "2019-08-24",
"mealMenu": {"id": 0,
"name": "string",
"publicationName": "string"
}
}
]
},
"building": {"id": 0,
"name": "string"
},
"listing": {"id": 0,
"name": "string",
"slug": "string",
"buildingId": 0
},
"room": {"id": 0,
"name": "string",
"listingId": 0
},
"booker": {"id": 0,
"name": "string",
"kana": "string",
"phone": "string",
"email": "string"
}
}

checkOutReservation

idで指定した予約のチェックアウト処理をします。

Authorizations:

AuthToken

path Parameters

required

integer

予約ID

Request Body schema: application/json

checkedOutAt

string <date-time>

チェックアウト日時

Responses

Request samples

Payload

Content type

application/json

{"checkedOutAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"id": 0,
"confirmationCode": "string",
"checkInDate": "2019-08-24",
"checkInTime": "string",
"checkInTimeStr": "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",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"numberOfGuests": 0,
"numberOfAdults": 0,
"numberOfChildren": 0,
"numberOfInfants": 0,
"numberOfMales": 0,
"numberOfFemales": 0,
"platform": 1,
"channel": 0,
"channelName": "string",
"billingChannel": 0,
"billingChannelName": "string",
"cancelReason": 0,
"isCancelled": true,
"isNoShow": true,
"isClosed": true,
"isRepeater": true,
"isRoomUpgraded": true,
"isParent": true,
"isChild": true,
"canCheckIn": true,
"usesParking": true,
"needsAttention": true,
"parentReservationId": 0,
"messageSendType": 1,
"contractType": 1,
"memo": "string",
"document": "string",
"mealCondition": "string",
"specificMealCondition": "string",
"specialServiceRequest": "string",
"otherServiceInformation": "string",
"advancedCheckedInGuestUrl": "string",
"redirectionUrlAfterPayment": "string",
"payment": "string",
"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"
}
],
"guestNotices": [{"id": 0,
"message": "string"
}
],
"qrCode": "string",
"qrCodeUrls": [{"url": "string",
"startDateAt": "2019-08-24T14:15:22Z",
"endDateAt": "2019-08-24T14:15:22Z",
"startNote": "string",
"endNote": "string"
}
],
"qrCodeListUrl": "string",
"tags": ["string"
],
"packagePlanName": "string",
"packagePlanCode": "string",
"packages": [{"id": 0,
"name": "string",
"code": "string"
}
],
"planGroup": {"id": 0,
"name": "string",
"code": "string",
"checkInTimeStart": "string",
"checkInTimeEnd": "string",
"checkOutTimeEnd": "string"
},
"guest": {"id": 0,
"fullName": "string",
"fullNameFurigana": "string",
"email": "user@example.com",
"phone": "string",
"dateOfBirth": "2019-08-24",
"postalCode": "string",
"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,
"cancellationFee": 0,
"cancellationServiceFee": 0,
"cancellationPayout": 0
},
"account": {"id": 0,
"currencyCode": "str",
"totalSalesPrice": 0,
"totalSalesPriceExcludingTax": 0,
"totalSalesPriceExcludingJpy": 0,
"totalPayment": 0,
"totalPaymentPriceExcludingJpy": 0,
"totalReceived": 0,
"totalReceivedPriceExcludingJpy": 0,
"totalBillingPrice": 0,
"totalBillingPriceExcludingJpy": 0,
"totalConsumptionTax": 0,
"totalConsumptionTaxForBilling": 0,
"receivableTotalConsumptionTaxForBilling": 0,
"totalAccommodationTax": 0,
"receivableAccommodationTax": 0,
"isPaid": true,
"receivable": 0,
"paymentDetails": [{"id": 0,
"isForCash": true,
"isForReceipt": true,
"isUserPoints": 0,
"channel": 0,
"channelName": "string",
"paymentDate": "2019-08-24",
"paymentName": "string",
"paymentPrice": 0,
"paymentNo": "string",
"isPaid": true
}
],
"salesDetails": [{"id": 0,
"salesDate": "2019-08-24",
"productName": "string",
"unitSellingPrice": 0,
"salesQuantity": 0,
"salesPrice": 0,
"originalPrice": 0,
"consumptionTaxType": 1,
"consumptionTaxRate": 0,
"consumptionTaxAmount": 0,
"salesNo": "string",
"routedTo": 0,
"packageId": 0,
"showOnReceipt": true,
"receiptPrice": 0,
"receiptConsumptionTaxAmount": 0,
"isPaid": true
}
],
"mealTickets": [{"id": 0,
"mealDate": "2019-08-24",
"mealMenu": {"id": 0,
"name": "string",
"publicationName": "string"
}
}
]
},
"building": {"id": 0,
"name": "string"
},
"listing": {"id": 0,
"name": "string",
"slug": "string",
"buildingId": 0
},
"room": {"id": 0,
"name": "string",
"listingId": 0
},
"booker": {"id": 0,
"name": "string",
"kana": "string",
"phone": "string",
"email": "string"
}
}