KEYVOX API | 予約詳細API一覧

Download OpenAPI specification:

予約詳細

場所一覧取得

Bacsに登録されている場所一覧を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

page required	integer ページ番号
count required	integer １ページ件数
placeType	string 場所カテゴリ "hotel":ビルディング、"locker":ロッカー、"doubleLocker":両面開きロッカー、"vendingMachine":自動販売機

Responses

Request samples

Payload

Content type

application/json

{"page": 0,
"count": 20,
"placeType": "hotel"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"currPage": 0,
"pageSize": 20,
"totalCount": 115,
"totalPage": 6,
"list": [{"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"placeName": "〇〇ホテル渋谷店",
"placeTelephone": "03-1234-5678",
"placeAddress": "東京島渋谷区渋谷１－１６",
"placeDesc": "東京島渋谷区渋谷１－１６",
"placeType": "hotel",
"placeState": "0",
"placePublic": "1",
"placeLogoImg": "https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png",
"placeBackgroundColor": "#00AFEC",
"placeFontColor": "#FFFFFF",
"placeLat": 31.230416,
"placeLong": 121.473701,
"placeCheckin": 0,
"placeCheckout": 0,
"placeImg": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
]
}
]
}
}

場所詳細情報取得

Bacsに登録されている場所の詳細情報を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId

required

string

場所ID

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"placeName": "〇〇ホテル渋谷店",
"placeTelephone": "03-1234-5678",
"placeAddress": "東京島渋谷区渋谷１－１６",
"placeDesc": "東京島渋谷区渋谷１－１６",
"placeType": "hotel",
"placeState": "0",
"placePublic": "1",
"placeLogoImg": "https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png",
"placeBackgroundColor": "#00AFEC",
"placeFontColor": "#FFFFFF",
"placeLat": 31.230416,
"placeLong": 121.473701,
"placeCheckin": 1637573068,
"placeCheckout": 1637573068,
"placeImg": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
]
}
}

部屋プラン一覧取得

Bacsに登録されている部屋プラン一覧を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
page required	integer ページ番号
count required	integer １ページ件数

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"page": 0,
"count": 20
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"currPage": 0,
"pageSize": 20,
"totalCount": 115,
"totalPage": 6,
"list": [{"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityDesc": "plan description",
"commodityCategory": "Plan",
"businessType": "housing",
"releaseType": "1",
"reserveIntervalUnit": "minute",
"reserveIntervalNum": 1,
"minTerm": "hour",
"minTermNum": 1,
"retainApproval": 0,
"verifyLevel": 0,
"stockType": 0,
"commodityPrice": 200,
"priceTax": 0
}
]
}
}

部屋プラン詳細取得

指定プラン詳細情報、および在庫状況を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
commodityId required	string 部屋プランID
targetType	string プランタイプ "order":予約 "order"で指定された場合、「貸出不可時間」を返却する

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"commodityId": "5f35065f968a8874400fb230",
"targetType": "order"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityDesc": "null",
"commodityCategory": "Plan",
"businessType": "housing",
"releaseType": "1",
"reserveIntervalUnit": "minute",
"reserveIntervalNum": 1,
"minTerm": "plan description",
"minTermNum": 1,
"unitNum": 2,
"availableTimeList": [{"id": "5ce64111625ef161c82acfde",
"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"availableWeek": 96,
"fromTime": 0,
"toTime": 0
}
],
"unavailableTimeList": [{"checkin": 0,
"checkout": 0
}
],
"retainApproval": 0,
"verifyLevel": 0,
"stockType": 0,
"commodityPrice": 200,
"priceTax": 0,
"hasLodgingTax": 0,
"reserveMaxTime": 0,
"reserveEarlyTime": 0,
"planQrUrl": "https://keyvoxgo.page.link/mpvW",
"planQrImgUrl": "https://it01.keyvox.co/download/img/account/share/qrcode/202011121053000492462084677.png",
"commodityList": [{"commodityId": "5ce64111625ef161c82acfde",
"commodityName": "朝食",
"commodityCategory": "5dbab6b4ef16f9770d09a550",
"commodityNum": 1,
"commodityPrice": 0,
"priceTax": 0,
"hasLodgingTax": 0
}
],
"bacsDefaultSetting": {"defaultSettingId": "5dbab6b4ef16f9770d09a550",
"delayFlag": 0,
"changeFlag": 0,
"memberList": [{"memberId": "5dbab6b4ef16f9770d09a550",
"memberType": "group",
"memberName": "test"
}
],
"payTypeList": [{"payTypeCode": "OfflinePayment",
"payTypeName": "オフライン払い",
"payTypeStatus": 0
}
]
}
}
}

部屋一覧取得

Bacsに登録されている部屋一覧を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
page required	integer ページ番号
count required	integer １ページ件数
searchWord	string 検索キーワード
unitBusinessType	string ビジネスタイプ "housing":宿泊、 "rentalSpace":レンタルスペース、 "conferenceRoom":コーワーキング、 "locker":ロッカー、 "airdrop":ドロップイン、 "vendingMachine":自動販売機

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"page": 0,
"count": 20,
"searchWord": "埼玉",
"unitBusinessType": "housing"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"totalPage": 6,
"totalCount": 115,
"pageSize": 20,
"currPage": 0,
"list": [{"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"placeName": "〇〇ホテル渋谷店",
"placeAddress": "東京島渋谷区渋谷１－１６",
"unitId": "5db10292ef16f96af51b7b73",
"unitActive": 1,
"unitDesc": "東京島渋谷区渋谷１－１６",
"unitLendingMax": 24,
"unitLendingMin": 1,
"unitLendingTerm": 1,
"unitLendingType": "lendWithPlan",
"unitLendingUnit": "day",
"unitLimitNum": 2,
"unitName": "ブース〇〇",
"unitNo": "品川民泊2",
"unitOccupancy": 1,
"unitPrice": 500,
"unitPriceTax": 0,
"unitState": "I",
"unitTypeActive": 1,
"unitTypeId": "618b660eb13f486b5e00d63b",
"unitTypeState": 0,
"userNum": 0,
"verifyLevel": 1,
"deviceNum": 1,
"groupNum": 0,
"hasLodgingTax": 0,
"limitNum": 0,
"reserveApproval": 0,
"reserveIntervalNum": 1,
"stockType": 0,
"stockUnit": 0,
"unitImg": ["null"
]
}
]
}
}

予約作成

予約を新規作成します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
orderSource required	string 予約サイト名(システム名)
channelOrderNo	string 予約サイト予約番号
userId	string 会員ID
checkin required	integer チェックイン時間 UNIX時間（秒）
checkout required	integer チェックアウト時間 UNIX時間（秒）
orderContact required	string お客様氏名
contactAddress	string お客様住所
contactCertificateNum	string お客様証明書ID
contactCountry	string お客様国コード
contactEmail	string お客様メールアドレス
contactGender	string お客様性別 "M":男、"F":女
contactPinyin	string お客様名ふりがな
contactTel	string お客様電話番号
customerNum required	integer 人数
maleNum	integer 人数（男性）
femaleNum	integer 人数（女性）
payTypeCode required	string 支払方法 "stripeCreditCard":クレジットカード、"OfflinePayment":オフライン決済、"cash":現金
paymentMethod	string stripe支付方法・　payTypeCode="stripeCreditCard"の場合、Stripe側の支払方法ID ・　上記外の場合、未利用
earlyTime required	integer アーリーチェックイン単位（分）、指定必要。特別な要件がなければ、0をセットしてください。
extendTime required	integer 延長チェックアウト単位（分）、指定必要。特別な要件がなければ、0をセットしてください。
required	Array of objects (CommodityDataIn) 商品リスト
	Array of objects (PayDataIn) 支払情報
unitNum required	integer ドア数量
	Array of objects (OrderUnitDataIn) ドア情報
	Array of objects (OrderTenantCreateIn) 同行者情報

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"orderSource": "楽天トラベル",
"channelOrderNo": "123456789",
"userId": "5fe15ae6bb2f0c41e382c7c1",
"checkin": 1635832800,
"checkout": 1635901200,
"orderContact": "山田太郎",
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNum": "21634161354",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactPinyin": "lxy",
"contactTel": "090-1234-5678",
"customerNum": 1,
"maleNum": 0,
"femaleNum": 0,
"payTypeCode": "stripeCreditCard",
"paymentMethod": "pm_1JwKcOInYjCWEx8ccnE5Ljkd",
"earlyTime": 30,
"extendTime": 15,
"commodityList": [{"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityCategory": "Plan",
"commodityDate": 1637733600,
"commodityNum": 1,
"unitId": "5db10292ef16f96af51b7b73",
"price": 12,
"priceTax": 1,
"parentRelateId": "5db10292ef16f96af51b7b73",
"parentId": "5db10292ef16f96af51b7b73"
}
],
"payList": [{"unitId": "5db10292ef16f96af51b7b73",
"payDate": 1637733600,
"payMoney": 500,
"payTypeCode": "stripeCreditCard",
"payor": "payor",
"ticketNum": "123456"
}
],
"unitNum": 1,
"unitList": [{"unitId": "5db10292ef16f96af51b7b73",
"checkin": 1635832800,
"checkout": 1635901200,
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNo": "123456",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactName": "test",
"contactPinyin": "lxy",
"contactTelephone": "4512345678",
"customerNum": 1,
"femaleNum": 0,
"maleNum": 0,
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
]
}
],
"tenantList": [{"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"tenantEmail": "test@test.com",
"tenantName": "test",
"unitId": "5db10292ef16f96af51b7b73"
}
]
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"orderId": "EAIQNXSBZ",
"orderSource": "楽天トラベル",
"channelOrderNo": "123456789",
"userId": "5fe15ae6bb2f0c41e382c7c1",
"checkin": 1635832800,
"checkout": 1635901200,
"orderContact": "山田太郎",
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNum": "21634161354",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactPinyin": "lxy",
"contactTel": "090-1234-5678",
"customerNum": 1,
"maleNum": 0,
"femaleNum": 0,
"orderMoney": 112,
"orderTaxMoney": 100,
"orderStateCode": "A",
"payTypeCode": "stripeCreditCard",
"payMoney": 500,
"payStateCode": "0",
"commodityList": [{"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityCategory": "Plan",
"commodityDate": 1637733600,
"commodityNum": 1,
"unitId": "5db10292ef16f96af51b7b73",
"price": 12,
"priceTax": 1,
"taxPrice": 100,
"hasLodgingTax": 0,
"lodgingTax": 0,
"totalPrice": 12,
"orderCommodityId": "5db10292ef16f96af51b7b73",
"parentId": "5db10292ef16f96af51b7b73"
}
],
"payList": [{"unitId": "5db10292ef16f96af51b7b73",
"payDate": 1635832800,
"payMoney": 500,
"payTypeCode": "stripeCreditCard",
"payor": "payor",
"ticketNum": "123456",
"transId": "5fd06917d9c30335d8a3d725"
}
],
"unitNum": 2,
"unitList": [{"unitId": "5db10292ef16f96af51b7b73",
"checkin": 1635832800,
"checkout": 1635901200,
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNo": "123456",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactName": "test",
"contactPinyin": "lxy",
"contactTelephone": "4512345678",
"customerNum": 1,
"femaleNum": 0,
"maleNum": 0,
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"orderUnitId": "5db10292ef16f96af51b7b73"
}
],
"tenantList": [{"id": "61973277d831165201799e64",
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"tenantEmail": "test@test.com",
"tenantName": "test",
"unitId": "5db10292ef16f96af51b7b73"
}
]
}
}

予約変更

予約を変更します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

orgId required	string 組織ID
placeId required	string 場所ID
orderId required	string 注文番号
orderSource	string 予約サイト名(システム名)
channelOrderNo	string 予約サイト予約番号
userId	string 会員ID
checkin required	integer チェックイン時間 UNIX時間（秒）
checkout required	integer チェックアウト時間 UNIX時間（秒）
orderContact required	string お客様氏名
contactAddress	string お客様住所
contactCertificateNum	string お客様証明書ID
contactCountry	string お客様国コード
contactEmail	string お客様メールアドレス
contactGender	string お客様性別 "M":男、"F":女
contactPinyin	string お客様名ふりがな
contactTel	string お客様電話番号
customerNum required	integer 人数
maleNum	integer 人数（男性）
femaleNum	integer 人数（女性）
payTypeCode required	string 支払方法 "stripeCreditCard":クレジットカード、 "OfflinePayment":オフライン決済、 "cash":現金
paymentMethod	string stripe支付方法・　payTypeCode="stripeCreditCard"の場合、Stripe側の支払方法ID ・　上記外の場合、未利用
earlyTime required	integer アーリーチェックイン単位（分）、指定必要。特別な要件がなければ、0をセットしてください。
extendTime required	integer 延長チェックアウト単位（分）、指定必要。特別な要件がなければ、0をセットしてください。
required	Array of objects (CommodityUpdateIn) 商品リスト商品が更新されていない場合でも入力必須
	Array of objects (PayUpdateIn) 支払情報
unitNum required	integer ドア本数
required	Array of objects (OrderUnitUpdateIn) ドア情報ドア情報が変更されていない場合、unitListは省略可
	Array of objects (OrderTenantUpdateIn) 入居者情報

Responses

Request samples

Payload

Content type

application/json

{"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"orderId": "EAIQNXSBZ",
"orderSource": "楽天トラベル",
"channelOrderNo": "123456789",
"userId": "5fe15ae6bb2f0c41e382c7c1",
"checkin": 1635832800,
"checkout": 1635901200,
"orderContact": "山田太郎",
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNum": "21634161354",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactPinyin": "lxy",
"contactTel": "090-1234-5678",
"customerNum": 1,
"maleNum": 0,
"femaleNum": 0,
"payTypeCode": "stripeCreditCard",
"paymentMethod": "pm_1JwKcOInYjCWEx8ccnE5Ljkd",
"earlyTime": 30,
"extendTime": 15,
"commodityList": [{"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityCategory": "Plan",
"commodityDate": 1637733600,
"commodityNum": 1,
"unitId": "5db10292ef16f96af51b7b73",
"price": 12,
"priceTax": 1,
"orderCommodityId": "5db10292ef16f96af51b7b73",
"parentRelateId": "5db10292ef16f96af51b7b73",
"parentId": "5db10292ef16f96af51b7b73",
"operation": "add"
}
],
"payList": [{"unitId": "5db10292ef16f96af51b7b73",
"payDate": 1637733600,
"payMoney": 500,
"payTypeCode": "stripeCreditCard",
"payor": "payor",
"ticketNum": "123456",
"transId": "5fd0691fd9c30335d8a3d748",
"operation": "add"
}
],
"unitNum": 2,
"unitList": [{"unitId": "5db10292ef16f96af51b7b73",
"checkin": 1635832800,
"checkout": 1635901200,
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNo": "123456",
"contactCountry": "CN",
"contactEmail": "test@test.com",
"contactGender": "M",
"contactName": "test",
"contactPinyin": "lxy",
"contactTelephone": "4512345678",
"customerNum": 1,
"femaleNum": 0,
"maleNum": 0,
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"orderUnitId": "5db10292ef16f96af51b7b73",
"operation": "add"
}
],
"tenantList": [{"id": "61973277d831165201799e64",
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"tenantEmail": "test@test.com",
"tenantName": "test",
"unitId": "5db10292ef16f96af51b7b73",
"operation": "add"
}
]
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"orderId": "EAIQNXSBZ",
"orderSource": "楽天トラベル",
"channelOrderNo": "123456789",
"userId": "5fe15ae6bb2f0c41e382c7c1",
"checkin": 1635832800,
"checkout": 1635901200,
"orderContact": "山田太郎",
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNum": "21634161354",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactPinyin": "lxy",
"contactTel": "090-1234-5678",
"customerNum": 1,
"maleNum": 0,
"femaleNum": 0,
"orderMoney": 112,
"orderTaxMoney": 100,
"orderStateCode": "A",
"payTypeCode": "stripeCreditCard",
"payMoney": 500,
"payStateCode": "0",
"earlyTime": 0,
"extendTime": 0,
"commodityList": [{"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityCategory": "Plan",
"commodityDate": 1637733600,
"commodityNum": 1,
"unitId": "5db10292ef16f96af51b7b73",
"price": 12,
"priceTax": 1,
"taxPrice": 100,
"hasLodgingTax": 0,
"lodgingTax": 0,
"totalPrice": 12,
"orderCommodityId": "5db10292ef16f96af51b7b73",
"parentId": "5db10292ef16f96af51b7b73"
}
],
"payList": [{"unitId": "5db10292ef16f96af51b7b73",
"payDate": 1637733600,
"payMoney": 500,
"payTypeCode": "stripeCreditCard",
"payor": "payor",
"ticketNum": "123456",
"transId": "5fd06917d9c30335d8a3d725"
}
],
"unitNum": 2,
"unitList": [{"unitId": "5db10292ef16f96af51b7b73",
"checkin": 1635832800,
"checkout": 1635901200,
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNo": "123456",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactName": "test",
"contactPinyin": "lxy",
"contactTelephone": "090-1234-5678",
"customerNum": 1,
"femaleNum": 0,
"maleNum": 0,
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"orderUnitId": "5db10292ef16f96af51b7b73"
}
],
"tenantList": [{"id": "61973277d831165201799e64",
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"tenantEmail": "test@test.com",
"tenantName": "test",
"unitId": "5db10292ef16f96af51b7b73"
}
]
}
}

予約一覧取得

指定条件より、予約一覧を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
fromDate required	integer 開始日 UNIX時間（秒）
toDate required	integer 終了日 UNIX時間（秒）
isAssigned	string 割当フラグ null:未設定、0:未割当、1:割当済み
total	integer トータル区分 0:すべて、1:（キャンセル・チェックアウト）以外
searchWord	string 検索キーワード
orderStateCodeList	Array of strings 注文ステータス配列である。"Q":予約申込、"B":予約拒否、"A":未チェックイン、 "C":キャンセル済み、 "I":チェックイン済み、 "M":メンテ中、"O":チェックアウト済み
payStateCodeList	Array of strings 支払ステータス配列である。"0":未支払、"2":支払中、"30":一部支払済、"20":支払完了、"40":支払失敗
stateType	integer 注文ステータス "0":通常、"1":重要
count required	integer １ページ件数
page	integer ページ番号

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"fromDate": 1635832800,
"toDate": 1635901200,
"isAssigned": "1",
"total": 0,
"searchWord": "埼玉",
"orderStateCodeList": ["A"
],
"payStateCodeList": ["0"
],
"stateType": 2,
"count": 20,
"page": 0
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"currPage": 0,
"pageSize": 20,
"totalCount": 115,
"totalPage": 6,
"list": [{"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"placeName": "〇〇ホテル渋谷店",
"unitId": "5db10292ef16f96af51b7b73",
"unitNo": "品川民泊2",
"unitName": "ブース〇〇",
"unitNum": 2,
"unitTypeId": "618b660eb13f486b5e00d63b",
"unitType": "東池袋オフィス（6名用）",
"orderId": "EAIQNXSBZ",
"adjustment": 0,
"adultNum": 0,
"businessType": "housing",
"channelCode": "BACS",
"channelOrderNo": "123456789",
"checkin": 1635832800,
"checkout": 1635901200,
"childNum": 0,
"contactTel": "090-1234-5678",
"customerNum": 1,
"isAssigned": 1,
"limitNum": 0,
"livedDays": 1,
"mailSent": 1,
"notPayMoney": 112,
"operationPermit": 0,
"orderContact": "山田太郎",
"orderMoney": 112,
"orderStateCode": "A",
"orderUnitId": "619c807cb13f486b96ef991c",
"orderUnitMoney": 112,
"orderUnitState": "A",
"payStateCode": "0",
"reserveDays": 2,
"reserveTime": 1637646462,
"selfVerify": 0,
"shareId": 0,
"stateType": 0,
"stockType": 0
}
]
}
}

予約詳細取得

予約の詳細情報を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
unitId	string ドアID
orderId required	string 注文番号

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dc02d9557a9445018f12605",
"unitId": "5db10292ef16f96af51b7b73",
"orderId": "EAIQNXSBZ"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"orgId": "5dc02d9557a9445018f12605",
"placeId": "5dbab6b4ef16f9770d09a550",
"placeName": "〇〇ホテル渋谷店",
"orderId": "EAIQNXSBZ",
"adjustment": 0,
"adultNum": 0,
"businessType": "housing",
"cancelOrderPayFlag": 0,
"channelCode": "BACS",
"channelOrderNo": "123456789",
"checkin": 1635832800,
"checkout": 1635901200,
"childNum": 0,
"commodityList": [{"placeId": "5dbab6b4ef16f9770d09a550",
"unitId": "5db10292ef16f96af51b7b73",
"commodityId": "5f35065f968a8874400fb230",
"commodityName": "plan1",
"commodityNum": 1,
"commodityPrice": 12,
"commodityCategory": "Plan",
"commodityDate": 1637733600,
"businessType": "housing",
"checkin": 1635832800,
"checkout": 1635901200,
"earlyCheckIn": 2880,
"hasLodgingTax": 0,
"lendTerm": "day",
"lodgingTax": 0,
"maxHourNum": 24,
"orderCommodityId": "619ddc11b13f486b96efa41b",
"parentId": "619ddc11b13f486b96efa41b",
"price": 12,
"priceTax": 1,
"stockType": 0,
"taxPrice": 100,
"taxRate": 0.1,
"totalPrice": 12
}
],
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNum": "21634161354",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactPinyin": "lxy",
"contactTel": "090-1234-5678",
"customerNum": 1,
"earlyTime": 15,
"extendTime": 3,
"femaleNum": 0,
"isAssigned": 1,
"lendTerm": "day",
"light1": 0,
"light2": 0,
"light3": 0,
"lodgingTax": 0,
"mailSent": 1,
"maleNum": 0,
"operationPermit": 0,
"orderContact": "山田太郎",
"orderMoney": 112,
"orderSource": "楽天トラベル",
"orderStateCode": "A",
"orderTaxMoney": 100,
"payId": "5e01b482bb2f0c278b5da0b7",
"payList": [{"unitId": "5db10292ef16f96af51b7b73",
"unitName": "ブース〇〇",
"unitNo": "品川民泊2",
"bclAmount": 30,
"createTime": 1635832800,
"isSynchronized": 0,
"payDate": 1635832800,
"payMoney": 500,
"payTypeCode": "stripeCreditCard",
"paymentExpireTime": 1635832800,
"payor": "test",
"ticketNum": "123456",
"transId": "5fd0691ed9c30335d8a3d746",
"transSource": "TBD"
}
],
"payMoney": 100,
"payStateCode": "0",
"payTypeCode": "stripeCreditCard",
"paymentFail": 0,
"placeAddress": "東京島渋谷区渋谷１－１６",
"realCheckin": 1635832800,
"realCheckout": 1635932800,
"reserveTime": 1637646462,
"selfVerify": 0,
"shareId": "619c807db64f2c2594f1168c",
"shareUrl": "https://it01.keyvox.co/sl/Y9FhmUhi",
"stateType": "0",
"stockType": 0,
"subtotalPrice": 500,
"systemTime": 1635832800,
"unitAssigner": "owner",
"unitNum": 2,
"updateTime": 1635832800,
"urlKey": "https://iturlkey.keyvox.co/619dfe15b64f2c2594f11736/C913A6A",
"tenantList": [{"id": "61973277d831165201799e64",
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"tenantEmail": "test@test.com",
"tenantName": "test"
}
],
"unitList": [{"unitId": "5db10292ef16f96af51b7b73",
"unitNo": "品川民泊2",
"unitTypeId": "618b660eb13f486b5e00d63b",
"unitType": "新中野オフィス（4名用）",
"unitPriceTax": 0,
"unitTypeActive": 1,
"adultNum": 0,
"checkin": 1635832800,
"checkout": 1635901200,
"childNum": 0,
"contactAddress": "千葉県千葉市美浜区",
"contactCertificateNo": "123456",
"contactCountry": "CN",
"contactEmail": "1261117576@qq.com",
"contactGender": "M",
"contactName": "test",
"contactPinyin": "lxy",
"contactTelephone": "090-1234-5678",
"customerNum": 1,
"deviceList": [{"deviceId": "000D6F0012FBE252",
"ble": "F65554B8639F",
"deviceImg": "https://eco.blockchainlock.io/download/img/iot/module/BCL-XP1.png",
"deviceName": "BCL-XE1 #0768",
"historyRecord": 1,
"moduleId": "1004",
"reservePinUnlock": "1",
"reserveRemoteUnlock": "1"
}
],
"endTime": 1635832800,
"femaleNum": 0,
"hasStock": 1,
"imgList": ["https://eco.blockchainlock.io/download/img/619da2500cc45465bb926dc5.png"
],
"maleNum": 0,
"minTermNum": 1,
"orderUnitId": "619c807cb13f486b96ef991c",
"orderUnitMoney": 112,
"orderUnitState": "A",
"payUnitMoney": 0,
"placeLat": 0,
"placeLong": 0,
"priceTax": 1,
"releaseType": 1,
"retainApproval": 0,
"startTime": 1635832800,
"stockType": 0,
"verifyLevel": 1,
"unitPinList": [{"orderId": "EAIQNXSBZ",
"createTime": 1635832800,
"downloadUrl": "http://it01.keyvox.co/bcllock/keyvoxShare/index.html",
"endTime": 1635832800,
"panelPin": "1#123456",
"pin": "123456",
"pinStatus": "1"
}
],
"placeAddress": "東京島渋谷区渋谷１－１６",
"placeName": "〇〇ホテル渋谷店",
"qrCode": "MK12A795D6036745A44F57FA03E4A540D3LKC368D78AF44A89A88DEE31BD6608C5E8",
"qrUrl": "https://it01.keyvox.co/download/img/qr//5dc02d9557a9445018f12601/5e1e71bebb2f0c6544d272fa/order/qrcode/20211124/2MC5UKuGfc.png",
"shareUrl": "https://it01.keyvox.co/sl/Y9FhmUhi"
}
]
}
}

チェックイン

利用開始前に、チェックイン処理を実施します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
orderId required	string 注文番号
unitId required	string ドアID

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"orderId": "EAIQNXSBZ",
"unitId": "5db10292ef16f96af51b7b73"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": 1
}

チェックアウト

利用終了後に、チェックアウト処理を実施します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
orderId required	string 注文番号
unitId required	string ドアID

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"orderId": "EAIQNXSBZ",
"unitId": "5db10292ef16f96af51b7b73"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": 1
}

予約キャンセル

予約をキャンセルします。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

placeId required	string 場所ID
orderId required	string 注文番号

Responses

Request samples

Payload

Content type

application/json

{"placeId": "5dbab6b4ef16f9770d09a550",
"orderId": "EAIQNXSBZ"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": 1
}

空き部屋一覧取得

場所内の空き部屋一覧を取得します。

header Parameters

x-target-host required	string default.pms
date required	string RFC-1123 Ex: Mon, 20 Sep 2021 13:16:39 GMT
digest required	string Sha256 summary of the body part (base64 encoding)
authorization required	string Hmac256 authentication header.

Request Body schema: application/json
required

入力パラメータ

fromTime required	integer from時間 UNIX時間（秒）
toTime required	integer to時間 UNIX時間（秒）
placeId	string 場所ID

Responses

Request samples

Payload

Content type

application/json

{"fromTime": 1652976000,
"toTime": 1653062400,
"placeId": "60d044901d9b6750a89c8a83"
}

Response samples

Content type

application/json

{"code": "0",
"msg": "success",
"data": {"unitAvailableList": [{"placeId": "60d044901d9b6750a89c8a83",
"placeName": "〇〇ホテル渋谷店",
"unitId": "6246956fb13f485b37243112",
"unitName": "库存1"
}
]
}
}

KEYVOX API | 予約詳細API一覧

予約詳細

場所一覧取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

場所詳細情報取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

部屋プラン一覧取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

部屋プラン詳細取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

部屋一覧取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

予約作成

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

予約変更

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

予約一覧取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

予約詳細取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

チェックイン

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

チェックアウト

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

予約キャンセル

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

空き部屋一覧取得

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required