SQUEEZE suitebook API v1 (1.11.0)

Download OpenAPI specification:Download

suitebook API for third party developers

webhook

reservation Webhook

Authorizations:
SignatureAuth
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: "v1"

バージョン

object (Reservation)

予約

Responses

Request samples

Content type
application/json
{
  • "type": "reservation_acceptance_confirmation",
  • "version": "v1",
  • "reservation": {
    }
}

inventory Webhook

Authorizations:
SignatureAuth
Request Body schema: application/json

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

type
string
Value: "inventories_alteration_confirmation"

通知イベント

  • inventories_alteration_confirmation - 在庫更新
version
string
Value: "v1"

バージョン

object (Inventories)

Responses

Request samples

Content type
application/json
{
  • "type": "inventories_alteration_confirmation",
  • "version": "v1",
  • "reservation": {
    }
}

status

getStatus

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

Responses

Response samples

Content type
application/json
{
  • "status": true
}

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

create_date_from
string <date>

予約作成日(yyyy-MM-dd

create_date_to
string <date>

予約作成日(yyyy-MM-dd

update_date_from
string <date>

予約更新日(yyyy-MM-dd

update_date_to
string <date>

予約更新日(yyyy-MM-dd

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

顧客電話番号

  • 数字のみで指定
  • 後方部分一致
email
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"

並べ替えの順番

  • デフォルト値: -updated_at(更新日時降順)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

createReservation

新しい予約を作成します。

Authorizations:
AuthToken
Request Body schema: application/json
listingId
required
integer

物件ID

primaryReservationId
integer or null

本予約ID(複数部屋予約時のみ適用)

checkInDate
required
string <date>

チェックイン日(yyyy-MM-dd

checkOutDate
required
string <date>

チェックアウト日(yyyy-MM-dd

checkInTime
string or null

チェックイン予定時間(HH:mm:ss) チェックインが25時の場合: 01:00:00

checkInTimeStr
string or null

予約サイトで登録されたチェックイン予定時間 チェックインが25時の場合: 25:00, 25:00:00 など

checkOutTime
string or null

チェックアウト予定時間(HH:mm:ss

channel
required
integer

予約チャネル

confirmationCode
string [ 5 .. 32 ] characters

予約コード(指定が無い場合は自動生成)

currencyCode
required
string

通貨コード(ISO 4217

  • デフォルト値: JPY
basePrice
required
number

宿泊料金

extrasPrice
number

清掃料金

  • デフォルト値: 0
serviceFee
number

予約手数料

  • デフォルト値: 0
userUsePoints
number

ポイント使用料

  • デフォルト値: 0
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

宿泊人数(幼児)

  • デフォルト値: 0
contractType
integer
Enum: 1 2 99

契約形態

  • 1: 宿泊契約(デフォルト値)
  • 2: 賃貸借契約
  • 99: その他
memo
string

予約メモ

document
string

予約ドキュメント

packagePlanName
string

プラン名

packagePlanCode
string

プランコード

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "building": {
    },
  • "listingId": 0,
  • "listing": {
    },
  • "listingRoomId": 0,
  • "listingRoom": {
    },
  • "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": {
    },
  • "contractType": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "qrCode": "string",
  • "qrCodeUrls": [
    ],
  • "qrCodeListUrl": "string",
  • "primaryReservationId": 0,
  • "payment": "string",
  • "redirectionUrlAfterPayment": "string",
  • "advancedCheckedInGuestUrl": "string",
  • "guest": {
    },
  • "payout": {
    },
  • "account": {
    },
  • "paymentUrls": [
    ],
  • "smartLockCodes": [
    ]
}

getReservation

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

Authorizations:
AuthToken
path Parameters
id
required
integer

予約ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "building": {
    },
  • "listingId": 0,
  • "listing": {
    },
  • "listingRoomId": 0,
  • "listingRoom": {
    },
  • "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": {
    },
  • "contractType": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "qrCode": "string",
  • "qrCodeUrls": [
    ],
  • "qrCodeListUrl": "string",
  • "primaryReservationId": 0,
  • "payment": "string",
  • "redirectionUrlAfterPayment": "string",
  • "advancedCheckedInGuestUrl": "string",
  • "guest": {
    },
  • "payout": {
    },
  • "account": {
    },
  • "paymentUrls": [
    ],
  • "smartLockCodes": [
    ]
}

updateReservation

idで指定した予約を更新します。

Authorizations:
AuthToken
path Parameters
id
required
integer

予約ID

Request Body schema: application/json
listingId
integer

物件ID

checkInDate
string <date>

チェックイン日(yyyy-MM-dd

checkOutDate
string <date>

チェックアウト日(yyyy-MM-dd

checkInTime
string or null

チェックイン予定時間(HH:mm:ss

checkOutTime
string or null

チェックアウト予定時間(HH:mm:ss

checkedInAt
string or null <date-time>

チェックイン日時(ISO 8601

checkedOutAt
string or null <date-time>

チェックアウト日時(ISO 8601

advancedCheckedInAt
string or null <date-time>

事前チェックイン日時(ISO 8601

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

契約形態

  • 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

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "building": {
    },
  • "listingId": 0,
  • "listing": {
    },
  • "listingRoomId": 0,
  • "listingRoom": {
    },
  • "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": {
    },
  • "contractType": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "qrCode": "string",
  • "qrCodeUrls": [
    ],
  • "qrCodeListUrl": "string",
  • "primaryReservationId": 0,
  • "payment": "string",
  • "redirectionUrlAfterPayment": "string",
  • "advancedCheckedInGuestUrl": "string",
  • "guest": {
    },
  • "payout": {
    },
  • "account": {
    },
  • "paymentUrls": [
    ],
  • "smartLockCodes": [
    ]
}

cancelReservation

idで指定した予約をキャンセルします。

Authorizations:
AuthToken
path Parameters
id
required
integer

予約ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "building": {
    },
  • "listingId": 0,
  • "listing": {
    },
  • "listingRoomId": 0,
  • "listingRoom": {
    },
  • "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": {
    },
  • "contractType": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "cancelledAt": "2019-08-24T14:15:22Z",
  • "qrCode": "string",
  • "qrCodeUrls": [
    ],
  • "qrCodeListUrl": "string",
  • "primaryReservationId": 0,
  • "payment": "string",
  • "redirectionUrlAfterPayment": "string",
  • "advancedCheckedInGuestUrl": "string",
  • "guest": {
    },
  • "payout": {
    },
  • "account": {
    },
  • "paymentUrls": [
    ],
  • "smartLockCodes": [
    ]
}

updateCheckReservation

idで指定した予約の物件・チェックイン日・チェックアウト日が変更可能かチェックします。

Authorizations:
AuthToken
path Parameters
id
required
integer

予約ID

Request Body schema: application/json
listingId
required
integer

物件ID

checkInDate
required
string <date>

チェックイン日(yyyy-MM-dd

checkOutDate
required
string <date>

チェックアウト日(yyyy-MM-dd

Responses

Request samples

Content type
application/json
{
  • "listingId": 0,
  • "checkInDate": "2019-08-24",
  • "checkOutDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "reservationId": 0,
  • "checkInDate": "2019-08-24",
  • "checkOutDate": "2019-08-24",
  • "isUpdatable": true,
  • "listingId": 0
}

updateGuest

idで指定した代表者を更新します。

Authorizations:
AuthToken
path Parameters
id
required
integer

予約ID

guestId
required
integer

代表者ID

Request Body schema: application/json
fullName
string

名前

fullNameFurigana
string

フリガナ(カタカナ・アルファベットで姓・名をスペース区切り)

email
string <email>

メールアドレス

phone
string

電話番号

postalCode
string

郵便番号

address
string

住所

prefecture
string [ 3 .. 4 ] characters

都道府県

country
string or null = 2 characters

国籍 (ISO 3166-1 alpha-2

region
integer or null
Enum: 1 2 3 4 5

大陸:

  • 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

地域:

  • 1 - オーストラリア・ニュージーランド
  • 2 - カリブ海諸国
  • 3 - 中央アメリカ
  • 4 - 中央アジア
  • 5 - 東アフリカ
  • 6 - 東アジア
  • 7 - 東ヨーロッパ
  • 8 - メラネシア
  • 9 - ミクロネシア
  • 10 - 中東アフリカ
  • 11 - 北アフリカ
  • 12 - 北アメリカ
  • 13 - 北ヨーロッパ
  • 14 - ポリネシア
  • 15 - 南アメリカ
  • 16 - 東南アジア
  • 17 - 南アフリカ
  • 18 - 南アジア
  • 19 - 南ヨーロッパ
  • 20 - 西アフリカ
  • 21 - 西アジア
  • 22 - 西ヨーロッパ

Responses

Request samples

Content type
application/json
{
  • "fullName": "string",
  • "fullNameFurigana": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "postalCode": "string",
  • "address": "string",
  • "prefecture": "stri",
  • "country": "st",
  • "region": 1,
  • "subregion": 1
}

Response samples

Content type
application/json
{
  • "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
}

updatePayout

idで指定した売上を更新します。

Authorizations:
AuthToken
path Parameters
id
required
integer

予約ID

payoutId
required
integer

売上ID

Request Body schema: application/json
currencyCode
string

通貨コード(ISO 4217

basePrice
number

宿泊料金

extrasPrice
number

清掃料金

serviceFee
number

予約チャネル手数料

userUsePoints
number

ポイント使用料

Responses

Request samples

Content type
application/json
{
  • "currencyCode": "string",
  • "basePrice": 0,
  • "extrasPrice": 0,
  • "serviceFee": 0,
  • "userUsePoints": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "nights": 0,
  • "currencyCode": "str",
  • "basePrice": 0,
  • "extrasPrice": 0,
  • "standardFee": 0,
  • "subtotal": 0,
  • "serviceFee": 0,
  • "total": 0,
  • "amountClaimed": 0,
  • "userUsePoints": 0
}

building

getBuildings

建物の一覧を取得します。

  • 並び順: created_at(作成日時昇順)
Authorizations:
AuthToken
query Parameters
offset
integer

開始位置

  • デフォルト値: 0
limit
integer

取得件数

  • デフォルト値: 100
  • 最大値: 1000

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

getBuilding

idで指定した施設の詳細を取得します。

Authorizations:
AuthToken
path Parameters
id
required
integer

施設ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

listing

getListings

物件の一覧を取得します。

  • 並び順: created_at(作成日時昇順)
Authorizations:
AuthToken
query Parameters
offset
integer

開始位置

  • デフォルト値: 0
limit
integer

取得件数

  • デフォルト値: 100
  • 最大値: 1000
building_id
integer

施設ID

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

getListing

idで指定した物件の詳細を取得します

Authorizations:
AuthToken
path Parameters
id
required
integer

物件のID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "propertyName": "string",
  • "published": true,
  • "memo": "string",
  • "licenseType": "hotel",
  • "platformListings": [
    ],
  • "buildingId": 0
}

getInventories

idで指定した物件の在庫一覧を取得します。

Authorizations:
AuthToken
path Parameters
id
required
integer

物件ID

query Parameters
start_date
required
string <date>

絞り込み範囲開始日(yyyy-MM-dd

end_date
required
string <date>

絞り込み範囲終了日(yyyy-MM-dd

Responses

Response samples

Content type
application/json
{
  • "listingId": 0,
  • "days": [
    ]
}

postInventories

idで指定した物件の在庫を更新

Authorizations:
AuthToken
path Parameters
id
required
integer

物件のID

Request Body schema: application/json
startDate
required
string <date>

更新範囲開始日(yyyy-MM-dd

endDate
required
string <date>

更新範囲開始日(yyyy-MM-dd

available
required
integer

在庫状況

  • 0 - 在庫なし
  • 1 - 在庫あり
comment
string

コメント

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "available": 0,
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "listingId": 0,
  • "days": [
    ]
}

listingRoom

getListingRooms

部屋の一覧を取得します。

  • 並び順: created_at(作成日時昇順)
Authorizations:
AuthToken
query Parameters
offset
integer

開始位置

  • デフォルト値: 0
limit
integer

取得件数

  • デフォルト値: 100
  • 最大値: 1000
building_id
integer

施設ID

listing_id
integer

物件ID

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

getListingRoom

idで指定した部屋の詳細を取得します。

Authorizations:
AuthToken
path Parameters
id
required
integer

部屋ID

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "wifiSsid": "string",
  • "wifiPassword": "string",
  • "listingId": 0
}

channel

getChannels

予約チャネルの一覧を取得します。

Authorizations:
AuthToken

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]