ReservationSummary List [GET]
- David Garcerán
- Jordi Artal
Owned by David Garcerán
Operation
Returns a paginated list of ReservationSummary.
GET
https://{environment}.ulysescloud.com/public/api/v1/con/chain/{chainId}/property/{propertyId}/reservation/summary
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | int | true | path parameter | Unique identificator of the chain. | |
| propertyId | int | true | path parameter | Unique identificator of the property. | |
| 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<Integer> | false | request parameter | ||
| reservationSituationTypeId | int | false | request parameter | ||
| chainLoyalty | int | 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/property/1/reservation/summary
Response
| Property | Type | Required | Description |
|---|---|---|---|
| Page | Page | true |
Entity
| Field | Type | Required | Description |
|---|---|---|---|
| id | Integer | true | Unique identifier for the ReservationSummary. |
| reservationId | Integer | true | The Id of the related Reservation. |
| reservationGroup | ReservationGroup | false | |
| reservationGroupId | Integer | false | |
| pmsLocator | String | The locator assigned by the PMS. | |
| crsLocator | String | The locator assigned by the CRS. | |
| otaLocator | String | The locator assigned by the OTA. | |
| cmLocator | String | The locator assigned by the CM. | |
| holder | String | Holder name. | |
| holderEmail | String | ||
| arrival | LocalDate | ||
| departure | LocalDate | ||
| roomStay | Integer | ||
| nights | Integer | ||
| productAccommodation | Accommodation | The room that is going to be charged to the client. | |
| adult | Integer | ||
| junior | Integer | ||
| child | Integer | ||
| infant | Integer | ||
| booker | Company | ||
| billTo | Company | ||
| company | Company | ||
| central | Company | ||
| board | Board | ||
| guest | String | ||
| allotment | Allotment | ||
| rate | Rate | ||
| offer | Offer | ||
| promotion | Promotion | ||
| accommodationAmount | BigDecimal | Price of the accommodation products. | |
| boardAmount | BigDecimal | Price of the boards. | |
| serviceAmount | BigDecimal | Price of the services. | |
| totalAmount | BigDecimal | Total price. | |
| totalPaid | BigDecimal | Total paid. | |
| balance | BigDecimal | balance. | |
| currency | Currency | ||
| booker | Company | ||
| billTo | Company | ||
| company | Company | ||
| central | Company | ||
| room | Room | ||
| propertyPolicy | Policy | ||
| propertySource | Source | ||
| propertyChannel | Channel | ||
| propertySegment | Segment | ||
| reservationStatusType | ReservationStatusType | ||
| expiredDate | LocalDate | ||
| limitCreditAmount | BigDecimal | ||
| hasCredit | Boolean | ||
| creditAvailable | BigDecimal | In case there's a limit of credit for the roomStays, this is the subtraction of the limit minus the amount of credit spent on the folios related to this reservation's roomStays. |
Example response
{
"count": 52,
"offset": 0,
"limit": 1,
"list": [
{
"id": 1,
"reservationId": 1,
"reservationGroup": null,
"reservationGroupId": null,
"pmsLocator": "ALI00000001",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"holder": "Lyséa Sanders, Barbara",
"holderEmail": "bsandershs@github.com",
"arrival": "2021-10-11",
"departure": "2021-10-15",
"roomStay": 1,
"nights": 4,
"productAccommodation": {
"id": 677,
"code": "SGL",
"name": "Single",
"productType": {
"id": 1,
"code": "ACC",
"name": "Accommodation",
"nameI18n": "Accommodation"
}
},
"adult": 1,
"junior": 0,
"child": 0,
"infant": 0,
"booker": {
"id": 893,
"name": "Mydo",
"code": "MYDO2",
"taxId": "11205871",
"companyEmailList": [
{
"id": 893,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal",
"nameI18n": "Personal"
},
"email": "gowenso6@pagesperso-orange.fr",
"remark": null
}
],
"companyAddressList": [
{
"id": 893,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home",
"nameI18n": "Home"
},
"street": "30 Dorton Alley",
"city": "Brooklyn",
"stateProvName": "New York",
"stateProvCode": null,
"postalCode": "11205",
"countryCode": "JO",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 893,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home",
"nameI18n": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice",
"nameI18n": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(646)317-4684",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 874,
"communicationLocationType": null,
"street": "30 Dorton Alley",
"city": "Brooklyn",
"stateProvName": "New York",
"stateProvCode": null,
"postalCode": "11205",
"countryCode": "HT",
"remark": "Address Remark"
},
"remark": "Company Remarks",
"assignedUser": null,
"profileType": {
"id": 2,
"code": "2",
"name": "Company",
"nameI18n": "Company",
"colorCode": "#00ACC1"
},
"companyCustomFieldValueList": null
},
"billTo": {
"id": 1260,
"name": "Travelocity",
"code": "TRAVE2",
"taxId": "47b3ee5e-87cc-4be4-bc06-c84a7a505747",
"companyEmailList": [
{
"id": 1260,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal",
"nameI18n": "Personal"
},
"email": "lwrightkz@gizmodo.com",
"remark": null
}
],
"companyAddressList": [
{
"id": 1260,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home",
"nameI18n": "Home"
},
"street": "06960 Stone Corner Trail",
"city": "Stamford",
"stateProvName": "Connecticut",
"stateProvCode": null,
"postalCode": "6922",
"countryCode": "BA",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 1260,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home",
"nameI18n": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice",
"nameI18n": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(203)475-0996",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": null,
"remark": "Company Agency",
"assignedUser": null,
"profileType": {
"id": 3,
"code": "3",
"name": "Travel agent",
"nameI18n": "Travel agent",
"colorCode": "#1E88E5"
},
"companyCustomFieldValueList": null
},
"central": {
"id": 770,
"name": "Jabberbean",
"code": "JABBE10",
"taxId": "33405748",
"companyEmailList": [
{
"id": 770,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal",
"nameI18n": "Personal"
},
"email": "jleekr@disqus.com",
"remark": null
}
],
"companyAddressList": [
{
"id": 770,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home",
"nameI18n": "Home"
},
"street": "1 Longview Center",
"city": "West Palm Beach",
"stateProvName": "Florida",
"stateProvCode": null,
"postalCode": "33405",
"countryCode": "AD",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 770,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home",
"nameI18n": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice",
"nameI18n": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(561)185-3838",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 751,
"communicationLocationType": null,
"street": "1 Longview Center",
"city": "West Palm Beach",
"stateProvName": "Florida",
"stateProvCode": null,
"postalCode": "33405",
"countryCode": "DJ",
"remark": "Address Remark"
},
"remark": "Company Remarks",
"assignedUser": null,
"profileType": {
"id": 2,
"code": "2",
"name": "Company",
"nameI18n": "Company",
"colorCode": "#00ACC1"
},
"companyCustomFieldValueList": null
},
"company": null,
"board": {
"id": 6,
"code": "BB",
"name": "Bed And Breakfast",
"serviceList": [
{
"id": 66,
"code": "BRK",
"name": "Breakfast"
}
]
},
"propertyPolicy": {
"id": 7,
"code": "NR",
"name": "Non Refundable"
},
"propertySource": {
"id": 12,
"code": "EMA",
"name": "Email"
},
"propertyChannel": {
"id": 10,
"code": "OTA",
"name": "Online Travel Agency"
},
"propertySegment": {
"id": 22,
"code": "CRU",
"name": "Cruise"
},
"guest": "Gaïa Fernandez, Beverly",
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"room": {
"id": 2,
"code": "102",
"name": "102",
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 2,
"code": "OC",
"name": "Occupied",
"nameI18n": "Occupied"
}
},
"accommodationAmount": 640.800000,
"boardAmount": 151.200000,
"serviceAmount": 0.000000,
"totalAmount": 792.000000,
"totalPaid": 692.000000,
"balance": 100.000000,
"reservationStatusType": {
"id": 5,
"code": "CO",
"name": "CheckedOut",
"nameI18n": "CheckedOut",
"colorCode": "#757575"
},
"reservationType" : {
"id": 2,
"chainId": 1,
"propertyId": 2,
"code": "PREVIEW",
"name": "Pending Review",
"colorCode": "#FDD835",
"active": true
},
"expiredDate": null,
"limitCreditAmount": null,
"hasCredit": true,
"creditAvailable": null
}
]
}