Property Connector PC Integration API

TABLE OF CONTENTS

概述
1. 创建/更新房型
- 请求
- 示例
2. 查询房型:
- 查询指定房型
- 示例
3. 创建/更新房型等级
- 请求
- 示例:
4. 查询房型等级
5. 创建/更新房价计划
- 请求
- 示例:
6. 查询房价计划
- 示例:
- 示例:
7. 创建税费
- 请求
- 示例:
8 查询税费
- 示例:
- 示例:
9. 创建产品
- 请求
- 示例:
10. 查询产品
- 示例:

概述

我们提供了 10 个接口静态信息接口(包括房价计划、房型、税费)。您可以通过这些接口实现创建、修改、查询房价计划、房型、税费。

创建房型：通过接口创建房型。如果房型代码已经存在则更新此房型信息。
查询房型：查询酒店所有房型。
创建房型等级：通过接口创建房型等级。如果房型等级代码已经存在则更新此房型等级信息。房型等级是房型的集合。
查询房型等级：查询酒店所有房型等级。
创建房价计划：通过接口创建房价计划。如果房价计划代码已经存在则更新此房价计划信息。
查询房价计划：查询酒店所有房价计划。
创建税费：通过接口创建税费。如果房价计划代码已经存在则更新此税费信息。
查询税费：查询酒店所有税费。
创建产品：通过接口将房型和房价计划关联生成产品。
查询产品：查询酒店所有产品。

1. 创建/更新房型

此 API 用于在 Property Connector 中创建新的房型。当房型创建后 PropertyConnector 将会收到 PMS 推送的房型信息。房型信息可以通过接口或 PropertyConnector 页面创建。如果房型 ID 已经存在，则更新指定房型的信息。

POST /pcapigateway/profile/{accountId}/hotels/{hotelId}/roomTypes/{roomId} HTTP/1.1
 Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc 
Accept-Encoding: gzip 
Content-Encoding: gzip 
Content-Type: application/json;charset=utf-8

请求

Element	Type	Occurrence	Comment
occupancy/maxAdult	String	Mandatory	0～20、maxAdult<=maxOccupancy
occupancy/maxChild	String	Mandatory	0～20、maxChild<=maxOccupancy
occupancy/maxOccupancy	String	Mandatory	0～20
roomClassId	String	Optional
roomDescription	String	Optional
roomId	String	Mandatory
roomName	String	Mandatory
status	Enum Actived Deactived	Mandatory

示例:创建或更新房型

请求:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomId": "DR",
	"roomClassId": "DRCS",
	"status": "Actived",
	"roomName": "Double Room",
	"roomDescription": "Double Room Description",
	"occupancy": {
		"maxAdult": "2",
		"maxChild": "1",
		"maxOccupancy": "3"
	}
}

成功响应

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomId": "DR",
	"roomClassId": "DRCS",
	"status": "Actived",
	"roomName": "Double Room",
	"roomDescription": "Double Room Description",
	"occupancy": {
		"maxAdult": "2",
		"maxChild": "1",
		"maxOccupancy": "3"
	}
}

2. 查询房型:

查询指定房型

此 API 查询酒店在 PropertyConnector 中指定的房型信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/roomTypes/{roomId} HTTP/1.1
 Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc 
Accept-Encoding: gzip 
Content-Encoding: gzip 
Content-Type: application/json;charset=utf-8

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomId": "KINGR",
	"roomClassId": "DRCS",
	"status": "Actived",
	"roomName": "King Room",
	"roomDescription": "King Room Description",
	"occupancy": {
		"maxAdult": "3",
		"maxChild": "1",
		"maxOccupancy": "4"
	}
}

查询全部房型:

此 API 查询酒店在 PropertyConnector 中全部存在的房型信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/roomTypes HTTP/1.1
 Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc 
Accept-Encoding: gzip 
Content-Encoding: gzip 
Content-Type: application/json;charset=utf-8

示例

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomList": [{
			"roomId": "KINGR",
			"roomClassId": "DRCS",
			"status": "Actived",
			"roomName": "King Room",
			"roomDescription": "King Room Description",
			"occupancy": {
				"maxAdult": "3",
				"maxChild": "1",
				"maxOccupancy": "4"
			}
		},
		{
			"roomId": "DR",
			"roomClassId": "DRCS",
			"status": "Actived",
			"roomName": "Double Room",
			"roomDescription": "Double Room Description",
			"occupancy": {
				"maxAdult": "2",
				"maxChild": "1",
				"maxOccupancy": "3"
			}
		}
	]
}

3. 创建/更新房型等级

此 API 用于创建房型等级，房间等级是房型的集合。如果房型等级 ID 已经存在，则更新指定房型的信息。

POST /pcapigateway/profile/{accountId}/hotels/{hotelId}/roomClasses/{roomClassId} HTTP/1.1
 Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc 
Accept-Encoding: gzip 
Content-Encoding: gzip 
Content-Type: application/json;charset=utf-8

请求

Element	Type	Occurrence
roomClassId	String	Mandatory
roomClassName	String	Mandatory
status	Enum Actived Deactived	Mandatory

示例:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomClassId": "DRCS",
	"roomClassName": "Deluxe King Room",
	"status": "Actived"
}

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomClassId": "DRCS",
	"roomClassName": "Deluxe King Room",
	"status": "Actived"
}

4. 查询房型等级

查询指定房型等级

此 API 查询酒店在 PropertyConnector 中指定的房型等级信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/roomClasses/{roomClassId} HTTP/1.1
 Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc 
Accept-Encoding: gzip 
Content-Encoding: gzip 
Content-Type: application/json;charset=utf-8

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomClassId": "DRCS",
	"roomClassName": "Deluxe King Room",
	"status": "Deactived"
}

查询全部房型等级

此 API 查询酒店在 PropertyConnector 中全部存在的房型等级信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/roomClasses HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

响应

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"roomClassList": [{
			"roomClassId": "DRCS",
			"roomClassName": "Deluxe Room",
			"status": "Actived",
		},
		{
			"roomClassId": "DKCS",
			"roomClassName": "King Room",
			"status": "Actived"
		}
	]
}

5. 创建/更新房价计划

此 API 用于在 Property Connector 中创建新的房价计划。当房价计划创建后 PropertyConnector 将会收到 PMS 推送的房价计划信息。房价计划信息可以通过接口或 PropertyConnector 页面创建。如果房价计划 ID 已经存在，则更新指定房型计划的信息。

POST /pcapigateway/profile/{accountId}/hotels/{hotelId}/ratePlans/{rateId} HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

请求

Element	Type	Occurrence	Description	Comment
rateId	String	Mandatory
status	Enum Actived Deactived Presale	Mandatory
rateName	String	Mandatory
rateDescription	String	Optional
rateType	Enum AmountBeforeTax AmountAfterTax Both	Mandatory
paymentType	Enum PayNow PayLater	Mandatory		PayNow: prepay online PayLater: pay at hotel
priceType	Enum NetPrice SellPrice	Optional
guaranteeType	Enum CCG GTTA GTC GTP NG	Optional		Credit Card Guarantee GTTA: Guarantee to Travel Agent GTC: Guarantee to Company GTP: Guarantee to Property NG: No Guarantee/Direct Bill
defaultMealPlan	String	Mandatory		Meal Plan
currency	String	Mandatory	Currency code with ISO 4217 standard
defaultCancelPolicy	Object[CancelPolicy]	Mandatory
defaultCancelPolicy/cancelPolicy/code		Mandatory		Cancel Policy
defaultCancelPolicy/cancelPolicy/description		Optional
cancelPolicies	List[CancelPolicyWithDateRange]	Optional
cancelPolicies/dateRange/startDate	Date:yyyy-MM-dd	Mandatory
cancelPolicies/dateRange/endDate	Date:yyyy-MM-dd	Mandatory
cancelPolicies/cancelPolicy/code		Mandatory		Appendix - Cancel Policy
cancelPolicies/cancelPolicy/description		Optional

示例:

请求:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"rateId": "IDDRNWED",
	"status": "Actived",
	"rateName": "Weekend Rate Room Only",
	"rateDescription": "Weekend Rate Room Only",
	"rateType": "AmountBeforeTax",
	"priceType": "SellPrice",
	"paymentType": "PayLater",
	"guaranteeType": "GCC",
	"defaultMealPlan": "RO",
	"currency": "USD",
	"defaultCancelPolicy": {
		"code": "AD100P_100P"
	},
	"cancelPolicies": [{
		"dateRange": {
			"startDate": "2000-01-01",
			"endDate": "2099-12-31"
		},
		"cancelPolicy": {
			"code": "AD100P_100P"
		}
	}]
}

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"rateId": "IDDRNWED",
	"status": "Actived",
	"rateName": "Weekend Rate Room Only",
	"rateDescription": "Weekend Rate Room Only",
	"rateType": "AmountBeforeTax",
	"priceType": "SellPrice",
	"paymentType": "PayLater",
	"guaranteeType": "GCC",
	"defaultMealPlan": "RO",
	"currency": "USD",
	"defaultCancelPolicy": {
		"code": "AD100P_100P"
	},
	"cancelPolicies": [{
		"dateRange": {
			"startDate": "2000-01-01",
			"endDate": "2099-12-31"
		},
		"cancelPolicy": {
			"code": "AD100P_100P"
		}
	}]
}

6. 查询房价计划

此 API 查询酒店在 PropertyConnector 中指定的房价计划信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/ratePlans/{rateId} HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

示例:查询指定房价计划

响应

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"rateId": "IDDRNWED",
	"status": "Actived",
	"rateName": "Weekend Rate Room Only",
	"rateDescription": "Weekend Rate Room Only",
	"rateType": "AmountBeforeTax",
	"priceType": "SellPrice",
	"paymentType": "PayLater",
	"guaranteeType": "GCC",
	"defaultMealPlan": "RO",
	"currency": "USD",
	"defaultCancelPolicy": {
		"code": "AD100P_100P"
	},
	"cancelPolicies": [{
		"dateRange": {
			"startDate": "2000-01-01",
			"endDate": "2099-12-31"
		},
		"cancelPolicy": {
			"code": "AD100P_100P"
		}
	}]
}

查询全部房价计划

此 API 查询酒店在 PropertyConnector 中全部存在的房价计划信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/ratePlans HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

示例:

响应

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"rateList": [
		{
			"rateId": "BARRATE",
			"status": "Actived",
			"rateName": "Weekend Rate Room Only",
			"rateDescription": "Weekend Rate Room Only",
			"rateType": "AmountBeforeTax",
			"priceType": "SellPrice",
			"paymentType": "PayLater",
			"guaranteeType": "GCC",
			"defaultMealPlan": "RO",
			"currency": "USD",
			"defaultCancelPolicy": {
				"code": "AD100P_100P"
			},
			"cancelPolicies": [
				{
					"dateRange": {
						"startDate": "2000-01-01",
						"endDate": "2099-12-31"
					},
					"cancelPolicy": {
						"code": "AD100P_100P"
					}
				}
			]
		},
		{
			"rateId": "IDDRNWED",
			"status": "Actived",
			"rateName": "Weekend Rate Room Only",
			"rateDescription": "Weekend Rate Room Only",
			"rateType": "AmountBeforeTax",
			"priceType": "SellPrice",
			"paymentType": "PayLater",
			"guaranteeType": "GCC",
			"defaultMealPlan": "RO",
			"currency": "USD",
			"defaultCancelPolicy": {
				"code": "AD100P_100P"
			},
			"cancelPolicies": [
				{
					"dateRange": {
						"startDate": "2000-01-01",
						"endDate": "2099-12-31"
					},
					"cancelPolicy": {
						"code": "AD100P_100P"
					}
				}
			]
		}
	]
}

7. 创建税费

此 API 用于在 Property Connector 中创建新的税费。当税费建后 PropertyConnector 将会收到 PMS 推送的税费信息。税费信息可以通过接口或 PropertyConnector 页面创建。如果税费 ID 已经存在，则更新指定税费的信息。

POST /pcapigateway/profile/{accountId}/hotels/{hotelId}/fees/{feeId} HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

请求

Element	Type	Occurrence	Comment
feeId	String	Mandatory
dateRange	Object[DateRange]	Mandatory
DateRange/startDate	Date:yyyy-MM-dd	Mandatory
DateRange/endDate	Date:yyyy-MM-dd	Mandatory
fee	Object[Fee]	Mandatory
Fee/name	String	Mandatory
Fee/amount	String	Mandatory
Fee/amountType	Enum: Fix Percent	Mandatory	Fix, Percent
Fee/chargeType	Enum: PerRoomPerNight PerPersonPerNight PerRoomPerStay PerPersonPerStay	Mandatory	PerRoomPerNight, PerPersonPerNight, PerRoomPerStay PerPersonPerStay

示例:

请求

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"feeId": "FEE01001",
	"dateRange": {
		"startDate": "2000-01-01",
		"endDate": "2022-12-31"
	},
	"fee": {
		"name": "Service Charge",
		"amount": 10,
		"amountType": "Percent",
		"chargeType": "PerRoomPerNight"
	}
}

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"feeId": "FEE01001",
	"dateRange": {
		"startDate": "2000-01-01",
		"endDate": "2022-12-31"
	},
	"fee": {
		"name": "Service Charge",
		"amount": 10,
		"amountType": "Percent",
		"chargeType": "PerRoomPerNight"
	}
}

8 查询税费

查询指定税费

此 API 查询酒店在 PropertyConnector 中指定的税费信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/fees/{feeId} HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

示例:

响应

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"feeId": "FEE01001",
	"dateRange": {
		"startDate": "2000-01-01",
		"endDate": "2022-12-31"
	},
	"fee": {
		"name": "Service Charge",
		"amount": 10,
		"amountType": "Percent",
		"chargeType": "PerRoomPerNight"
	}
}

查询全部税费

此 API 查询酒店在 PropertyConnector 中全部存在的税费信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/fees HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

示例:

响应

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"feeList": [{
			"feeId": "FEE01001",
			"dateRange": {
				"startDate": "2000-01-01",
				"endDate": "2022-12-31"
			},
			"fee": {
				"name": "Service Charge",
				"amount": 10,
				"amountType": "Percent",
				"chargeType": "PerRoomPerNight"
			}
		},
		{
			"feeId": "FEE01002",
			"dateRange": {
				"startDate": "2000-01-01",
				"endDate": "2022-12-31"
			},
			"fee": {
				"name": "TAX",
				"amount": 16.6,
				"amountType": "Percent",
				"chargeType": "PerRoomPerNight"
			}
		}
	]
}

9. 创建产品

此 API 用于创建产品。当 PropertyConnector 中房型与价格计划已经存在时才能建立关联生成产品。产品信息可以通过接口或 PropertyConnector 页面创建。如果产品的关联关系存在时执行更新操作。

POST /pcapigateway/profile/{accountId}/hotels/{hotelId}/products HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

请求

Element	Type	Occurrence	Description
productList	List[product]	Optional
Product/roomId	String	Mandatory
Product/rateId	String	Mandatory
Product/status	Enum Actived Deactived	Mandatory	StopSell PreSale Bookable

示例:

请求:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"productList": [{
		"roomId": "DK",
		"rateId": "IDDRNDAR",
		"status": "Actived"
	}, {
		"roomId": "DK",
		"rateId": "BARRATE",
		"status": "Actived"
	}]
}

响应：

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"productList": [{
		"roomId": "DK",
		"rateId": "IDDRNDAR",
		"status": "Actived"
	}, {
		"roomId": "DK",
		"rateId": "BARRATE",
		"status": "Actived"
	}]
}

10. 查询产品

此 API 查询酒店在 PropertyConnector 中全部存在的产品信息。

GET /pcapigateway/profile/{accountId}/hotels/{hotelId}/products HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8

示例:

响应:

{
	"header": {
		"echoToken": "25c8cb40-52a0-449f-8fc9-0187c6f3f19e",
		"timeStamp": "2018-06-27T17:09:04.674Z",
		"version": "0.1"
	},
	"productList": [{
		"roomId": "DK",
		"rateId": "IDDRNDAR",
		"status": "Actived"
	}, {
		"roomId": "DK",
		"rateId": "BARRATE",
		"status": "Actived"
	}]
}