List Availability[GET]
- Jordi Artal
- David Martin
Operation
Information of the operation
Request
Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
chainId | Integer | true | path parameter | Unique identificator of the chain. | |
propertyId | Integer | true | path parameter | Unique identificator of the property. | |
endDate | LocalDate | true | request parameter | endDate | |
startDate | LocalDate | true | request parameter | satrtDate | |
adult | int | true | request parameter | Â | adult |
rateIdList | List<Integer> | false | request parameter | Â | rateIdList |
offerIdList | List<Integer> | false | request parameter | Â | offerIdList |
promotionIdList | List<Integer> | false | request parameter | Â | promotionIdList |
boardIdList | List<Integer> | false | request parameter | Â | boardIdList |
productIdList | List<Integer> | false | request parameter | Â | productIdList |
junior | int | false | request parameter | Â | junior |
child | int | false | request parameter | Â | child |
infant | int | false | request parameter | Â | infant |
promotionCode | String | false | request parameter | Â | promotionCode |
lang | String | false | request parameter | Â | content language |
applyRestrictions | boolean | false | request parameter | Â | true by default, in case of false not apply minStay, maxStay, closeToArrivals and close to departure configured at day level |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/2/availability?adult=2&lang=es&applyRestrictions=false&startDate=2022-12-19&endDate=2022-12-25&junior=0&child=0&infant=0&rateIdList=2Response
Property | Type | Required | Description |
|---|---|---|---|
availavility | Availability | true | availavility |
Entity
Example response
{
"productAvailabilityList": [
{
"quantityAvailable": 1,
"product": {
"id": 1755,
"chainProductId": 49,
"code": "BELLXL",
"name": "Bell XL",
"productType": {
"id": 1,
"code": "ACC",
"name": "Accommodation",
"nameI18n": "Alojamiento"
}
},
"occupancyAvailabilityList": [
{
"adult": 6,
"junior": 0,
"child": 0,
"infant": 0,
"occupancyBoardAvailabilityList": [
{
"id": 5,
"code": "RO",
"name": "Room Only",
"rateAvailabilityList": [
{
"rate": {
"id": 2,
"chainRateId": 1,
"code": "BAR",
"name": "Best Available Rate",
"nameI18n": "Best Available Rate",
"description": null,
"descriptionI18n": null,
"order": null,
"tagList": [
{
"id": 1,
"name": "holidays"
}
]
},
"board": {
"id": 5,
"name": "Room Only",
"nameI18n": "Room Only",
"order": null
},
"promotion": null,
"offer": null,
"propertyPolicy": {
"id": 12,
"name": "24 Hours 1 Night",
"nameI18n": "24 Hours 1 Night",
"description": "Esta reserva es reembolsable al 100% 24h antes de su llegada",
"descriptionI18n": "Esta reserva es reembolsable al 100% 24h antes de su llegada",
"colorCode": "#43A047",
"nonRefundable": null,
"deadlineDay": 0,
"deadlineHour": 0,
"policyChargeType": {
"id": 1,
"code": null,
"name": null,
"nameI18nId": null,
"nameI18n": null
},
"chargeValue": 100.000000,
"depositSuggestedAmount": 100.000000,
"depositSuggestedPercentageAmount": 100.000000
},
"avgPrice": 105.00,
"totalPrice": 630.000000,
"totalAccommodationAmount": 630.000000,
"totalBoardAmount": 0,
"totalServiceAmount": 0,
"available": true,
"dayAvailabilityList": [
{
"date": "2022-12-19",
"displayAmount": 105.000000,
"amount": 105.000000,
"sourceAmount": 105.000000,
"accommodationAmount": 105.000000,
"sourceAccommodationAmount": 105.000000,
"boardAmount": 0,
"sourceBoardAmount": 0,
"serviceAmount": 0,
"sourceServiceAmount": 0,
"available": true,
"closed": false,
"minStay": 0,
"maxStay": 0,
"closedToArrival": false,
"closedToDeparture": false
},
{
"date": "2022-12-20",
"displayAmount": 105.000000,
"amount": 105.000000,
"sourceAmount": 105.000000,
"accommodationAmount": 105.000000,
"sourceAccommodationAmount": 105.000000,
"boardAmount": 0,
"sourceBoardAmount": 0,
"serviceAmount": 0,
"sourceServiceAmount": 0,
"available": true,
"closed": false,
"minStay": 0,
"maxStay": 0,
"closedToArrival": false,
"closedToDeparture": false
},
{
"date": "2022-12-21",
"displayAmount": 105.000000,
"amount": 105.000000,
"sourceAmount": 105.000000,
"accommodationAmount": 105.000000,
"sourceAccommodationAmount": 105.000000,
"boardAmount": 0,
"sourceBoardAmount": 0,
"serviceAmount": 0,
"sourceServiceAmount": 0,
"available": true,
"closed": false,
"minStay": 0,
"maxStay": 0,
"closedToArrival": false,
"closedToDeparture": false
},
{
"date": "2022-12-22",
"displayAmount": 105.000000,
"amount": 105.000000,
"sourceAmount": 105.000000,
"accommodationAmount": 105.000000,
"sourceAccommodationAmount": 105.000000,
"boardAmount": 0,
"sourceBoardAmount": 0,
"serviceAmount": 0,
"sourceServiceAmount": 0,
"available": true,
"closed": false,
"minStay": 0,
"maxStay": 0,
"closedToArrival": false,
"closedToDeparture": false
},
{
"date": "2022-12-23",
"displayAmount": 105.000000,
"amount": 105.000000,
"sourceAmount": 105.000000,
"accommodationAmount": 105.000000,
"sourceAccommodationAmount": 105.000000,
"boardAmount": 0,
"sourceBoardAmount": 0,
"serviceAmount": 0,
"sourceServiceAmount": 0,
"available": true,
"closed": false,
"minStay": 0,
"maxStay": 0,
"closedToArrival": false,
"closedToDeparture": false
},
{
"date": "2022-12-24",
"displayAmount": 105.000000,
"amount": 105.000000,
"sourceAmount": 105.000000,
"accommodationAmount": 105.000000,
"sourceAccommodationAmount": 105.000000,
"boardAmount": 0,
"sourceBoardAmount": 0,
"serviceAmount": 0,
"sourceServiceAmount": 0,
"available": true,
"closed": false,
"minStay": 0,
"maxStay": 0,
"closedToArrival": false,
"closedToDeparture": false
}
]
}
]
}
]
}
],
"description": null,
"descriptionI18n": null
}
...
]
}