Reservation List by Chain [GET]
- Jordi Artal
Owned by Jordi Artal
Operation
Returns a paginated list of Reservation.
GET
https://{environment}.ulysescloud.com/public/api/v1/con/chain/{chainId}/reservation
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | int | true | path parameter | Unique identificator of the chain. | |
| reservationIdList | int | false | request parameter | ||
| otaLocator | String | false | request parameter | ||
| pmsLocator | String | false | request parameter | ||
| crsLocator | String | false | request parameter | ||
| cmLocator | String | false | request parameter | ||
| arrivalFrom | date | false | request parameter | ||
| arrivalTo | date | false | request parameter | ||
| departureFrom | date | false | request parameter | ||
| departureTo | date | false | request parameter | ||
| stayFrom | date | false | request parameter | ||
| stayTo | date | false | request parameter | ||
| createdFrom | dateTime | false | request parameter | ||
| createdTo | dateTime | false | request parameter | ||
| modifiedFrom | dateTime | false | request parameter | ||
| modifiedTo | dateTime | false | request parameter | ||
| cancelledFrom | dateTime | false | request parameter | ||
| cancelledTo | dateTime | false | request parameter | ||
| reservationStatusTypeIdList | List<int> | false | request parameter | ||
| reservationSituationTypeIdList | List<int> | false | request parameter | ||
| chainLoyaltyId | int | false | request parameter | ||
| roomIdList | List<int> | false | request parameter | ||
| holderEmail | string | false | request parameter | ||
| holderPhoneNumber | string | false | request parameter | ||
| holderDocumentNumber | string | false | request parameter | ||
| offset | int | false | request parameter | 0 | |
| limit | int | false | request parameter | 10 | |
| sort | string | false | request parameter | Id | |
| sortMode | string | false | request parameter | Desc |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/reservation
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true |
Entity
| Field | Type | Required | Description |
|---|---|---|---|
| id | int | false | Unique identificator of the Reservation. |
| property | Property | false | Property data. |
reservationHolder | ReservationHolder | false | Holder profile of this Reservation. |
pmsLocator | string | false | Locator of the PMS. |
crsLocator | string | false | Locator of the CRS. |
otaLocator | string | false | Locator of the OTA. |
cmLocator | string | false | Locator of the CM. |
| accommodationAmount | bigDecimal | false | Accomodation total amount of the Reservation. |
| boardAmount | bigDecimal | false | Board total amount of the Reservation. |
| serviceAmount | bigDecimal | false | Service total amount of the Reservation. |
| totalAmount | bigDecimal | false | Total amount of the Reservation. |
remark | string | false | |
reservationRoomStayList | Array of ReservationRoomStay | true | |
| reservationGuaranteeCardList | Array of ReservationGuaranteeCard | false | |
| createdDate | LocalDateTime | false | Date of creation. |
| modifiedDate | LocalDateTime | false | Date of modiffication. |
| deposit | ReservationDeposit | false |
Example response
{
"count": 193,
"offset": 0,
"limit": 10,
"list": [
{
"id": 1,
"property": {
"id": 2,
"code": "SEP",
"name": "Hotel Sepulveda",
"remark": null,
"colorCode": "#7CB342",
"active": true,
"inactiveReason": null,
"propertyClassTypeRating": null,
"propertyAddress": null,
"propertyPhone": null,
"propertyEmail": null,
"chainPropertyGroupList": null
},
"reservationHolder": {
"id": 1,
"profileId": null,
"documentNumber": null,
"givenName": "Jordi",
"surName": "Artal",
"secondSurName": "Ollé",
"street": null,
"city": null,
"stateProvName": null,
"stateProvCode": null,
"postalCode": null,
"countryCode": null,
"email": null,
"phoneNumber": null,
"membershipId": null,
"allowMarketing": null,
"allowThirdParty": null,
"language": null,
"documentType": null
},
"pmsLocator": "00000001",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"accommodationAmount": 0.000000,
"boardAmount": 0.000000,
"serviceAmount": 0.000000,
"totalAmount": 0.000000,
"remark": null,
"deposit": null,
"reservationGuaranteeCardList": null,
"createdDate": "2024-05-03T11:03:42.118Z",
"modifiedDate": null,
"cancelledDate": null,
"reservationRoomStayList": [
{
"id": 1,
"reservationStatusType": {
"id": 3,
"code": "NS",
"name": "NoShow",
"nameI18n": "NoShow",
"colorCode": "#000000"
},
"reservationSituationType": null,
"arrival": "2024-04-16",
"departure": "2024-04-17",
"arrivalTime": null,
"departureTime": null,
"quantity": 1,
"accommodation": {
"id": 722,
"name": "Double",
"code": "DBL",
"roomType": {
"id": 17,
"chainRoomTypeId": 2,
"name": "Double",
"nameI18n": "Double",
"mainImage": "1/2/propertyroomtypeimages/8aaf79de-f9cf-461a-a0a4-0c518d5a45b6.jpg",
"active": true
}
},
"room": null,
"adult": 2,
"junior": 0,
"child": 0,
"infant": 0,
"accommodationAmount": 0.000000,
"boardAmount": 0.000000,
"serviceAmount": 0.000000,
"totalAmount": 0.000000,
"productFee": null,
"pmsLocator": "00000001/1",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"reservationRoomStayGuests": [
{
"id": 1,
"profileId": 1375,
"documentType": {
"id": 2,
"code": "P",
"name": "Passport",
"nameI18n": "Passport"
},
"documentNumber": "tSjkFnfH",
"givenName": "Name 1",
"surName": "SurName 1",
"secondSurName": "SecondSurName 1",
"genderType": {
"id": 1,
"code": "M",
"name": "Male",
"nameI18n": "Male"
},
"birthDate": "2006-05-03",
"birthCountryCode": "BL",
"birthPlace": "Syracuse",
"effectiveDate": "2023-05-03",
"expireDate": "2026-05-03",
"street": "8 Cardinal Hill",
"city": "Syracuse",
"stateProvName": "New York",
"stateProvCode": null,
"countryCode": "BL",
"postalCode": "13205",
"nationalityCountryCode": "BL",
"countryOfIssuanceCode": "BL",
"ocr": "",
"email": "jyoung1c@bizjournals.com",
"phoneNumber": "1-(315)528-6522",
"allowMarketing": false,
"allowThirdParty": false,
"language": null,
"registrationNumber": null,
"reservationRoomStayGuestCustomFieldValueSet": null
},
{
"id": 2,
"profileId": 1376,
"documentType": {
"id": 2,
"code": "P",
"name": "Passport",
"nameI18n": "Passport"
},
"documentNumber": "LhMcJbzp",
"givenName": "Name 2",
"surName": "SurName 2",
"secondSurName": "SecondSurName 2",
"genderType": {
"id": 2,
"code": "F",
"name": "Female",
"nameI18n": "Female"
},
"birthDate": "2006-05-03",
"birthCountryCode": "AG",
"birthPlace": "Amarillo",
"effectiveDate": "2023-05-03",
"expireDate": "2026-05-03",
"street": "950 Northfield Drive",
"city": "Amarillo",
"stateProvName": "Texas",
"stateProvCode": null,
"countryCode": "AG",
"postalCode": "79116",
"nationalityCountryCode": "AG",
"countryOfIssuanceCode": "AG",
"ocr": "",
"email": "mholmes7p@t.co",
"phoneNumber": "1-(806)265-7526",
"allowMarketing": false,
"allowThirdParty": false,
"language": null,
"registrationNumber": null,
"reservationRoomStayGuestCustomFieldValueSet": null
}
],
"mainBoard": null,
"reservationRoomStayDaily": [
{
"id": 1,
"date": "2024-04-16",
"room": null,
"allotment": null,
"rate": null,
"amountBeforeTax": 0.000000,
"amountAfterTax": 0.000000,
"amountNetAfterTax": 0.000000,
"amountNetBeforeTax": 0.000000,
"amountInvoiceAfterTax": 0.000000,
"amountInvoiceBeforeTax": 0.000000,
"accommodationAmount": 0.000000,
"accommodationAmountAfterDiscount": 0.000000,
"accommodationAmountAfterTax": 0.000000,
"accommodationAmountBeforeTax": 0.000000,
"accommodationAmountNetAfterTax": 0.000000,
"accommodationAmountNetBeforeTax": 0.000000,
"accommodationAmountInvoiceAfterTax": 0.000000,
"accommodationAmountInvoiceBeforeTax": 0.000000,
"centralAccommodationPercentageCommission": null,
"centralAccommodationAmountCommission": null,
"centralBoardPercentageCommission": null,
"centralBoardAmountCommission": null,
"companyAccommodationPercentageCommission": null,
"companyAccommodationAmountCommission": null,
"companyBoardPercentageCommission": null,
"companyBoardAmountCommission": null,
"bookerAccommodationPercentageCommission": null,
"bookerAccommodationAmountCommission": null,
"bookerBoardPercentageCommission": null,
"bookerBoardAmountCommission": null,
"billToAccommodationPercentageCommission": null,
"billToAccommodationAmountCommission": null,
"billToBoardPercentageCommission": null,
"billToBoardAmountCommission": null,
"billToAccommodationPercentageDiscount": null,
"billToAccommodationAmountDiscount": null,
"billToBoardPercentageDiscount": null,
"billToBoardAmountDiscount": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": {
"id": 5,
"chainBoardId": 1,
"code": "RO",
"name": "Room Only",
"nameI18n": "Room Only",
"serviceList": null
},
"boardAmountAfterDiscountAdult": 0.000000,
"boardAmountAdult": 0.000000,
"boardAmountAfterTaxAdult": 0.000000,
"boardAmountBeforeTaxAdult": 0.000000,
"boardAmountNetAfterTaxAdult": 0.000000,
"boardAmountNetBeforeTaxAdult": 0.000000,
"boardAmountInvoiceAfterTaxAdult": 0.000000,
"boardAmountInvoiceBeforeTaxAdult": 0.000000,
"boardAmountAfterDiscountJunior": 0.000000,
"boardAmountJunior": 0.000000,
"boardAmountAfterTaxJunior": 0.000000,
"boardAmountBeforeTaxJunior": 0.000000,
"boardAmountNetAfterTaxJunior": 0.000000,
"boardAmountNetBeforeTaxJunior": 0.000000,
"boardAmountInvoiceAfterTaxJunior": 0.000000,
"boardAmountInvoiceBeforeTaxJunior": 0.000000,
"boardAmountAfterDiscountChild": 0.000000,
"boardAmountChild": 0.000000,
"boardAmountAfterTaxChild": 0.000000,
"boardAmountBeforeTaxChild": 0.000000,
"boardAmountNetAfterTaxChild": 0.000000,
"boardAmountNetBeforeTaxChild": 0.000000,
"boardAmountInvoiceAfterTaxChild": 0.000000,
"boardAmountInvoiceBeforeTaxChild": 0.000000,
"boardAmountAfterDiscountInfant": 0.000000,
"boardAmountInfant": 0.000000,
"boardAmountAfterTaxInfant": 0.000000,
"boardAmountBeforeTaxInfant": 0.000000,
"boardAmountNetAfterTaxInfant": 0.000000,
"boardAmountNetBeforeTaxInfant": 0.000000,
"boardAmountInvoiceAfterTaxInfant": 0.000000,
"boardAmountInvoiceBeforeTaxInfant": 0.000000,
"paymentType": {
"id": 1,
"code": "G",
"name": "Pay Guest",
"nameI18n": "Pay Guest"
},
"propertyPolicy": null,
"propertySource": {
"id": 10,
"code": "INT",
"name": "Interface"
},
"propertySegment": {
"id": 17,
"code": "TAGE",
"name": "Travel Agent"
},
"propertyChannel": {
"id": 7,
"code": "CRS",
"name": "Central ReservationSystem"
},
"booker": null,
"billTo": null,
"central": null,
"company": null,
"reservationGroup": {
"id": 1,
"reservationSituationType": null,
"reservationStatusType": null,
"name": "test 1",
"expiredDate": null,
"arrival": "2024-04-03",
"departure": "2024-04-04",
"arrivalTime": null,
"departureTime": null,
"pmsLocator": "00000001",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"privateRemark": null,
"reservationGroupRoomBlockList": null,
"allotment": null,
"rate": null,
"currency": null,
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"board": null,
"boardPriceAdult": 0.000000,
"boardPriceJunior": 0.000000,
"boardPriceChild": 0.000000,
"boardPriceInfant": 0.000000,
"boardAmountAfterDiscountAdult": null,
"boardAmountAfterDiscountJunior": null,
"boardAmountAfterDiscountChild": null,
"boardAmountAfterDiscountInfant": null,
"boardAmountAfterTaxAdult": null,
"boardAmountBeforeTaxAdult": null,
"boardAmountNetAfterTaxAdult": null,
"boardAmountNetBeforeTaxAdult": null,
"boardAmountInvoiceAfterTaxAdult": null,
"boardAmountInvoiceBeforeTaxAdult": null,
"boardAmountAfterTaxJunior": null,
"boardAmountBeforeTaxJunior": null,
"boardAmountNetAfterTaxJunior": null,
"boardAmountNetBeforeTaxJunior": null,
"boardAmountInvoiceAfterTaxJunior": null,
"boardAmountInvoiceBeforeTaxJunior": null,
"boardAmountAfterTaxChild": null,
"boardAmountBeforeTaxChild": null,
"boardAmountNetAfterTaxChild": null,
"boardAmountNetBeforeTaxChild": null,
"boardAmountInvoiceAfterTaxChild": null,
"boardAmountInvoiceBeforeTaxChild": null,
"boardAmountAfterTaxInfant": null,
"boardAmountBeforeTaxInfant": null,
"boardAmountNetAfterTaxInfant": null,
"boardAmountNetBeforeTaxInfant": null,
"boardAmountInvoiceAfterTaxInfant": null,
"boardAmountInvoiceBeforeTaxInfant": null,
"booker": null,
"bookerAccommodationPercentageCommission": null,
"bookerAccommodationAmountCommission": null,
"bookerBoardPercentageCommission": null,
"bookerBoardAmountCommission": null,
"billTo": null,
"billToAccommodationPercentageCommission": null,
"billToAccommodationAmountCommission": null,
"billToBoardPercentageCommission": null,
"billToBoardAmountCommission": null,
"billToAccommodationPercentageDiscount": null,
"billToAccommodationAmountDiscount": null,
"billToBoardPercentageDiscount": null,
"billToBoardAmountDiscount": null,
"central": null,
"centralAccommodationPercentageCommission": null,
"centralAccommodationAmountCommission": null,
"centralBoardPercentageCommission": null,
"centralBoardAmountCommission": null,
"company": null,
"companyAccommodationPercentageCommission": null,
"companyAccommodationAmountCommission": null,
"companyBoardPercentageCommission": null,
"companyBoardAmountCommission": null,
"paymentType": null,
"policy": null,
"source": null,
"segment": null,
"channel": null,
"groupInvoice": false,
"reservationPriceModelType": null,
"cutOffDate": null,
"totalQuantity": 0,
"totalQuantityConsumed": 0,
"totalQuantityAvailable": 0,
"totalAccommodationPrice": 0.000000,
"totalBoardPrice": 0.000000,
"totalServicePrice": 0.000000,
"totalStayServicePrice": 0.000000,
"totalPrice": 0.000000,
"reservationGroupHolder": null,
"createdDate": null,
"modifiedDate": null,
"cancelledDate": null
}
}
],
"reservationRoomStayServiceList": null,
"createdDate": "2024-05-03T11:03:42.158Z",
"modifiedDate": "2024-05-03T11:19:28.701Z",
"cancelledDate": null,
"mainBooker": null,
"mainBillTo": null,
"mainCentral": null,
"mainCompany": null,
"mainRate": null,
"mainOffer": null,
"mainPromotion": null,
"deposit": null,
"reservationType": null,
"reservationRoomStayCustomFieldValueSet": null
}
]
} ...
}