Product Allocation
Manage allocation of rooms for Groups.
Retrieve Group Product Allocations
Retrieve Product Product Allocations for a specified hotel
Method/Endpoint
| Method | Endpoint |
|---|---|
GET | https://[environment]/v1/api/admin/hotel/{id}/group/allocation/ |
Request Parameter List
| Parameter | Description | Type |
|---|---|---|
| id | Unique number identifies a specific hotel in SynXis. | Integer |
| rateCodes | Rate code associated with the product | String[Array] |
| roomCodes | Room code associated with the product | String[Array] |
| startDate | Start date for the allocation (format yyyy-mm-dd) | String |
| endDate | End date for the allocation (format yyyy-mm-dd) | String |
| pageStart | Starting record to be returned in the response. | Integer |
| pageSize | Number of records to be returned in the response. | Integer |
Response Parameter List
| Parameter | Description | Type |
|---|---|---|
| productAllocation/@rateCode | Rate code associated with the product | String |
| productAllocation/@roomCode | Room code associated with the product | String |
| productAllocation/inventoryList/@committed | Number of rooms committed for the group. If there are 100 king rooms available and 10 are committed, the block has 10 rooms to sell and general inventory reduces to 90. | Integer |
| productAllocation/inventoryList/@sellLimit | Specifies the number of rooms guests are allowed to book more than what is committed. Example - If the group only contracted with the hotel to use 10 rooms, but suggests that they might book as many as 15, then setting sellLimit to 15 would allow 5 more rooms to be booked from general inventory, above and beyond the 10 that are allocated to the group. | Integer |
| productAllocation/inventoryList/@date | Date of the Inventory data (format yyyy-mm-dd) | String |
| Paging/@Start | Starting record in the response. | Integer |
| Paging/@Size | Number of records in the response. | Integer |
| Paging/@Total | Total number of records. | Integer |
Request by Rate
Request allocations for all dates pertaining to a one or more group rate codes
GET /v1/api/admin/hotel/13098/group/allocation?rateCodes=Group1Response
{
"ProductAllocations": [
{
"InventoryList": [
{
"Date": "2022-05-24",
"Committed": 10,
"SellLimit": 15
},
{
"Date": "2022-05-25",
"Committed": 10,
"SellLimit": 15
}
],
"RateCode": "Group1",
"RoomCode": "SUPT"
},
{
"InventoryList": [
{
"Date": "2022-05-24",
"Committed": 5,
"SellLimit": 5
},
{
"Date": "2022-05-25",
"Committed": 5,
"SellLimit": 5
}
],
"RateCode": "Group1",
"RoomCode": "SUPK"
}
],
"Paging": {
"Size": 4,
"Start": 0,
"Total": 4
}
}
Request by Room
Request allocations for all dates pertaining to one or more room codes
GET /v1/api/admin/hotel/13098/group/allocation?roomCodes=SUPTResponse
{
"ProductAllocations": [
{
"InventoryList": [
{
"Date": "2022-05-24",
"Committed": 10,
"SellLimit": 15
},
{
"Date": "2022-05-25",
"Committed": 10,
"SellLimit": 15
}
],
"RateCode": "Group1",
"RoomCode": "SUPT"
}
],
"Paging": {
"Size": 2,
"Start": 0,
"Total": 2
}
}
Request by Date Range
GET /v1/api/admin/hotel/13098/group/allocation?startDate=2022-05-24&endDate=2022-05-25Response
{
"ProductAllocations": [
{
"InventoryList": [
{
"Date": "2022-05-24",
"Committed": 10,
"SellLimit": 15
},
{
"Date": "2022-05-25",
"Committed": 10,
"SellLimit": 15
}
],
"RateCode": "Group1",
"RoomCode": "SUPT"
},
{
"InventoryList": [
{
"Date": "2022-05-24",
"Committed": 5,
"SellLimit": 5
},
{
"Date": "2022-05-25",
"Committed": 5,
"SellLimit": 5
}
],
"RateCode": "Group1",
"RoomCode": "SUPK"
},
{
"InventoryList": [
{
"Date": "2022-05-24",
"Committed": 25,
"SellLimit": 25
},
{
"Date": "2022-05-25",
"Committed": 25,
"SellLimit": 25
}
],
"RateCode": "Group2",
"RoomCode": "GRP"
}
],
"Paging": {
"Size": 6,
"Start": 0,
"Total": 6
}
}Create or Update Product Allocation
Create or Update Product Seasons for a specified hotel
Method/Endpoint
| Method | Endpoint |
|---|---|
POST | https://[environment]/v1/api/admin/hotel/{id}/group/{code}/allocation/ |
Request Parameter List
| Parameter | Description | Type |
|---|---|---|
| id | Unique number identifies a specific hotel in SynXis. | Integer |
| code | Rate code associated with the product | String |
| roomCode | Room code associated with the product | String |
| committed | Number of rooms committed for the group. If there are 100 king rooms available and 10 are committed, the block has 10 rooms to sell and general inventory reduces to 90. | Integer |
| sellLimit | Specifies the number of rooms guests are allowed to book more than what is committed. Example - If the group only contracted with the hotel to use 10 rooms, but suggests that they might book as many as 15, then setting sellLimit to 15 would allow 5 more rooms to be booked from general inventory, above and beyond the 10 that are allocated to the group. | Integer |
| dateIntervals/@startDate | Start date for the allocation (format yyyy-mm-dd) | String |
| dateIntervals/@endDate | End date for the allocation (format yyyy-mm-dd) | String |
Request
Create product allocations for Group rate Group1 and room SUPK.
POST /v1/api/admin/hotel/13098/group/Group1/allocation{
"roomCode": "SUPK",
"committed": 2,
"sellLimit": 4,
"dateIntervals": [
{
"startDate": "05/25/2022",
"endDate": "05/26/2022"
},
{
"startDate": "05/28/2022",
"endDate": "05/28/2022"
}
]
}
Response
A successful response is an HTTP status code of 200.