{"swagger":"2.0","info":{"version":"7.6.0","title":"1A_REST_JSON_Reservation","description":"The Reservations API of the Amadeus Hospitality CRS application.\nIt comprises how to create, modify, reinstate, cancel, migrate, retrieve, commit and ignore reservations\n","x-release-note":{"7.0.0":["########## New Features ##########","Consumption Rules","Guest type set-up","Search POST operation - replacing GET","Multi-segment reservation linkage","Taxes, Service Charges and Fees by Guest Type/ Age","########## New in request ##########","hide_no_show query parameter - search","########## New in Response ##########","hotelReservation.folderId","taxDefinitions.value renamed values and changed from string to array[object]","hotels.isPseudoProperty","hotels.masterPropertyCode","hotels.masterPropertyName","########## New in Request and Response ##########","segments[].offer.productUses[].guestCounts[].id","segments[].offer.productUses[].guestCounts[].otaCode","segments[].offer.productUses[].guestCounts[].guestType (only in response)","segments[].offer.productUses[].guestCounts[].count","reservationIds.pmsCxNumber","reservationIds.extCxNumber","segments[].offer.corpMarketSegment,","segments[].offer.nightlyCorpMarketSegments[]","segments[].offer.policyTypeCode","########## Moved ##########","segments.offer.ratePlanCode to segments.offer.productUses[].ratePlanCode","##########  Removed ###################","authorization from the header","ama-api-version from the header","hotelReservation.segments[].loyaltyProgram from segment","amtBfTx and AmtAfTx in the original base rates","data.hotelReservation.groupContracts[].marketSegmentation - mapped to nightlyCorpMarketSegments and corpMarketSegment","########## Renamed ##########","productCode to inventoryTypeCode","productName to inventoryTypeName","productTypeCode to productCode","productTypeName to productName","upgradedProductCode to upgradedInventoryTypeCode","segment.owner.agencyDetails.travelAgencyName to name","segments.offer.propertyMarketSegmentation to propertyMarketSegment","createDateTime to creationDateTime","resStatus to status","reservationType to type","taxDefinitions[].taxCode to code","taxDefinitions[].otaCode to taxTypeCode","taxDefinitions[].isInclusive renamed isIncluded","taxDefinitions[].productTypeCode renamed productCodes","taxDefinitions[].taxOn renamed computationMode","taxDefinitions[].value to values[]","taxDefinitions[].valueType to ComputationType","########## Other Changes ##########","Error and Warning structure to follow Amadeus guidelines","reservationIDs.pmsCfNumber Increased length to 50 char","isMainProduct to optional - migration","ratePlans[] optional for pickup bookings - if no hardcoded ratePlanCode provided in RQ"],"7.1.0":["########## New Features ##########","Multiple identical rooms reservation","########## New in request ##########","includePseudoPropertyReservations field in search","corpMarketSegment - search","########## New in Response ##########","segments[].offer.productUses.productRates.pricingFrequency (PerUse) - productRates & packageRates level","segments[].offer.productUses.productRates.BookingPattern - productRates & packageRates level","hotels.isPseudoProperty","hotels.masterPropertyCode","hotels.masterPropertyName","hotelReservation.ratePlans.gamingBucket","hotels[].guestTypeDefinition.startAge","hotels[].guestTypeDefinition.endAge","hotels[].guestTypeDefinition.otaCodes","hotels[].guestTypeDefinition.code","hotels[].guestTypeDefinition.description","printRate boolean at reservation level","########## New in Request and Response ##########","data.creator","data.hotelReservation.segment.creator","data.hotelReservation.segment.owner","segments[].offer.isPerpetualOffer","userProfiles[].loyaltyProgram.qualifier.dominance","userProfiles[].loyaltyProgram.qualifier..tier","segments[].offer.productUses[].routingInstructions[].code","segments[].offer.productUses[].routingInstructions[].authorizerCode","segments[].offer.productUses[].routingInstructions[].routingCode","segments[].offer.productUses[].routingInstructions[].window","segments[].offer.productUses[].routingInstructions[].limitCriteria","segments[].offer.productUses[].routingInstructions[].limitValue","segments[].offer.productUses[].routingInstructions[].period","segments[].offer.productUses[].routingInstructions[].routingLimitType","segments[].offer.productUses[].routingInstructions[].couponNumber","segments[].offer.productUses[].routingInstructions[].covers","segments[].offer.productUses[].routingInstructions[].source","segments[].offer.productUses[].routingInstructions[].isDaily","segments[].offer.productUses[].routingInstructions[].comment","segments[].offer.productUses[].routingInstructions[].id","segments[].offer.productUses[].totalGuestCounts[].guestType","segments[].offer.productUses[].guestCounts[].age","segments[].offer.productUses[].guestCounts[].id","segments[].offer.productUses[].guestCounts[].otaCode","segments[].offer.productUses[].guestCounts[].guestType (only in response)","segments[].offer.productUses[].guestCounts[].count","segments[].offer.productUses[].productRates.pricingMethod - new enum values \"PerProductPerOcc\" and \"PerProductPerGuestType\"","segments[].offer.productUses[].packageRates.pricingMethod - new enum values \"PerProductPerOcc\" and \"PerProductPerGuestType\"","data.hotelReservation.reportingData object","########## Other Changes ##########","remove specific type from the payment fields  segments.formOfPayment.paymentInfo|depositPayments.multiFactorInfo authenticationDidNotComplete, cavv, dsTransactionId, eci, identifierOfAuthorization, merchantName, tavv, threeDsAuthenticationValue, threeDsVersion, transactionXid"],"7.1.1":["########## Other Changes ##########","CFNumber and CXNumber - search new format"],"7.2.0":["########## New Features ##########","Field length extension","########## New in request ##########","Optional fields under the header Ama-Channel-Identifiers - channelClass, channelType, channel, subChannel","########## New in Response ##########","hotelreservation.ratePlans.longDescription","reportingData object in the pointOfSale object","########## Moved ##########","reportingData.channelClass to pointOfSale.reportingData.channelClass","reportingData.channelType to pointOfSale.reportingData.channelType","reportingData.channel to pointOfSale.reportingData.channel","reportingData.subChannel to pointOfSale.reportingData.subChannel","########## Other Changes ##########","Extend maxLength of ratePlanCode, priceGridCode, inventoryTypeCode, groupCode to 50"],"7.2.1":["########## Other Changes ##########","Support any OTA age qualifying code"],"7.3.0":["########## New Features ##########","Partial search for, data.cxNumber, data.cfNumber","Enhance price structure with distinction between taxes pre-paid and paid at hotel","Ability to modify the loyalty id in reservation","Ability to post partial deposit amount in create/modify reservation","New API services (Create, Modify and Retrieve) for link reservation","########## New Operation ##########","/hotel/reservations/{chainCode}/{cfNumber}/reinstate - Ability to move a cancelled/no-show/checked-out reservation back to confirmed status","########## New in request ##########","promoCode - create, modify, migrate, search","data.segments[0].id - reinstate","promoGroupCode - search","hotels.isPseudoProperty - migrate","hotels.masterPropertyCode - migrate","hotels.masterPropertyName - migrate","userProfilePendingReq.externalProfileIds - modify","corpMarketSegment - search","hide_no_show query parameter - search","includePseudoPropertyReservations - search","reportingData.channelClass - create, modify, migrate, search","reportingData.channelType - create, modify, migrate, search","reportingData.channel - create, modify, migrate, search","reportingData.subChannel - create, modify, migrate, search","promoCode - create, modify, migrate, search","data.segments[0].id - reinstate","promoGroupCode - search","hotels.isPseudoProperty - migrate","hotels.masterPropertyCode - migrate","hotels.masterPropertyName - migrate","userProfilePendingReq.externalProfileIds - modify","links - search","includeJointReservations - search","includeSharedReservations - search","########## New in Response ##########","hotelReservation.shareId","userProfileRes.externalProfileIds","userProfileSearchRes.externalProfileIds","corporateAccountInfoSearchRes.externalProfileIds","userProfilePendingRes.externalProfileIds","searchTravelAgencyInformation.externalProfileIds","userProfileHistoryRes.externalProfileIds","segments[].indicators.hasForcedRestrictions","segments[].indicators.hasForcedInventoryAvailability","segments[].indicators.isCancelledAfterDeadline","segments[].indicators.hasRateOverride","segments[].indicators.isRateOverrideWithinThreshold","userProfiles[].isSelfLimiting","userProfiles[].guestProfileStatus","userProfiles[].discrepancyFound","userProfiles[].discrepancyReason","userProfiles[].profileNotFound","segments[].owner.agencyDetails.discrepancyFound","segments[].owner.agencyDetails.discrepancyReason","segments[].owner.agencyDetails.profileNotFound","segments[].corporateAccountInfo[].companyProfileStatus","segments[].corporateAccountInfo[].discrepancyFound","segments[].corporateAccountInfo[].discrepancyReason","segments[].corporateAccountInfo[].profileNotFound","Updated enum for travelAgencyInfo.identifiers[0].type","hotels[].freeGuestsDefinitions","\\\"isPaidAtHotel\\\" under taxDefinitions(segment), to denote if tax needs to be paid at hotel.","\\\"payableAmount\\\" and \\\"payHotelAmount\\\" for all subTotalTaxes and subTotalServiceCharges, for the excluded taxes and service charges","\\\"payableAmtAfTx\\\" under all daily and total rate structures, to define amount after all taxes except those payable at the hotel","\\\"payableTotalTaxes\\\" and \\\"payHotelTotalTaxes\\\" in structures where total taxes(daily & all total) are defined, for taxes payable now and taxes payable at hotel","reportingData.channelClass","reportingData.channelType","reportingData.channel","reportingData.subChannel","hotelreservation.ratePlans.longDescription","segments[].offer.promoCode","hotelReservation.shareId","segments[].offer.promoGroupCode","userProfileRes.externalProfileIds","userProfileSearchRes.externalProfileIds","corporateAccountInfoSearchRes.externalProfileIds","userProfilePendingRes.externalProfileIds","searchTravelAgencyInformation.externalProfileIds","userProfileHistoryRes.externalProfileIds","segments[].indicators.hasForcedRestrictions","segments[].indicators.hasForcedInventoryAvailability","segments[].indicators.isCancelledAfterDeadline","segments[].indicators.hasRateOverride","segments[].indicators.isRateOverrideWithinThreshold","Add data.hotelreservation.userProfiles[0].isSelfLimiting","Add data.hotelreservation.userProfiles[0].guestProfileStatus","Add data.hotelreservation.userProfiles[0].discrepancyFound","Add data.hotelreservation.userProfiles[0].discrepancyReason","Add data.hotelreservation.userProfiles[0].profileNotFound","Add data.hotelReservation.segments[0].owner.agencyDetails.discrepancyFound","Add data.hotelReservation.segments[0].owner.agencyDetails.discrepancyReason","Add data.hotelReservation.segments[0].owner.agencyDetails.profileNotFound","Add data.hotelReservation.segments[0].corporateAccountInfo[0].companyProfileStatus","data.hotelReservation.segments[0].corporateAccountInfo[0].discrepancyFound","data.hotelReservation.segments[0].corporateAccountInfo[0].discrepancyReason","data.hotelReservation.segments[0].corporateAccountInfo[0].profileNotFound","Updated enum for travelAgencyInfo.identifiers[0].type","Added flag \"isPaidAtHotel\" under taxDefinitions(segment), to denote if tax needs to be paid at hotel.","Added \"payableAmount\" and \"payHotelAmount\" for all subTotalTaxes and subTotalServiceCharges, for the excluded taxes and service charges","Added \"payableAmtAfTx\" under all daily and total rate structures, to define amount after all taxes except those payable at the hotel","Added \"payableTotalTaxes\" & \"payHotelTotalTaxes\" in structures where total taxes(daily & all total) are defined, for taxes payable now and taxes payable at hotel","hotels[].freeGuestsDefinitions","########## New in Request and Response ##########","segments[].traces","segments[].alerts","segments[].serviceRequest.type","segments[].offer.promoCode","segments[].offer.promoGroupCode","corporateAccount.externalProfileIds","userProfilePendingReq.externalProfileIds","agencyDetails.externalProfileIds","data.hotelLinkReservation.type","data.hotelLinkReservation.sharePricingMethod","########## Renamed ##########","data.hotelReservation.folderId to data.hotelReservation.linkId","########## Other Changes ##########","Reduce maxLength to 10 of hotelReservation.reservationIds.cxNumber","Extend maxLength to 50 for ratePlanCode, priceGridCode, inventoryTypeCode fields","Updated maxLength of requestCode in specialRequests and specialRequestsReq to 20","Replaced fields data.hotelReservation.linkId and data.hotelReservation.shareId with object data.hotelReservation.links containing fields data.hotelReservation.links.id and data.hotelReservation.links.type","Updated enum for bookingPatterning by adding [Anytime]","Change description of HotelLinkReservationReq.cfNumbers, nationalities, linkModificationChanges, migGuestsReq","Optional cfNumbers in HotelLinkReservationRes","Increase length of serviceRequest code from 4..4 to 4..20\"","Update of the reinstateReservationReq segments description","length of groupCode search parameter from 3..4 to 2..51","change description of propertyCode, promoCodes, promoGroupCodes search criteria"],"7.3.1":["########## New in Response ##########","Added \"payableAmount\" and \"payHotelAmount\" for all subTotalTaxes and subTotalServiceCharges, for the excluded taxes and service charges in Retrieve History","Added \"payableAmtAfTx\" under all daily and total rate structures in Retrieve History, to define amount after all taxes except those payable at the hotel","Added \"payableTotalTaxes\" & \"payHotelTotalTaxes\" in structures where total taxes(daily & all total) are defined in Retrieve History, for taxes payable now and taxes payable at hotel"],"7.4.0":["########## New in request ##########","data.reportingData.reportingCode for search","data.externalShareId for search","########## New in response ##########","data.hotelReservation.creator.reportingData.reportingCode","data.hotelReservation.requestor.reportingData.reportingCode","########## New in Request and Response ##########","data.hotelReservation.segment[].creator.reportingData.reportingCode","data.hotelReservation.segment[].requestor.reportingData.reportingCode","data.hotelReservation.reservationIds.externalShareId","########## New Operation ##########","/reservation/chains/{chainCode}/links/{linkId}/detailed for synchronizing share","########## Other Changes ##########","response error code 429 added",".data.hotelReservation.segments[0].serviceRequests[0].code - minlength reduced from 4 to 1 in both request and response",".data.hotelReservation.segments[0].owner.agencyDetails.agencyProfileStatus - deprecated in Request",".data.hotelReservation.segments[0].owner.agencyDetails.profileNotFound - deprecated in Request",".data.hotelReservation.segments[0].owner.agencyDetails.discrepancyFound - deprecated in Request",".data.hotelReservation.segments[0].owner.agencyDetails.discrepancyReason - deprecated in Request"],"7.4.1":["########## Other Changes ##########",".data.hotelReservation.segments[0].offer.productUses - link fixed in request API",".data.hotelReservation.segments[0].offer.productUses[0].routingInstructions[0].dow - Corrected by masking it in request API"],"7.5.0":["########## New in Request and Response ##########",".data.hotelReservation.segments[0].arrivalAmenities[0].ArrivalAmenity - create, modify, reinstate, migrate, retrieve, history",".data.hotelReservation.chargePrivilege -  create, modify, reinstate, migrate, retrieve, history","########## New in response ##########",".data.creator.VendorName - create, modify, retrieve, search, migrate",".data.requestor.VendorName - create, modify, retrieve, search, migrate",".data.hotelReservation.segments[0].creator.VendorName - create, modify, retrieve, search, migrate",".data.hotelReservation.segments[0].requestor.VendorName - create, modify, retrieve, search, migrate"],"7.5.1":["########## Other Changes ##########",".data.hotelReservation.segments[0].offer.productUses - link fixed in request API",".data.hotelReservation.segments[0].offer.productUses[0].routingInstructions[0].dow - Corrected by masking it in request API"],"7.6.0":["########## New in Request and Response ##########",".data.hotelReservation.segments[0].offer.productUses[0].routingInstructions[0].dow - create, modify, retrieve, migrate, Search",".data.hotelReservation.segments[0].offer.rateAccessCode - create, modify, retrieve, history","########## New in response ##########",".data.hotelReservation.segments[0].offer.commission.amount- create, modify, retrieve, migrate",".data.hotelReservation.segments[0].offer.rateAccessCode - search","########## Other Changes ##########",".data.hotelReservation.ratePlans[0].name - max item limit of the array extended from 5 to 28",".data.hotelReservation.ratePlans[0].description - max item limit of the array extended from 5 to 28",".data.hotelReservation.products[0].inventoryTypeName - max item limit of the array extended from 5 to 28",".data.hotelReservation.products[0].description - max item limit of the array extended from 5 to 28","########## New in Request ##########",".data.hotelReservation.segments[0].offer.rateAccessCode - migrate"]},"termsOfService":"https://developers.amadeus.com","contact":{"name":"Amadeus Hospitality Systems Integration Support"},"license":{"name":"Amadeus IT Group SA","url":"https://www.amadeus.com"}},"basePath":"/v7","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"tags":[{"name":"1-Step Operations"},{"name":"Retrieve Operations"},{"name":"2-Step Operations"},{"name":"Reservation Link"}],"paths":{"/hotel/reservations/{chainCode}/pending":{"post":{"tags":["2-Step Operations"],"operationId":"postCreateReservationPending","summary":"create-pending","description":"This service gives the possibility to the API users to create a reservation in pending status. \n\n If the user wants to confirm the creation, a request of commit needs to be used to change the status to confirmed.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/createPendingReservation"}],"responses":{"201":{"$ref":"#/responses/reservationCreatePendingResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/hotel/reservations/{chainCode}/{cfNumber}":{"get":{"tags":["Retrieve Operations"],"operationId":"getRetrieveReservation","summary":"retrieve","description":"This service gives the possibility to the API users to retrieve the last committed image of the reservation by using the confirmation number in the query. \n\n The retrieve response, if requested, can also contain the history section: a list of all the committed images of the reservation.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/history"},{"$ref":"#/parameters/synchroNumber"},{"$ref":"#/parameters/segmentIds"},{"$ref":"#/parameters/retrieveDelta"}],"responses":{"200":{"$ref":"#/responses/reservationRetrieveResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/hotel/reservations/{chainCode}/{cfNumber}/reinstate":{"post":{"tags":["1-Step Operations"],"operationId":"postReinstateReservation","summary":"reinstate","description":"This service gives the possibility to the API users to reinstate a reservation which is in a cancelled, checked-out or no-show status.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/reinstateReservation"}],"responses":{"200":{"$ref":"#/responses/reservationModifyResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/hotel/reservations/{chainCode}/{cfNumber}/commit":{"put":{"tags":["2-Step Operations"],"operationId":"putCommitReservation","summary":"commit","description":"This service gives the possibility to the API users to confirm all the actions done from the starting request to the commit event. \n\n It is only after the commit that all the actions are confirmed and the booker is engaged.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/sendUserNotif"}],"responses":{"200":{"$ref":"#/responses/reservationResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/hotel/reservations/{chainCode}/{cfNumber}/pending":{"delete":{"tags":["2-Step Operations"],"operationId":"deleteIgnoreReservation","summary":"ignore","description":"This service gives the possibility to the API users to ignore the current pending transaction for a given reservation. In case there is no previous committed image for this reservation, no data element is sent back. ","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/baseImageId"}],"responses":{"200":{"$ref":"#/responses/reservationResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}},"put":{"tags":["2-Step Operations"],"operationId":"putModifyReservationPending","summary":"modify-pending","description":"This service gives the possibility to the API users to modify the reservation in pending status. \n\n If the user wants to confirm the modification, a request of commit needs to be used to change the status to confirmed.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/modifyPendingReservation"},{"$ref":"#/parameters/baseImageId"}],"responses":{"200":{"$ref":"#/responses/reservationModifyPendingResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}},"patch":{"tags":["2-Step Operations"],"operationId":"patchPartialModifyReservationPending","summary":"partial-modify-pending","description":"This service gives the possibility to the API users to partially modify the reservation in pending status. \n\n If the user wants to confirm the modification, a request of commit needs to be used to change the status to confirmed.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/partialModifyReservation"},{"$ref":"#/parameters/baseImageId"}],"responses":{"200":{"$ref":"#/responses/reservationModifyPendingResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/hotel/reservations/{chainCode}/{cfNumber}/cancel/pending":{"put":{"tags":["2-Step Operations"],"operationId":"putCancelReservationPending","summary":"cancel-pending","description":"This service gives the possibility to the API users to cancel the whole reservation in pending status. \n\n If the user wants to confirm the cancellation, a request of commit needs to be used to change the status to confirmed.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/cfNumber"},{"$ref":"#/parameters/cancelReservation"},{"$ref":"#/parameters/baseImageId"}],"responses":{"200":{"$ref":"#/responses/reservationResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/hotel/reservations/{chainCode}/search":{"post":{"tags":["Retrieve Operations"],"operationId":"postSearchReservations","summary":"search","description":"This service gives the possibility to the API users to search for any reservation. The request must include the criteria used to identify the reservations or reservation's segment(s) wished. \n\n The system responds to the users with the list of reservation images corresponding to reservation-related criteria or having at least one segment matching segment-related criteria.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/searchReservation"}],"responses":{"200":{"$ref":"#/responses/reservationSearchResponse-postSearchReservations"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/reservation/chains/{chainCode}/links":{"post":{"tags":["Reservation Link"],"operationId":"postCreateLinkReservation","summary":"create-link","description":"This service gives the possibility to the API users to create a link between reservations.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/createLinkReservation"}],"responses":{"201":{"$ref":"#/responses/linkReservationResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/reservation/chains/{chainCode}/links/{linkId}":{"get":{"tags":["Reservation Link"],"operationId":"getRetrieveLinkReservation","summary":"retrieve-link","description":"This service returns the list of cfNumber of the linked reservation. The link reservations can be of two types Joint and Share. The type will be defined in the response body.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/linkId"}],"responses":{"200":{"$ref":"#/responses/linkReservationRetrieveResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}},"patch":{"tags":["Reservation Link"],"operationId":"patchPartialModifyLinkReservation","summary":"modify-link","description":"This service gives the possibility to the API users to add or remove reservations from a link.","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-reservation-owner"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/ama-user-session-id"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/linkId"},{"$ref":"#/parameters/partialModifyLinkReservation"}],"responses":{"200":{"$ref":"#/responses/linkReservationResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}},"/reservation/chains/{chainCode}/links/{linkId}/detailed":{"get":{"tags":["Reservation Link"],"operationId":"getSynchronizeShareReservation","summary":"retrieve-link-share-detail","description":"This service gives the possibility to synchronize share reservations between ACRS and PMS","parameters":[{"$ref":"#/parameters/ama-pos"},{"$ref":"#/parameters/ama-channel-identifiers"},{"$ref":"#/parameters/ama-remote-jump-data"},{"$ref":"#/parameters/chainCode"},{"$ref":"#/parameters/linkId"}],"responses":{"200":{"$ref":"#/responses/shareReservationSynchronizeResponse"},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"},"406":{"$ref":"#/responses/406"},"429":{"$ref":"#/responses/429"},"500":{"$ref":"#/responses/500"},"504":{"$ref":"#/responses/504"}}}}},"parameters":{"chainCode":{"name":"chainCode","in":"path","required":true,"description":"Chain code identifier.","type":"string","pattern":"[A-Z0-9]{3}","minLength":3,"maxLength":3},"cfNumber":{"name":"cfNumber","in":"path","required":true,"description":"Hotel Confirmation Number.","type":"string","pattern":"[A-Z0-9]{8,10}","minLength":8,"maxLength":10},"linkId":{"name":"linkId","in":"path","required":true,"description":"Link unique identifier.","type":"string","pattern":"[A-Z0-9]{8,10}","minLength":8,"maxLength":10},"history":{"name":"history","in":"query","required":false,"description":"Parameter used to request retrieve history.","type":"boolean","default":false},"synchroNumber":{"name":"synchroNumber","in":"query","required":false,"description":"Synchro Number to retrieve the reservation if the accommodation number corresponds to the last image or last committed image.","type":"integer","format":"int32"},"baseImageId":{"name":"baseImageId","in":"query","required":false,"description":"Image id of the reservation, on which the modification request is applied (present for future implementation).","type":"integer","format":"int32"},"segmentIds":{"name":"segmentIds","in":"query","required":false,"description":"List of segment ids corresponding to the segment(s) to be retrieved in the reservation image. Format: List of integers in [] separated by a comma (ie [1,2,3]).","type":"string","pattern":"^\\[([0-9]+,)*[0-9]+\\]$"},"retrieveDelta":{"name":"retrieveDelta","in":"query","required":false,"description":"Indicator used to send delta between current and previous committed image. If flag retrieveDelta is false, do not send difference between images. If retrieveDelta flag is true, send difference between images.","type":"boolean","default":false},"sendUserNotif":{"name":"sendUserNotif","in":"query","required":false,"description":"Indicator used to determine when a notification is sent to a user. If true, send user a notification. If false, do not send user a notification.","type":"boolean","default":false},"createPendingReservation":{"name":"createPendingReservation","in":"body","schema":{"$ref":"#/definitions/ReservationPendingReq"}},"modifyPendingReservation":{"name":"modifyPendingReservation","in":"body","schema":{"$ref":"#/definitions/ReservationModifyPendingReq"}},"partialModifyReservation":{"name":"partialModifyReservation","in":"body","schema":{"$ref":"#/definitions/ReservationPartialModifyReq"}},"reinstateReservation":{"name":"reinstateReservation","in":"body","schema":{"$ref":"#/definitions/ReservationReinstateReq"}},"cancelReservation":{"name":"cancelReservation","in":"body","schema":{"$ref":"#/definitions/CancellationReq"}},"searchReservation":{"name":"searchReservation","in":"body","schema":{"$ref":"#/definitions/ReservationSearchReq"}},"createLinkReservation":{"name":"createReservation","in":"body","schema":{"$ref":"#/definitions/LinkReservationReq"}},"partialModifyLinkReservation":{"name":"modifyLinkReservation","in":"body","schema":{"$ref":"#/definitions/LinkReservationModifyReq"}},"ama-pos":{"name":"Ama-Pos","in":"header","required":false,"type":"string","description":"Schema must match with Ama-Pos definition."},"ama-reservation-owner":{"name":"Ama-Reservation-Owner","in":"header","required":false,"type":"string","description":"Schema must match with Ama-Reservation-Owner definition."},"ama-channel-identifiers":{"name":"Ama-Channel-Identifiers","in":"header","required":false,"type":"string","description":"Schema must match with Ama-Channel-Identifiers definition."},"ama-user-session-id":{"name":"Ama-User-Session-Id","in":"header","required":false,"type":"string","pattern":"[a-zA-Z0-9-]{1,64}","minLength":1,"maxLength":64,"description":"Unique session identifier of the user (present for future implementation)."},"ama-remote-jump-data":{"name":"Ama-Remote-Jump-Data","in":"header","required":false,"type":"string","description":"Schema must match with Ama-Remote-Jump-Data definition."}},"definitions":{"propertyChainCode":{"description":"unique identifier of a Chain in the CRS","type":"string","maxLength":3,"pattern":"[A-Z0-9]{2,3}","example":"INT"},"brandCode":{"description":"unique identifier of a Brand in a Chain","type":"string","pattern":"[A-Z0-9]{2,3}","example":"BRD"},"propertyName":{"description":"The name of the property","type":"string","minLength":1,"maxLength":64},"cityCode":{"description":"The code of the city of the property","type":"string","pattern":"[A-Za-z0-9]{3,5}","minLength":3,"maxLength":5},"regionCode":{"description":"The code of the region of the property","type":"string","pattern":"[A-Za-z0-9]{1,3}","minLength":1,"maxLength":3,"example":"01"},"dow":{"description":"List of applicable days of weeks. 'MTWTFSS' for all days of weeks. A dash is present for any missing day. For instance, 'MT-----' for Monday and Tuesday only, '-T-T---' for Tuesday and Thursday only","type":"string"},"comments":{"description":"List the comments.","type":"array","items":{"type":"object","title":"comment","required":["type","text"],"properties":{"type":{"$ref":"#/definitions/typeOfComments"},"language":{"$ref":"#/definitions/language"},"text":{"type":"array","items":{"$ref":"#/definitions/commentText"}}}}},"typeOfComments":{"description":"Type of the comment, ['supplementary info' or 'confidential remark' or 'OriginatorChannelViewable']. [confidential remark] is not visible by the guest. [OriginatorChannelViewable] is only valid at reservation level (not segment)","type":"string","enum":["supplementary info","confidential remark","OriginatorChannelViewable"]},"language":{"description":"ISO 639-1 code, like EN","type":"string","pattern":"[A-Za-z]{2}","minLength":2,"maxLength":2},"commentText":{"description":"Free flow text in the comment. If the comment type is [supplementary info], the comment text is truncated after 51 characters. If the comment type is [confidential remark], the comment text is truncated after 57 characters.","type":"string","minLength":1,"maxLength":1200},"customData":{"description":"All data under customData are stored in the reservation and returned in the response and retrieve. Any valid Json object is accepted.","type":"object","minLength":1,"maxLength":1200},"description":{"type":"object","additionalProperties":{"description":"Multi-line description text","type":"array","maxItems":5,"items":{"type":"string","maxLength":1200,"minLength":1}},"example":{"en":["line 1","line 2","line 3"],"fr":["ligne 1","ligne 2","ligne 3"]}},"DescriptionOfRatePlanAndInventoryType":{"type":"object","additionalProperties":{"description":"Multi-line description text","type":"array","maxItems":28,"items":{"type":"string","maxLength":1200,"minLength":1}},"example":{"en":["line 1","line 2","line 3"],"fr":["ligne 1","ligne 2","ligne 3"]}},"externalProfileId":{"description":"corporate, agency & traveller profile ids from external system","type":"object","required":["value","type"],"properties":{"value":{"description":"Profile id received from external system","type":"string","maxLength":50},"type":{"description":"Source of the external id","type":"string","maxLength":50}}},"discrepancyFound":{"description":"this field is deprecated when used in request. Any value provided in input will be ignored. Indicates there are one or more discrepancies in the profile data received in the reservation request","type":"boolean"},"discrepancyReason":{"description":"this field is deprecated when used in request. Any value provided in input will be ignored. Categories of information which has discrepancy","type":"array","maxItems":50,"items":{"type":"string"}},"profileNotFound":{"description":"this field is deprecated when used in request. Any value provided in input will be ignored. Indicates the profile was not found in the profile system","type":"boolean"},"pointOfSale":{"type":"object","required":["vendorCode","channelCode"],"properties":{"hotelSource":{"description":"the hotel code of creator of the reservation or the requestor of the last transaction","$ref":"#/definitions/propertyCode"},"vendorCode":{"description":"the vendor code of the creator of the reservation or the requestor of the transaction","$ref":"#/definitions/vendorCode"},"vendorName":{"description":"Name of the vendor","$ref":"#/definitions/VendorName"},"vendorTypes":{"description":"the vendor type code [0 = Unknown, 1 = PMS, 2 = booking tool, 3 = brand website, 4 = GDS/3rd party website, 5 = mobile, 6 = alternate distribution system]","type":"array","items":{"type":"integer","enum":[1,2,3,4,5,6]}},"channelCode":{"description":"the channel code of the creator of the reservation or the requestor of the transaction","$ref":"#/definitions/channelCode"},"channelSubCode":{"description":"sub-channel code as it has been provided by the creator of the reservation or the requestor of the transaction","$ref":"#/definitions/channelCode"},"metricsCode":{"description":"the metrics code of the creator of the reservation or the requestor of the transaction, it is only optional for the retrieve of a group record and should always be returned for a standard reservation","$ref":"#/definitions/metricsCode"},"travelAgencyInfo":{"$ref":"#/definitions/travelAgencyInformation"},"origin":{"description":"Indicates the Expedia channel that was used for the reservation, if relevant","type":"string"},"callCenterInformation":{"description":"List of call centers information","type":"array","maxItems":2,"items":{"$ref":"#/definitions/callCenterInformation"}},"reportingData":{"$ref":"#/definitions/reportingData"}}},"searchPointOfSale":{"type":"object","properties":{"travelAgencyInfo":{"$ref":"#/definitions/searchTravelAgencyInformation"},"vendorCode":{"description":"the vendor code of the creator of the reservation or the requestor of the transaction","$ref":"#/definitions/vendorCode"},"vendorName":{"description":"Name of the vendor","$ref":"#/definitions/VendorName"},"reportingData":{"$ref":"#/definitions/reportingData"}}},"searchReservationOwner":{"type":"object","required":["agencyDetails"],"properties":{"agencyDetails":{"$ref":"#/definitions/searchTravelAgencyInformation"}}},"historyPointOfSale":{"type":"object","required":["vendorCode","channelCode"],"properties":{"hotelSource":{"description":"Hotel code of the originator of the request (used in case of booking tool or PMS)","$ref":"#/definitions/propertyCode"},"vendorCode":{"description":"the vendor code of the originator of the request","$ref":"#/definitions/vendorCode"},"vendorName":{"description":"Name of the vendor","$ref":"#/definitions/VendorName"},"channelCode":{"description":"the channel code as it has been provided by the originator of the request","$ref":"#/definitions/channelCode"},"channelSubCode":{"description":"the sub-channel code as it has been provided by the originator of the request","$ref":"#/definitions/channelCode"},"travelAgencyInfo":{"$ref":"#/definitions/historyTravelAgencyInformation"},"origin":{"description":"Indicates the Expedia channel that was used for the transaction, if relevant","type":"string"},"callCenterInformation":{"description":"List of call centers information","type":"array","maxItems":2,"items":{"$ref":"#/definitions/callCenterInformation"}},"reportingData":{"$ref":"#/definitions/reportingData"}}},"vendorCode":{"description":"vendor code.","type":"string","pattern":"[A-Z0-9]{5,5}","example":"ABCDE","minLength":5,"maxLength":5},"VendorName":{"description":"Name that identifies the Vendor profile.","minLength":1,"maxLength":25,"type":"string","example":"vendor's name"},"channelCode":{"description":"channel code.","type":"string","pattern":"[A-Z0-9]{2,2}","example":"1A","minLength":2,"maxLength":2},"metricsCode":{"description":"metrics code.","type":"string","pattern":"[A-Z0-9]{3,3}","example":"ABC","minLength":3,"maxLength":3},"travelAgencyInformation":{"description":"the travel agency details","type":"object","required":["identifiers"],"properties":{"identifiers":{"description":"List of identifiers","type":"array","items":{"$ref":"#/definitions/agencyIdentifiers"}},"agentInfo":{"$ref":"#/definitions/agentInformation"},"name":{"description":"Name of the travel agency","type":"string"},"agencyProfileId":{"$ref":"#/definitions/agencyProfileId"},"address":{"description":"Address of the travel agency","$ref":"#/definitions/addressWithoutIndex"},"telephone":{"description":"Telephone of the travel agency","$ref":"#/definitions/telephone"},"email":{"description":"Email address of the travel agency","$ref":"#/definitions/email"}}},"searchTravelAgencyInformation":{"description":"the travel agency details","type":"object","properties":{"name":{"description":"Name of the travel agency","type":"string"},"agencyProfileStatus":{"$ref":"#/definitions/agencyProfileStatus"},"externalProfileIds":{"description":"Agency profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}}}},"historyTravelAgencyInformation":{"description":"the travel agency details","type":"object","required":["identifiers"],"properties":{"identifiers":{"description":"List of identifiers","type":"array","items":{"$ref":"#/definitions/agencyIdentifiers"}},"agentInfo":{"$ref":"#/definitions/agentInformation"},"agentUserId":{"description":"User ID of the travel agent in the GDS used","$ref":"#/definitions/userId"},"name":{"description":"Name of the travel agency","type":"string"},"agencyProfileId":{"$ref":"#/definitions/agencyProfileId"},"address":{"description":"Address of the travel agency","$ref":"#/definitions/addressWithoutIndex"},"telephone":{"description":"Telephone of the travel agency","$ref":"#/definitions/telephone"},"email":{"description":"Email address of the travel agency","$ref":"#/definitions/email"}}},"agentInformation":{"type":"object","properties":{"agentDutyCode":{"$ref":"#/definitions/agentDutyCode"},"agentInitials":{"$ref":"#/definitions/agentInitials"},"agentLocation":{"$ref":"#/definitions/agentLocation"},"agentSine":{"$ref":"#/definitions/agentSine"}}},"agentDutyCode":{"description":"Duty code of the travel agent","type":"string"},"agentInitials":{"description":"Initials of the travel agent","type":"string"},"agentLocation":{"description":"Location of the travel agent","type":"string"},"agentSine":{"description":"Sign of the travel agent","type":"string"},"addressWithoutIndex":{"type":"object","properties":{"type":{"$ref":"#/definitions/addressType"},"addressLines":{"$ref":"#/definitions/addressLines"},"cityName":{"$ref":"#/definitions/cityName"},"postalCode":{"$ref":"#/definitions/postalCode"},"county":{"$ref":"#/definitions/county"},"stateProv":{"$ref":"#/definitions/stateProv"},"countryName":{"$ref":"#/definitions/countryName"},"countryCode":{"$ref":"#/definitions/countryCode"},"companyName":{"$ref":"#/definitions/companyName"},"unstructuredAddress":{"$ref":"#/definitions/unstructuredAddress"}}},"callCenterInformation":{"type":"object","required":["type","id"],"properties":{"type":{"$ref":"#/definitions/callCenterType"},"id":{"$ref":"#/definitions/callCenterId"}}},"callCenterType":{"description":"Type of information","type":"string","enum":["VDN","ConnId"]},"callCenterId":{"description":"Information details","type":"string"},"reservationOwner":{"type":"object","required":["agencyDetails"],"properties":{"agencyDetails":{"$ref":"#/definitions/agencyDetails"}}},"agencyDetails":{"type":"object","required":["identifiers"],"properties":{"identifiers":{"description":"List of identifiers","type":"array","items":{"$ref":"#/definitions/agencyIdentifiers"}},"name":{"description":"The agency name","type":"string"},"isValid":{"description":"Indicates that the IATA code of the travel agency is valid","type":"boolean"},"isTrusted":{"description":"Indicates that the travel agency is trusted","type":"boolean"},"address":{"description":"Address of the travel agency","$ref":"#/definitions/addressWithoutIndex"},"telephone":{"description":"Telephone of the travel agency","$ref":"#/definitions/telephone"},"email":{"description":"Email address of the travel agency","$ref":"#/definitions/email"},"agencyProfileId":{"$ref":"#/definitions/agencyProfileId"},"agencyProfileStatus":{"$ref":"#/definitions/agencyProfileStatus"},"profileNotFound":{"$ref":"#/definitions/profileNotFound"},"discrepancyFound":{"$ref":"#/definitions/discrepancyFound"},"discrepancyReason":{"$ref":"#/definitions/discrepancyReason","description":"this field is deprecated when used in request. Any value provided in input will be ignored. List of fields separated by comma which has discrepancy"},"externalProfileIds":{"description":"Agency profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}}}},"agencyIdentifiers":{"type":"object","required":["id"],"properties":{"id":{"description":"identifier of the agency","type":"string"},"type":{"description":"type of the agency identifier","type":"string","enum":["IATA","SGA","ABTA","CLIA","ARC","TRUE"]}}},"agencyProfileId":{"description":"Agency identifier on the profile system.","type":"string","pattern":"[a-zA-Z0-9]{1,50}","minLength":1,"maxLength":50},"agencyProfileStatus":{"description":"this field is deprecated when used in request. Any value provided in input will be ignored. Status of the agency in the profile system","type":"string","enum":["Active","Inactive"]},"responseError_400":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":400,"code":110010,"title":"Missing Mandatory Data","detail":"Missing mandatory data in the request. Please provide all the missing data.","source":{"parameter":"startDate","example":"2020-01-01T00:00:00.000Z"}}}},"responseError_401":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":401,"code":71,"title":"Wrong authentication credentials"}}},"responseError_403":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":403,"code":15344,"title":"Check-in date not compliant with closed to arrival setting at hotel level."},"data":{"denials":[{"identifier":17,"date":"2020-06-06","isHouseLevel":true,"priceGridCode":"BA","ratePlanCode":"IRRPA","reason":"House closed to arrival","type":"HSP"}]}}},"responseError_404":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":404,"code":97,"title":"No reservation available for the input cancellation number"}}},"responseError_406":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":406,"code":172,"title":"Requested version not supported [3.99]"}}},"responseError_429":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":429,"code":38194,"title":"Too many requests"}}},"responseError_500":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":500,"code":448,"title":"System error"}}},"responseError_504":{"type":"object","required":["error"],"properties":{"error":{"$ref":"#/definitions/error"},"data":{"type":"object","title":"dataErrorRes","properties":{"denials":{"type":"array","items":{"$ref":"#/definitions/denial"}}}}},"example":{"error":{"status":504,"code":15346,"title":"ESPINV Message too old"}}},"error":{"type":"object","title":"Issue","properties":{"status":{"description":"The HTTP status code applicable to this error","type":"integer","example":400},"code":{"description":"An application-specific error code","type":"integer","example":14453},"title":{"description":"A short summary of the error","type":"string"},"detail":{"description":"Explanation of the error","type":"string"},"source":{"type":"object","title":"IssueSource","description":"An object containing references to the source of the error","properties":{"pointer":{"description":"A JSON Pointer [RFC6901] to the associated entity in the request document","type":"string"},"parameter":{"description":"A string indicating which URI query parameter caused the issue","type":"string"},"example":{"type":"string","description":"A sample input to guide the user when resolving this issue"}}}}},"warning":{"type":"object","title":"Warning","properties":{"status":{"description":"the HTTP status code applicable to this warning.","type":"integer","example":200},"code":{"description":"an application-specific warning code.","type":"integer","example":14353},"id":{"description":"Id of the warning, used to link the warning to a specific element in the response","type":"integer"},"isPreventingCommit":{"description":"Boolean to indicate if the warning will prevent the commit action.","type":"boolean"},"title":{"description":"a short summary of the warning.","type":"string"},"detail":{"description":"explanation of the warning.","type":"string"},"source":{"type":"object","title":"WarningSource","description":"an object containing references to the source of the warning","minProperties":1,"properties":{"pointer":{"description":"a JSON Pointer [RFC6901] to the associated entity in the request document","type":"string"},"parameter":{"description":"a string indicating which URI query parameter caused the warning","type":"string"},"example":{"type":"string","description":"A sample input to guide the user when resolving this warning"}}}}},"denial":{"type":"object","required":["identifier","type","reason","date","isHouseLevel"],"properties":{"identifier":{"description":"Unique identifier of the denial returned","type":"integer"},"type":{"description":"The denial type","type":"string","example":"HSO"},"reason":{"description":"Description of the denial reason","type":"string","example":"No Rates/Rooms Available"},"date":{"description":"Represents the first date that caused the denial. For date-driven denials, it is either a date within the stay, or the check-in date. For non-date-driven denials, it is the transaction date","type":"string","format":"date"},"isHouseLevel":{"description":"set to true if the denial is of House Level type, false otherwise.","type":"boolean"},"ratePlanCode":{"description":"In case of Rate Category denials, represents the rate category causing the denial.","$ref":"#/definitions/ratePlanCode"},"priceGridCode":{"description":"In case of Rate Category/Price Grid denials. Represents the price grid causing the denial or the price grid linked to the rate category causing the denial.","$ref":"#/definitions/priceGridCode"},"sellStrategyCode":{"description":"Represents the code of the Hotel Sell Strategy taken into account in the process","type":"string","pattern":"[A-Za-z0-9]{1,7}","minLength":1,"maxLength":7}}},"HotelReservationRes":{"description":"Full representation of reservation record","type":"object","required":["status","imageStatus","hotels","creationDateTime","lastUpdateDateTime","reservationIds","segments","products"],"properties":{"status":{"$ref":"#/definitions/resStatus"},"type":{"$ref":"#/definitions/reservationType"},"imageStatus":{"$ref":"#/definitions/imageStatus"},"creationDateTime":{"$ref":"#/definitions/createDateTime"},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"},"lastUpdateDateTimeHotelLocalTime":{"$ref":"#/definitions/lastUpdateDateTimeHotelLocalTime"},"cancellationDateTime":{"$ref":"#/definitions/cancellationDateTime"},"purgeDateTime":{"$ref":"#/definitions/purgeDateTime"},"authenticatedUser":{"description":"Authenticated user information","$ref":"#/definitions/authenticatedUser"},"impersonatedUser":{"description":"Impersonated user information.It is the one who does the transaction on behalf of the authenticated user","$ref":"#/definitions/authenticatedUser"},"reservationIds":{"$ref":"#/definitions/reservationIdsRes"},"hotels":{"description":"List of hotels","type":"array","items":{"$ref":"#/definitions/hotelRes"}},"products":{"description":"The list of products (base product + attribute(s)) returned","type":"array","items":{"$ref":"#/definitions/product"}},"attributes":{"description":"The list of attributes","type":"array","items":{"$ref":"#/definitions/attribute"}},"links":{"description":"Link reservation details.","type":"array","items":{"$ref":"#/definitions/reservationLinks"}},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractRes"}},"installments":{"description":"Deposit rule details","type":"array","maxItems":3,"items":{"$ref":"#/definitions/installment"}},"ratePlans":{"description":"List of rate plans used in the reservation","type":"array","items":{"$ref":"#/definitions/ratePlanRes"}},"userProfiles":{"description":"List of user profiles, at least one is mandatory for a 1 step","$ref":"#/definitions/guestsRes"},"segments":{"$ref":"#/definitions/segmentRes"},"totalReservation":{"description":"List of totals per currency","type":"array","items":{"$ref":"#/definitions/totalReservation"}},"totalOfActiveSegments":{"description":"List of totals per currency","type":"array","items":{"$ref":"#/definitions/totalOfActiveSegments"}},"comments":{"$ref":"#/definitions/comments"},"customData":{"$ref":"#/definitions/customData"},"invoiceIds":{"type":"array","description":"List of invoice Ids. Each Id is unique in the reservation.","items":{"$ref":"#/definitions/invoiceId"}},"printRate":{"$ref":"#/definitions/printRate"},"chargePrivilege":{"$ref":"#/definitions/chargePrivilege"}}},"HotelReservationRetrieveRes":{"description":"Full representation of reservation record","type":"object","required":["status","imageStatus","hotels","creationDateTime","lastUpdateDateTime","reservationIds","segments","products"],"properties":{"status":{"$ref":"#/definitions/resStatus"},"type":{"$ref":"#/definitions/reservationType"},"imageStatus":{"$ref":"#/definitions/imageStatus"},"creationDateTime":{"$ref":"#/definitions/createDateTime"},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"},"lastUpdateDateTimeHotelLocalTime":{"$ref":"#/definitions/lastUpdateDateTimeHotelLocalTime"},"cancellationDateTime":{"$ref":"#/definitions/cancellationDateTime"},"purgeDateTime":{"$ref":"#/definitions/purgeDateTime"},"authenticatedUser":{"description":"Authenticated user information","$ref":"#/definitions/authenticatedUser"},"impersonatedUser":{"description":"Impersonated user information","$ref":"#/definitions/authenticatedUser"},"reservationIds":{"$ref":"#/definitions/reservationIdsRes"},"hotels":{"description":"List of hotels","type":"array","items":{"$ref":"#/definitions/hotelRes"}},"products":{"description":"The list of products (base product + attribute(s)) returned","type":"array","items":{"$ref":"#/definitions/product"}},"attributes":{"description":"The list of attributes","type":"array","items":{"$ref":"#/definitions/attribute"}},"links":{"description":"Link reservation details.","type":"array","items":{"$ref":"#/definitions/reservationLinks"}},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractRes"}},"installments":{"description":"Deposit rule details","type":"array","maxItems":3,"items":{"$ref":"#/definitions/installment"}},"ratePlans":{"description":"List of rate plans used in the reservation","type":"array","items":{"$ref":"#/definitions/ratePlanRes"}},"userProfiles":{"description":"List of user profiles, at least one is mandatory for a 1 step","$ref":"#/definitions/guestsRes"},"segments":{"$ref":"#/definitions/segmentRes"},"totalReservation":{"description":"List of totals per currency","type":"array","items":{"$ref":"#/definitions/totalReservation"}},"totalOfActiveSegments":{"description":"List of totals per currency","type":"array","items":{"$ref":"#/definitions/totalOfActiveSegments"}},"comments":{"$ref":"#/definitions/comments"},"customData":{"$ref":"#/definitions/customData"},"invoiceIds":{"type":"array","description":"List of invoice Ids. Each Id is unique in the reservation.","items":{"$ref":"#/definitions/invoiceId"}},"sendUserNotification":{"type":"boolean","description":"Indicator used to determine when a notification is sent to a user, it is only responded if the retrieve_delta request parameter is set to true."},"printRate":{"$ref":"#/definitions/printRate"},"chargePrivilege":{"$ref":"#/definitions/chargePrivilege"}}},"HotelReservationPendingRes":{"description":"Full representation of reservation record","type":"object","required":["status","imageStatus","hotels","creationDateTime","lastUpdateDateTime","reservationIds","segments","products"],"properties":{"status":{"$ref":"#/definitions/resStatus"},"type":{"$ref":"#/definitions/reservationType"},"imageStatus":{"$ref":"#/definitions/imageStatus"},"creationDateTime":{"$ref":"#/definitions/createDateTime"},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"},"lastUpdateDateTimeHotelLocalTime":{"$ref":"#/definitions/lastUpdateDateTimeHotelLocalTime"},"cancellationDateTime":{"$ref":"#/definitions/cancellationDateTime"},"purgeDateTime":{"$ref":"#/definitions/purgeDateTime"},"authenticatedUser":{"description":"Authenticated user information","$ref":"#/definitions/authenticatedUser"},"impersonatedUser":{"description":"Impersonated user information","$ref":"#/definitions/authenticatedUser"},"reservationIds":{"$ref":"#/definitions/reservationIdsRes"},"hotels":{"description":"List of hotels","type":"array","items":{"$ref":"#/definitions/hotelRes"}},"products":{"description":"The list of products (base product + attribute(s)) returned","type":"array","items":{"$ref":"#/definitions/product"}},"attributes":{"description":"The list of attributes","type":"array","items":{"$ref":"#/definitions/attribute"}},"links":{"description":"Link reservation details.","type":"array","items":{"$ref":"#/definitions/reservationLinks"}},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractRes"}},"installments":{"description":"Deposit rule details","type":"array","maxItems":3,"items":{"$ref":"#/definitions/installment"}},"ratePlans":{"description":"List of rate plans used in the reservation","type":"array","items":{"$ref":"#/definitions/ratePlanRes"}},"userProfiles":{"description":"List of user profiles, at least one is mandatory for a 1 step","$ref":"#/definitions/guestsPendingRes"},"segments":{"$ref":"#/definitions/segmentRes"},"totalReservation":{"description":"List of totals per currency","type":"array","items":{"$ref":"#/definitions/totalReservation"}},"totalOfActiveSegments":{"description":"List of totals per currency","type":"array","items":{"$ref":"#/definitions/totalOfActiveSegments"}},"comments":{"$ref":"#/definitions/comments"},"customData":{"$ref":"#/definitions/customData"},"invoiceIds":{"type":"array","description":"List of invoice Ids. Each Id is unique in the reservation.","items":{"$ref":"#/definitions/invoiceId"}},"printRate":{"$ref":"#/definitions/printRate"}}},"HotelLinkReservationRes":{"type":"object","required":["link"],"properties":{"link":{"$ref":"#/definitions/reservationLinks"},"cfNumbers":{"description":"List of Hotel Confirmation Numbers.","type":"array","items":{"$ref":"#/definitions/linkCfNumber"}},"sharePricingMethod":{"$ref":"#/definitions/sharePricingMethod"}}},"linkType":{"description":"Type of link.","type":"string","enum":["Joint","Share"]},"creationDate":{"description":"Date of creation (UTC)","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])","example":"2021-05-26"},"reservationLinks":{"type":"object","description":"Type of link and unique identifier.","required":["id","type"],"properties":{"id":{"$ref":"#/definitions/reservationLinkId"},"type":{"$ref":"#/definitions/linkType"}}},"SynchronizeShareSummary":{"type":"object","description":"Contains the details of the share.","required":["id"],"properties":{"id":{"$ref":"#/definitions/reservationLinkId"},"period":{"$ref":"#/definitions/period"},"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"corporateMarketSegment":{"$ref":"#/definitions/corporateMarketSegment"},"reportingData":{"$ref":"#/definitions/reportingData"}}},"reservationLinkId":{"description":"Unique link identifier.","type":"string","pattern":"[A-Z0-9]{8,10}","minLength":8,"maxLength":10},"sharePricingMethod":{"description":"Method of calculating prices.","type":"string","enum":["Full","Entire","Split"]},"ReservationRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"dataRes","properties":{"denials":{"description":"Request denial details","type":"array","items":{"$ref":"#/definitions/denial"}},"creator":{"description":"Contains the details of the channel which created the reservation","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"hotelReservation":{"$ref":"#/definitions/HotelReservationRes"}}}}},"ReservationPendingRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"dataPendingRes","properties":{"denials":{"description":"Request denial details","$ref":"#/definitions/denial"},"creator":{"description":"Contains the details of the channel which created the reservation","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"hotelReservation":{"$ref":"#/definitions/HotelReservationPendingRes"}}}}},"LinkReservationRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"dataRes","properties":{"hotelLinkReservation":{"description":"Full representation of link reservation record","$ref":"#/definitions/HotelLinkReservationRes"}}}}},"HotelReservationPendingReq":{"type":"object","required":["hotelReservation"],"properties":{"creator":{"description":"Contains the details of the channel which created the reservation. If provided in the payload, will be stored in the reservation. The channel headers must still be provided to perform the permissions check.","$ref":"#/definitions/pointOfSale"},"hotelReservation":{"type":"object","title":"hotelResPendingReq","required":["hotels","segments"],"properties":{"reservationIds":{"$ref":"#/definitions/reservationIdsReq"},"type":{"$ref":"#/definitions/reservationType"},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractReq"}},"installments":{"description":"Deposit rule details","type":"array","maxItems":3,"items":{"$ref":"#/definitions/installment"}},"purgeDateTime":{"description":"Date and time when the confirmation number has to be released. Only sent in migration requests, in partial freeze mode","$ref":"#/definitions/purgeDateTime"},"hotels":{"description":"List of hotels","type":"array","items":{"$ref":"#/definitions/hotelReq"}},"userProfiles":{"$ref":"#/definitions/guestsPendingReq"},"segments":{"$ref":"#/definitions/segmentReq"},"comments":{"$ref":"#/definitions/comments","description":"Comment details of the reservation. It describes the type, language and text of comments"},"customData":{"$ref":"#/definitions/customData","description":"All data under customData are stored in the reservation and returned in the response and retrieve. Any valid Json object is accepted"},"invoiceIds":{"type":"array","description":"List of invoice Ids. Each Id is unique in the reservation.","items":{"$ref":"#/definitions/invoiceId"}}}}}},"HotelReservationModifyPendingReq":{"description":"Full representation of reservation record","type":"object","required":["hotelReservation"],"properties":{"hotelReservation":{"type":"object","title":"hotelReservationReq","required":["hotels","segments"],"properties":{"reservationIds":{"$ref":"#/definitions/reservationIdsReq"},"type":{"$ref":"#/definitions/reservationType"},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractReq"}},"installments":{"description":"Deposit rule details","type":"array","maxItems":3,"items":{"$ref":"#/definitions/installment"}},"purgeDateTime":{"description":"Date and time when the confirmation number has to be released. Only sent in migration requests, in partial freeze mode","$ref":"#/definitions/purgeDateTime"},"hotels":{"description":"List of hotels","type":"array","items":{"$ref":"#/definitions/hotelReq"}},"userProfiles":{"$ref":"#/definitions/guestsPendingReq"},"segments":{"$ref":"#/definitions/segmentModifyPendingReq"},"comments":{"$ref":"#/definitions/comments"},"customData":{"$ref":"#/definitions/customData"},"invoiceIds":{"type":"array","description":"List of invoice Ids. Each Id is unique in the reservation.","items":{"$ref":"#/definitions/invoiceId"}}}}}},"HotelLinkReservationReq":{"description":"Full representation of link reservation record","type":"object","title":"hotelReservation","required":["cfNumbers","type"],"properties":{"cfNumbers":{"description":"List of Hotel Confirmation Numbers.","type":"array","items":{"$ref":"#/definitions/cfNumber"}},"type":{"$ref":"#/definitions/linkType"},"sharePricingMethod":{"$ref":"#/definitions/sharePricingMethod"}}},"ReservationPendingReq":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/definitions/HotelReservationPendingReq"}}},"ReservationModifyPendingReq":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/definitions/HotelReservationModifyPendingReq"}}},"ReservationReinstateReq":{"description":"Reservation to be reinstated","type":"object","required":["data"],"properties":{"data":{"type":"object","title":"reinstateReservationReq","properties":{"segments":{"description":"List of segments to be reinstated. If no segment id is specified, all the segments of the reservation are reinstated.","type":"array","items":{"type":"object","title":"segment","required":["id"],"properties":{"id":{"type":"integer","description":"Identify the segment inside the reservation all along the reservation life."}}}}}}}},"LinkReservationReq":{"type":"object","required":["data"],"properties":{"data":{"title":"linkReservationReq","type":"object","required":["hotelLinkReservation"],"properties":{"hotelLinkReservation":{"description":"Full representation of link reservation record","$ref":"#/definitions/HotelLinkReservationReq"}}}}},"ReservationRetrieveRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"dataRetrieveRes","properties":{"creator":{"description":"Contains the details of the channel which created the reservation","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"hotelReservation":{"$ref":"#/definitions/HotelReservationRetrieveRes"},"history":{"$ref":"#/definitions/history"},"modificationChanges":{"$ref":"#/definitions/modificationChanges"}}}}},"LinkReservationRetrieveRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"DataRes","properties":{"hotelLinkReservation":{"description":"Full representation of link reservation record","$ref":"#/definitions/HotelLinkReservationRes"}}}}},"ShareReservationSynchronizeRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"DataSynchronizeRes","required":["shareSummary"],"properties":{"shareSummary":{"$ref":"#/definitions/SynchronizeShareSummary"},"reservationSummaries":{"description":"Details about reservations which are part of share.","type":"array","items":{"$ref":"#/definitions/SynchronizeReservationSummary"}},"propertyCode":{"$ref":"#/definitions/propertyCode"},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"}}}}},"resStatus":{"description":"BK if all segments are in BK state, CL if all segments have been cancelled, MY otherwise.","type":"string","enum":["BK","MY","CL"]},"reservationType":{"description":"Type of the reservation, to identify if the reservation is a Group Master reservation or a individual reservation. An individual reservation can be  a picked up reservation or a transient one.","type":"string","default":"Individual","enum":["GroupMaster","Individual"]},"imageStatus":{"description":"status of the image of the reservation. Pending - after a 2-steps create before the commit. Committed - after the commit in a 2-steps process or after a successful creation for a 1-step process.","type":"string","enum":["Pending","Committed"]},"createDateTime":{"description":"Date and Time of creation (UTC)","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"createDateTimeHotelLocalTime":{"description":"Date and Time of creation, expressed in hotel local time","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"cancellationDateTime":{"description":"Date and time of cancellation (UTC)","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"cancellationDateTimeHotelLocalTime":{"description":"Date and time of cancellation, expressed in hotel local time","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"lastUpdateDateTime":{"description":"Date and time of the last active image (last modification for history), expressed in UTC","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"lastUpdateDateTimeHotelLocalTime":{"description":"Date and time of the last active image (last modification for history) expressed in hotel local time","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"purgeDateTime":{"description":"Date and time when the confirmation number has to be released (UTC)","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"reservationIdsRes":{"description":"Container for structured details of the guest name","type":"object","required":["cfNumber","imageId"],"properties":{"cfNumber":{"$ref":"#/definitions/cfNumber"},"cxNumber":{"$ref":"#/definitions/cxNumber"},"imageId":{"$ref":"#/definitions/imageId"},"committedSequenceNumber":{"$ref":"#/definitions/committedSequenceNumber"},"pnr":{"$ref":"#/definitions/pnr"},"extCfNumber":{"$ref":"#/definitions/extCfNumber"},"extCxNumber":{"$ref":"#/definitions/extCxNumber"},"pmsCfNumber":{"$ref":"#/definitions/pmsCfNumber"},"pmsCxNumber":{"$ref":"#/definitions/pmsCxNumber"},"externalShareId":{"$ref":"#/definitions/externalShareId"},"unsolicitedCancelId":{"$ref":"#/definitions/unsolicitedCancelId"}}},"groupContractReq":{"type":"object","required":["name","code"],"properties":{"code":{"description":"The group contract code","type":"string"},"name":{"description":"The group contract name","$ref":"#/definitions/description"},"description":{"description":"The group contract description","$ref":"#/definitions/description"},"bookingProcedures":{"description":"Group Contract Booking Procedures, free text explaining how the group can be booked","$ref":"#/definitions/description"},"industryType":{"description":"Industry type tag","type":"string"},"saleStatus":{"$ref":"#/definitions/saleStatus"},"businessSource":{"$ref":"#/definitions/businessSource"}}},"groupContractRes":{"type":"object","required":["name","code"],"properties":{"code":{"description":"The group contract code","type":"string"},"name":{"description":"The group contract name","$ref":"#/definitions/description"},"start":{"description":"Start date","type":"string","format":"date"},"end":{"description":"End date","type":"string","format":"date"},"description":{"description":"The group contract description","$ref":"#/definitions/description"},"referenceRatePlanCode":{"description":"Reference rate plan code for group contract","$ref":"#/definitions/ratePlanCode"},"bookingProcedures":{"description":"Group Contract Booking Procedures, free text explaining how the group can be booked","$ref":"#/definitions/description"},"isCommissionable":{"description":"Indicates if this Group Contract is commissionable or not","type":"boolean","default":false},"areAmountsConfidential":{"description":"Indicates if amounts defined in the Group Contract are confidential ones","type":"boolean","default":false},"updateByHotelierOnly":{"description":"Indicates that the reservation can only be modified or cancelled by the hotelier or user with a specific permission.","type":"boolean","default":false},"industryType":{"description":"Industry type tag","type":"string"},"saleStatus":{"$ref":"#/definitions/saleStatus"},"businessSource":{"$ref":"#/definitions/businessSource"}}},"installment":{"type":"object","required":["id"],"properties":{"id":{"description":"Id of the installment. Inside the string only an integer will be accepted","type":"string","minLength":1,"maxLength":10},"deadline":{"description":"Number of days prior to arrival for which the installment is due","type":"integer","minimum":0,"maximum":1095},"amount":{"description":"Due amount","type":"string","minLength":1,"maxLength":1000}}},"totalReservation":{"type":"object","required":["currency","finalPriceAmt"],"properties":{"currency":{"$ref":"#/definitions/currency"},"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"amtAfTx":{"$ref":"#/definitions/amountAfterTax"},"finalPriceAmt":{"$ref":"#/definitions/finalPriceAmt"},"totalTaxes":{"description":"Total amount of all applicable taxes","type":"string"},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"}}},"totalOfActiveSegments":{"type":"object","required":["currency","bsAmt"],"properties":{"currency":{"$ref":"#/definitions/currency"},"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"amtAfTx":{"$ref":"#/definitions/amountAfterTax"},"finalPriceAmt":{"$ref":"#/definitions/finalPriceAmtWithoutFees"},"totalTaxes":{"description":"Total amount of all applicable taxes","type":"string"},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"}}},"printRate":{"description":"Indicates whether rates are not confidential and can be printed","type":"boolean"},"chargePrivilege":{"description":"Indicates if the guests are allowed to have items posted in their folio","type":"boolean"},"reservationIdsReq":{"description":"Container for structured details of the guest name","type":"object","properties":{"cfNumber":{"$ref":"#/definitions/cfNumber"},"pnr":{"$ref":"#/definitions/pnr"},"extCfNumber":{"$ref":"#/definitions/extCfNumber"},"pmsCfNumber":{"$ref":"#/definitions/pmsCfNumber"},"pmsCxNumber":{"$ref":"#/definitions/pmsCxNumber"},"extCxNumber":{"$ref":"#/definitions/extCxNumber"},"externalShareId":{"$ref":"#/definitions/externalShareId"},"unsolicitedCancelId":{"$ref":"#/definitions/unsolicitedCancelId"}}},"reservationIdsSearchRes":{"description":"Container for structured details of the guest name","type":"object","required":["cfNumber"],"properties":{"cfNumber":{"$ref":"#/definitions/cfNumber"},"cxNumber":{"$ref":"#/definitions/cxNumber"},"extCfNumber":{"$ref":"#/definitions/extCfNumber"},"extCxNumber":{"$ref":"#/definitions/extCxNumber"},"pmsCfNumber":{"$ref":"#/definitions/pmsCfNumber"},"pmsCxNumber":{"$ref":"#/definitions/pmsCxNumber"},"externalShareId":{"$ref":"#/definitions/externalShareId"}}},"cfNumber":{"description":"Hotel Confirmation Number. It is a ACRS confirmation number.","type":"string","pattern":"[A-Z0-9]{8,10}","minLength":8,"maxLength":10,"example":"41771771"},"linkCfNumber":{"type":"object","required":["cfNumber","creationDate"],"properties":{"cfNumber":{"$ref":"#/definitions/cfNumber"},"creationDate":{"$ref":"#/definitions/creationDate"}}},"SynchronizeReservationSummary":{"type":"object","required":["cfNumber"],"properties":{"cfNumber":{"$ref":"#/definitions/cfNumber"},"period":{"$ref":"#/definitions/period"},"pmsCfNumber":{"$ref":"#/definitions/pmsCfNumber"},"arrivalTime":{"$ref":"#/definitions/arrivalTime"},"departureTime":{"$ref":"#/definitions/departureTime"},"isPrimary":{"description":"Set to true if a reservation is primary reservation. Otherwise set to false","type":"boolean"}}},"cxNumber":{"description":"Hotel Cancellation Number. Mandatory if the action concerns a cancel","type":"string","pattern":"[A-Z0-9]{8,10}","minLength":8,"maxLength":10,"example":"31771771"},"imageId":{"description":"Image ID (unique per confirmation number)","type":"integer"},"pnr":{"description":"PNR container","type":"object","required":["number"],"properties":{"number":{"description":"PNR number","type":"string","pattern":"[A-Za-z0-9]{5,6}","minLength":5,"maxLength":6},"source":{"description":"Source of the PNR number","type":"string","pattern":"[A-Za-z0-9]{2}","minLength":2,"maxLength":2}}},"extCfNumber":{"description":"Container for External Confirmation Number","type":"object","required":["number"],"properties":{"number":{"description":"External Confirmation Number","type":"string","minLength":1,"maxLength":32},"source":{"description":"Source of external Confirmation Number (ID of the originator Channel)","type":"string","minLength":2,"maxLength":2}}},"extCxNumber":{"description":"External Cancellation Number","type":"string","minLength":1,"maxLength":32},"pmsCfNumber":{"description":"PMS confirmation number","type":"string","minLength":1,"maxLength":50},"pmsCxNumber":{"description":"PMS cancellation number","type":"string","minLength":1,"maxLength":50},"unsolicitedCancelId":{"description":"Unique Identifier of the reservation generated by GDS original vendor","type":"string","pattern":"[A-Za-z0-9]{1,64}","minLength":1,"maxLength":64},"vendorBookingCode":{"description":"Booking code as it is distributed on vendor channel","type":"string","maxLength":16},"committedSequenceNumber":{"description":"Sequence number of this image among all the committed images in the reservation","type":"integer"},"externalShareId":{"description":"Share ID of the external system","type":"string","minLength":1,"maxLength":60},"reportingData":{"description":"Contains information conveyed for Reporting use only","type":"object","properties":{"channelClass":{"$ref":"#/definitions/reportingChannelClass"},"channelType":{"$ref":"#/definitions/reportingChannelType"},"channel":{"$ref":"#/definitions/reportingChannel"},"subChannel":{"$ref":"#/definitions/reportingSubChannel"},"code":{"$ref":"#/definitions/reportingCode"}}},"reportingCode":{"description":"The reporting code is attached to a reservation record(inclusing Group reservation) in order to track and provide reporting capabilities for customers in their own ecosystem(e.g. TIBKLND, TIEXLND)","type":"string","minLength":1,"maxLength":20},"reportingChannelClass":{"description":"The channel class of the partner (e.g. Web, Mobile, GDS, Wholesaler, OTA)","type":"string","minLength":1,"maxLength":64},"reportingChannelType":{"description":"The channel type of the partner (e.g. Branded, DirectConnect, HBSI, DerbySoft)","type":"string","minLength":1,"maxLength":64},"reportingChannel":{"description":"The channel of the partner (e.g. WebIBE, MobileApp, Sabre, Amadeus)","type":"string","minLength":1,"maxLength":64},"reportingSubChannel":{"description":"The sub-channel of the partner (eg. website name, application name, Booking.com, Agoda)","type":"string","minLength":1,"maxLength":64},"ratePlanRes":{"type":"object","allOf":[{"$ref":"#/definitions/ratePlanCommon"},{"type":"object","properties":{"packageDetails":{"$ref":"#/definitions/packageDetails"},"bookingMessage":{"description":"Booking message linked to the rate plan","$ref":"#/definitions/description"},"isCommissionable":{"description":"Indicates if this rate is commissionable or not","type":"boolean"},"priceGridCode":{"$ref":"#/definitions/priceGridCode"},"sellStrategyCode":{"$ref":"#/definitions/sellStrategyCode"},"bookingRestrictions":{"$ref":"#/definitions/bookingRestrictions"},"cdNumber":{"$ref":"#/definitions/cdNumber"},"isHouseUse":{"description":"Indicates if this rateplan is house use. House use rate is given for hotel staff/employees","type":"boolean"},"isComplimentary":{"description":"Indicates if this rateplan is complimentary. Complimentary rate is given for external guests (for promotional or sales activities or as part of a contract)","type":"boolean"},"gamingBucket":{"$ref":"#/definitions/gamingBucket"}}}]},"priceGridCode":{"description":"Price grid code","type":"string","pattern":"[A-Z0-9]{1,50}","minLength":1,"maxLength":50},"sellStrategyCode":{"description":"Represents the code of the Hotel Sell Strategy taken into account in the process","type":"string","pattern":"[A-Za-z0-9]{1,7}","minLength":1,"maxLength":7},"promotionRes":{"description":"List the promotion.","type":"object","allOf":[{"$ref":"#/definitions/promotion"},{"type":"object","properties":{"priceGridCode":{"$ref":"#/definitions/priceGridCode"}}}]},"ratePlanCommon":{"type":"object","required":["code"],"properties":{"code":{"$ref":"#/definitions/ratePlanCode"},"types":{"description":"List of rate plan type (OTA codes as per RPT OTA list)","$ref":"#/definitions/ratePlanTypes"},"name":{"description":"Name of the rate plan.","$ref":"#/definitions/DescriptionOfRatePlanAndInventoryType"},"description":{"description":"Short description of the rate plan.","$ref":"#/definitions/DescriptionOfRatePlanAndInventoryType"},"longDescription":{"description":"Long description of the rate plan.","$ref":"#/definitions/description"},"isFreeNight":{"description":"Indicates if the rate plan is a free night rate plan.","type":"boolean"},"activeDays":{"description":"Days on which rate plan is active. If not present, the rate plan is active on all days of the week.","$ref":"#/definitions/dow"},"checkinDays":{"description":"Days on which check-in may be done. If not present, the check-in is possible on all days of the week.","$ref":"#/definitions/dow"},"stayOverDays":{"description":"The stay must contain at least one of these days. If not present, there is no restriction on the days that must be contained in the stay.","$ref":"#/definitions/dow"},"advanceBooking":{"$ref":"#/definitions/advanceBooking"},"minLOS":{"description":"Minimum length of stay applied when checking restrictions.","type":"integer"},"maxLOS":{"description":"Maximum length of stay applied when checking restrictions.","type":"integer"},"isGroupRatePlan":{"description":"Indicates if the rate plan requested is a group rate plan or not.","type":"boolean","default":false},"areAmountsConfidential":{"description":"Indicates if amounts defined in the rate plan are confidential.","type":"boolean"},"isTentativeAllowed":{"description":"Indicates if a there is a courtesy hold time before booking of the rate. True if the hotel is courtesy hold enabled and the booking period is entirely in the courtesy hold period.","type":"boolean"},"isLoyaltyIdRequired":{"description":"Indicates if a loyalty number is required.","type":"boolean"},"isPackage":{"description":"Indicates if the rate plan is a package.","type":"boolean"},"isVoucherRequired":{"description":"Indicates if a coupon voucher is required.","type":"boolean"},"isRewardEarned":{"description":"Indicates if booking this rate gives reward points to the customer.","type":"boolean"},"isIdRequired":{"description":"Indicates if an ID is required at check-in for this rate.","type":"boolean"},"isAwardAccepted":{"description":"Indicates if payment for this rate can be done totally or partially using reward points.","type":"boolean"}}},"ratePlanTypes":{"description":"List of rate plan type (OTA codes as per RPT OTA list)","type":"array","example":["RPT4","RPT9"],"items":{"type":"string","description":"Rate plan type"}},"promotion":{"type":"object","required":["buyNumber","getNumber","maxNumber"],"properties":{"buyNumber":{"description":"Buy X ...","type":"integer"},"getNumber":{"description":"and get Y for free ...","type":"integer"},"maxNumber":{"description":"with a maximum of Z","type":"integer"},"amountOff":{"description":"Flat amount discount (exclusive with percentOff)","type":"string"},"percentOff":{"description":"Percent discount (exclusive with amountOff)","type":"string"}}},"taxInclusionMode":{"description":"Indicates the tax inclusion's mode defined at rate plan level.","type":"string","enum":["included","excluded","followHouse"]},"advanceBooking":{"type":"object","properties":{"isAdvancePurchase":{"description":"Advance Purchase rate indicator.","type":"boolean","default":false},"minDays":{"description":"Minimum number of days required for advance booking","type":"integer"},"maxDays":{"description":"Maximum number of days required for advance booking","type":"integer"}}},"bookingRestrictions":{"description":"Booking restrictions","type":"object","required":["dowRestriction"],"properties":{"start":{"description":"Start date of booking restrictions","type":"string","format":"date"},"end":{"description":"End date of booking restrictions","type":"string","format":"date"},"dowRestriction":{"description":"Specifies the booking restriction based on days of the week if any","$ref":"#/definitions/dow"}}},"packageDetails":{"description":"Gives the details of the package","type":"object","properties":{"overview":{"description":"Overview description of the package","$ref":"#/definitions/description"},"additionalDetails":{"description":"The additional details of the rate plan's package.","$ref":"#/definitions/description"},"termsAndConditions":{"description":"Terms and conditions","$ref":"#/definitions/description"},"themesAndElements":{"description":"List of themes and elements","type":"array","items":{"$ref":"#/definitions/themeAndElement"}}}},"themeAndElement":{"type":"object","required":["code","type"],"properties":{"code":{"type":"integer","description":"code of the theme or element"},"type":{"type":"string","enum":["Theme","Element"],"description":"Specifies the type as Theme or Element"},"name":{"description":"Name of the theme or element","$ref":"#/definitions/description"},"description":{"description":"Description of the theme/element","$ref":"#/definitions/description"}}},"gamingBucket":{"description":"Indicates whether the rate plan is used for Comp or Cash flows.","type":"string","enum":["Comp","Cash"]},"hotelReq":{"description":"The property info provides the unique identification of the property","type":"object","required":["propertyCode"],"properties":{"propertyCode":{"$ref":"#/definitions/propertyCode"},"distribInfo":{"$ref":"#/definitions/distribInfo"}}},"hotelRes":{"description":"The property info provides the unique identification of the property","type":"object","required":["propertyCode","chainCode"],"properties":{"chainCode":{"$ref":"#/definitions/propertyChainCode"},"brandCode":{"$ref":"#/definitions/brandCode"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"isPseudoProperty":{"type":"boolean","description":"Indicates that the property code used by channel to create the reservation was a pseudo property code"},"propertyCurrency":{"$ref":"#/definitions/currency"},"propertyName":{"$ref":"#/definitions/propertyName"},"masterPropertyCode":{"$ref":"#/definitions/propertyCode","description":"Indicates the master property code. Visible only when the property code used by channel to create reservation is pseudo property code"},"masterPropertyName":{"$ref":"#/definitions/propertyName","description":"Name of the master property. Visible only when the property code used by channel to create reservation is pseudo property code"},"cityCode":{"$ref":"#/definitions/cityCode"},"countryCode":{"$ref":"#/definitions/countryCode"},"regionCode":{"$ref":"#/definitions/regionCode"},"marketingLines":{"description":"Confirmation text returned at booking and modification time, only if the channel is authorized","type":"array","items":{"$ref":"#/definitions/marketingLine"}},"guestTypeDefinitions":{"description":"All applicable Property Guest Type set-up","type":"array","items":{"$ref":"#/definitions/guestTypeDefinition"}},"freeGuestsDefinitions":{"description":"List of free guests definitions","type":"array","items":{"$ref":"#/definitions/freeGuestsDefinition"}},"distribInfo":{"description":"Distributed property information coming from vendor channel","$ref":"#/definitions/distribInfo"},"salesLedgerArea":{"$ref":"#/definitions/salesLedgerArea"}}},"hotelSearchRes":{"description":"The property info provides the unique identification of the property","type":"object","required":["propertyCode","chainCode"],"properties":{"chainCode":{"$ref":"#/definitions/propertyChainCode"},"brandCode":{"$ref":"#/definitions/brandCode"},"isPseudoProperty":{"type":"boolean","description":"Indicates that the property code used by channel to create the reservation was a pseudo property code"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"propertyCurrency":{"$ref":"#/definitions/currency"},"masterPropertyCode":{"$ref":"#/definitions/propertyCode","description":"Indicates the master property code. Visible only when the property code used by channel to create reservation is pseudo property code"},"masterPropertyName":{"$ref":"#/definitions/propertyName","description":"Name of the master property. Visible only when the property code used by channel to create reservation is pseudo property code"}}},"propertyCode":{"description":"The property code","type":"string","pattern":"[A-Z0-9]{1,10}","minLength":1,"maxLength":10},"distribInfo":{"description":"Distributed property information coming from vendor channel","type":"object","properties":{"chainCode":{"description":"Chain code of the property booked as it is distributed on vendor channel","type":"string","maxLength":3},"cityCode":{"description":"City code of the property booked as it is distributed on vendor channel","type":"string","maxLength":5},"propertyCode":{"description":"Property code of the property booked as it is distributed on vendor channel","type":"string","maxLength":10}}},"marketingLine":{"description":"Confirmation text returned at booking and modification time, only if the channel is authorized","type":"object","required":["description"],"properties":{"description":{"$ref":"#/definitions/description"}}},"salesLedgerArea":{"description":"Hotels sharing the same account line are considered to be of the same SalesLedgerArea. This is a location.","type":"string"},"guestTypeDefinition":{"description":"The applicable Property Guest Type set-up","type":"object","required":["code","startAge"],"properties":{"code":{"type":"string","description":"Guest Type Code","pattern":"[A-Z0-9_]{2,8}","example":"ADULT"},"otaCodes":{"type":"array","title":"otaCodes","description":"The list of OTA AQC codes associated to the Guest Type. The same OTA AQC code cannot be used in more than one Guest Type","example":["AQC1","AQC3","AQC19"],"items":{"type":"string","enum":["AQC1","AQC2","AQC3","AQC4","AQC5","AQC6","AQC7","AQC8","AQC9","AQC10","AQC11","AQC12","AQC13","AQC14","AQC15","AQC16","AQC17","AQC18","AQC19"]}},"startAge":{"type":"integer","description":"Start age of the range","example":0},"endAge":{"type":"integer","description":"End age of the range. If no end age is specified the age range is considered up to infinite","example":18},"description":{"type":"string","minLength":1,"maxLength":2000,"description":"Textual description of the Property Guest Type","example":"Child guest type, covering age from 0 to 18"}}},"freeGuestsDefinition":{"type":"object","required":["pricePlanCodes","freeGuestsByType"],"properties":{"pricePlanCodes":{"type":"array","description":"Price Plan Code(s) to which the free Guest Definition item apply","items":{"$ref":"#/definitions/pricePlanCode"}},"maxFreeGuests":{"type":"integer","description":"Indicates the overall maximum number of free guests"},"freeGuestsByType":{"description":"Indicates the maximum number of free guests by type","type":"array","items":{"$ref":"#/definitions/guestsByType"}}}},"guestsByType":{"type":"object","required":["guestType","count"],"description":"count per guestType","properties":{"guestType":{"type":"string","description":"Guest Type Code","pattern":"[A-Z0-9_]{2,8}","example":"CHILD"},"count":{"description":"Number of guest","type":"integer"}}},"pricePlanCode":{"description":"Price Plan code","type":"string","pattern":"[A-Z0-9]{2,50}","minLength":2,"maxLength":50},"product":{"description":"Product details","type":"object","required":["inventoryTypeCode","inventoryTypeName","productCode"],"properties":{"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"otaCode":{"$ref":"#/definitions/otaCode"},"inventoryTypeName":{"description":"Name of the inventory Type (short description)","$ref":"#/definitions/DescriptionOfRatePlanAndInventoryType"},"productClass":{"description":"Product parent class both for sleeping romm and non-room products","type":"string","minLength":1,"maxLength":64},"yieldClass":{"description":"RMS yield class for sleeping room","type":"string","minLength":1,"maxLength":64},"maximumNumberParticipant":{"description":"Maximum allowed number of participants for this inventory Item (extra participants included)","type":"integer"},"extraPersonStart":{"$ref":"#/definitions/extraPersonStart"},"description":{"description":"Description of the inventory Item","$ref":"#/definitions/DescriptionOfRatePlanAndInventoryType"},"productCode":{"$ref":"#/definitions/productCode"},"pacCode":{"$ref":"#/definitions/pacCode"},"productName":{"description":"Name of the product","type":"string","minLength":1,"maxLength":64},"attributeCodes":{"description":"List of attribute codes composing the requested product","type":"array","items":{"$ref":"#/definitions/attributeCode"}}}},"extraPersonStart":{"type":"integer","description":"Indicates when an extra person charge is applicable to the guest. For instance, if the value is set to 2 and a guest makes a reservation for 2 people then an extra charge will be applied for the second person.","minimum":2},"otaCode":{"description":"Community code of the product type [OTA]","type":"string","pattern":"[A-Z0-9]{3,8}","minLength":3,"maxLength":8},"productCode":{"type":"string","description":"Code defining the product (Sleeping room, meeting room or any service)","example":"SR"},"attribute":{"type":"object","required":["code"],"properties":{"code":{"$ref":"#/definitions/attributeCode"},"name":{"description":"Name of the attribute","$ref":"#/definitions/description"},"description":{"description":"Description of the attribute","$ref":"#/definitions/description"}}},"attributeCode":{"description":"Code of the attribute","type":"string","pattern":"[A-Z0-9]{1,8}","minLength":1,"maxLength":8,"example":"RVT25"},"contactPerson":{"description":"Container for guest contact person information","type":"object","required":["relation","personName"],"properties":{"relation":{"description":"Define the relation between the guest and its contact name (business or personal contact)","example":"Parent","type":"string","minLength":1,"maxLength":32},"personName":{"$ref":"#/definitions/contactPersonName"}}},"contactPersonName":{"description":"Container for guest person name details","type":"object","required":["surname"],"properties":{"namePrefix":{"$ref":"#/definitions/contactNamePrefix"},"givenName":{"$ref":"#/definitions/contactGivenName"},"surname":{"$ref":"#/definitions/contactSurname"}}},"contactNamePrefix":{"description":"Name prefix","type":"string","minLength":1,"maxLength":16},"contactGivenName":{"description":"First Name","type":"string","minLength":1,"maxLength":64},"contactSurname":{"description":"Last Name","type":"string","minLength":1,"maxLength":64},"guestsPendingReq":{"description":"List of user profiles, at least one is mandatory for a 1 step","type":"array","maxItems":300,"items":{"type":"object","title":"userProfilePendingReq","properties":{"id":{"type":"integer","description":"Identifies a guest within the reservation. This id (unique for each guest) can be used to cross-referenced a guest from the segmentHolderId, bookerId or guestOccIds."},"age":{"$ref":"#/definitions/age"},"identificationInfo":{"$ref":"#/definitions/identificationInfo"},"personName":{"$ref":"#/definitions/personNamePending"},"guestProfileId":{"$ref":"#/definitions/guestProfileId"},"externalProfileIds":{"description":"Guest profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}},"addresses":{"type":"array","maxItems":99,"description":"List of addresses","items":{"$ref":"#/definitions/addressWithoutIndex"}},"telephones":{"type":"array","maxItems":99,"description":"List of telephones and fax","items":{"$ref":"#/definitions/telephone"}},"emails":{"type":"array","maxItems":2,"description":"List of emails","items":{"$ref":"#/definitions/email"}},"loyaltyProgram":{"$ref":"#/definitions/loyaltyProgram"},"frequentTraveller":{"$ref":"#/definitions/frequentTraveller"},"nextDestination":{"$ref":"#/definitions/nextDestination"},"customData":{"$ref":"#/definitions/customData"},"contactPerson":{"$ref":"#/definitions/contactPerson"}}}},"guestsRes":{"description":"List of user profiles, at least one is mandatory for a 1 step","type":"array","items":{"type":"object","title":"userProfileRes","required":["id","personName"],"properties":{"id":{"type":"integer","description":"Identifies a guest within the reservation. This id (unique for each guest) can be used to cross-referenced a guest from the segmentHolderId, bookerId or guestOccIds."},"age":{"$ref":"#/definitions/age"},"identificationInfo":{"$ref":"#/definitions/identificationInfo"},"personName":{"$ref":"#/definitions/personName"},"guestProfileId":{"$ref":"#/definitions/guestProfileId"},"externalProfileIds":{"description":"Guest profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}},"addresses":{"type":"array","description":"List of addresses","items":{"$ref":"#/definitions/addressWithoutIndex"}},"telephones":{"type":"array","description":"List of telephones and fax","items":{"$ref":"#/definitions/telephone"}},"emails":{"type":"array","maxItems":2,"description":"List of emails","items":{"$ref":"#/definitions/email"}},"loyaltyProgram":{"description":"Loyalty program of the guests with hotel provider","$ref":"#/definitions/loyaltyProgram"},"frequentTraveller":{"description":"Loyalty program of the guests with an airline","$ref":"#/definitions/frequentTraveller"},"nextDestination":{"$ref":"#/definitions/nextDestination"},"customData":{"$ref":"#/definitions/customData","description":"All data under customData are stored in the reservation and returned in the response and retrieve. Any valid Json object is accepted"},"nationalities":{"description":"Indicates the guest nationality using the ISO 3166-1 alpha-3 standard code for countries, territories or areas","type":"array","items":{"$ref":"#/definitions/nationality"}},"contactPerson":{"$ref":"#/definitions/contactPerson","description":"Container for guest contact person information. It consists the details of the person related to the guest"},"isSelfLimiting":{"$ref":"#/definitions/isSelfLimiting"},"guestProfileStatus":{"$ref":"#/definitions/guestProfileStatus"},"profileNotFound":{"$ref":"#/definitions/profileNotFound"},"discrepancyFound":{"$ref":"#/definitions/discrepancyFound"},"discrepancyReason":{"$ref":"#/definitions/discrepancyReason","description":"List of fields separated by comma which has discrepancy"}}}},"guestsPendingRes":{"description":"List of user profiles, at least one is mandatory for a 1 step","type":"array","items":{"type":"object","title":"userProfilePendingRes","required":["id"],"properties":{"id":{"type":"integer","description":"Identifies a guest within the reservation. This id (unique for each guest) can be used to cross-referenced a guest from the segmentHolderId, bookerId or guestOccIds."},"age":{"$ref":"#/definitions/age"},"identificationInfo":{"$ref":"#/definitions/identificationInfo"},"personName":{"$ref":"#/definitions/personNamePending"},"guestProfileId":{"$ref":"#/definitions/guestProfileId"},"externalProfileIds":{"description":"Guest profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}},"addresses":{"type":"array","description":"List of addresses","items":{"$ref":"#/definitions/addressWithoutIndex"}},"telephones":{"type":"array","description":"List of telephones and fax","items":{"$ref":"#/definitions/telephone"}},"emails":{"type":"array","maxItems":2,"description":"List of emails","items":{"$ref":"#/definitions/email"}},"loyaltyProgram":{"description":"Loyalty program of the guests with hotel provider","$ref":"#/definitions/loyaltyProgram"},"frequentTraveller":{"description":"Loyalty program of the guests with an airline","$ref":"#/definitions/frequentTraveller"},"nextDestination":{"$ref":"#/definitions/nextDestination"},"customData":{"$ref":"#/definitions/customData"},"contactPerson":{"$ref":"#/definitions/contactPerson"}}}},"guestsHistoryRes":{"description":"List of user profiles, at least one is mandatory for a 1 step","type":"array","items":{"type":"object","title":"userProfileHistoryRes","required":["id","personName"],"properties":{"id":{"type":"integer","description":"Identifies a guest within the reservation. This id (unique for each guest) can be used to cross-referenced a guest from the segmentHolderId, bookerId or guestOccIds."},"age":{"$ref":"#/definitions/age"},"personName":{"$ref":"#/definitions/personName"},"guestProfileId":{"$ref":"#/definitions/guestProfileId"},"addresses":{"type":"array","description":"List of addresses","items":{"$ref":"#/definitions/addressWithoutIndex"}},"telephones":{"type":"array","description":"List of telephones and fax","items":{"$ref":"#/definitions/telephone"}},"emails":{"type":"array","maxItems":2,"description":"List of emails","items":{"$ref":"#/definitions/email"}},"loyaltyProgram":{"$ref":"#/definitions/loyaltyProgram"},"externalProfileIds":{"description":"Guest profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}},"isSelfLimiting":{"$ref":"#/definitions/isSelfLimiting"},"guestProfileStatus":{"$ref":"#/definitions/guestProfileStatus"},"profileNotFound":{"$ref":"#/definitions/profileNotFound"},"discrepancyFound":{"$ref":"#/definitions/discrepancyFound"},"discrepancyReason":{"$ref":"#/definitions/discrepancyReason","description":"List of fields separated by comma which has discrepancy"}}}},"guestsSearchRes":{"description":"List of user profiles, at least one is mandatory for a 1 step","type":"array","items":{"type":"object","title":"userProfileSearchRes","required":["id","personName"],"properties":{"id":{"type":"integer","description":"Identifies a guest within the reservation. This id (unique for each guest) can be used to cross-referenced a guest from the segmentHolderId, bookerId or guestOccIds."},"age":{"$ref":"#/definitions/age"},"personName":{"$ref":"#/definitions/personName"},"guestProfileId":{"$ref":"#/definitions/guestProfileId"},"externalProfileIds":{"description":"Guest profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}},"loyaltyProgram":{"description":"Loyalty program of the guests with hotel provider","$ref":"#/definitions/loyaltyProgram"},"isSelfLimiting":{"$ref":"#/definitions/isSelfLimiting"},"guestProfileStatus":{"$ref":"#/definitions/guestProfileStatus"}}}},"guestProfileId":{"description":"Guest identifier on the profile system.","type":"string","maxLength":36},"age":{"description":"Identifies the age of the user within the reservation.","type":"integer"},"identificationInfo":{"description":"Container for structured details of identification information","type":"array","maxItems":20,"items":{"type":"object","title":"identityDocument","properties":{"type":{"description":"Type of identity document","enum":["PASSPORT"],"example":"PASSPORT","type":"string"},"number":{"type":"string","example":"QFU514563221J","pattern":"[a-zA-Z0-9]{1,50}","description":"Number of the identity document"},"issuanceLocation":{"type":"string","description":"A more precise information concerning the place where the document has been issued such as state, department or a city name (e.g. New-York)","minLength":2,"maxLength":50,"example":"New-York"},"issuanceCountry":{"type":"string","description":"Country code using ISO 3166-1 standard","pattern":"[a-zA-Z]{2}","minLength":2,"maxLength":2,"example":"BR"}}}},"personName":{"description":"Container for structured details of the guest name","type":"object","required":["givenName","surname"],"properties":{"namePrefix":{"$ref":"#/definitions/namePrefix"},"givenName":{"$ref":"#/definitions/givenName"},"surname":{"$ref":"#/definitions/surname"},"middleName":{"$ref":"#/definitions/middleName"},"nameSuffix":{"$ref":"#/definitions/nameSuffix"},"title":{"$ref":"#/definitions/title"}}},"personNamePending":{"description":"Container for structured details of the guest name","type":"object","properties":{"namePrefix":{"$ref":"#/definitions/namePrefix"},"givenName":{"$ref":"#/definitions/givenName"},"surname":{"$ref":"#/definitions/surname"},"middleName":{"$ref":"#/definitions/middleName"},"nameSuffix":{"$ref":"#/definitions/nameSuffix"},"title":{"$ref":"#/definitions/title"}}},"nextDestination":{"description":"Next destination of the guest","type":"string","maxLength":100},"namePrefix":{"description":"Name prefix","type":"string","minLength":1,"maxLength":9},"nameSuffix":{"description":"Name suffix","type":"string","minLength":1,"maxLength":9},"givenName":{"description":"First Name","type":"string","minLength":1,"maxLength":56},"surname":{"description":"Last Name","type":"string","minLength":1,"maxLength":57},"middleName":{"description":"Middle Name","type":"string","minLength":1,"maxLength":56},"title":{"description":"Title. It is a free text and can take any value","type":"string","minLength":1,"maxLength":20},"nationality":{"description":"Indicates the guest nationality using the ISO 3166-1 alpha-3 standard code for countries, territories or areas","type":"string","pattern":"[A-Za-z]{2,3}","minLength":2,"maxLength":3,"example":"BR"},"isSelfLimiting":{"description":"Indicates the guest has opted to self limit","type":"boolean"},"guestProfileStatus":{"description":"Status of the guest in the profile system","type":"string","enum":["Active","Inactive"]},"segmentReq":{"description":"List of segments","type":"array","items":{"type":"object","title":"segment","required":["propertyCode","offer"],"properties":{"id":{"type":"integer","description":"Identify the segment inside the reservation all along the reservation life."},"synchroNumber":{"$ref":"#/definitions/synchroNumber"},"externalSegmentId":{"type":"integer","description":"Used to identify a segment on external booking engines/GDS side."},"segmentStatus":{"$ref":"#/definitions/segmentStatus"},"segmentPmsStatus":{"$ref":"#/definitions/segmentPmsStatusReq"},"segmentHolderId":{"$ref":"#/definitions/segmentHolderId"},"bookerId":{"$ref":"#/definitions/bookerId"},"parentId":{"$ref":"#/definitions/parentId"},"indicators":{"$ref":"#/definitions/indicatorsReq"},"option":{"$ref":"#/definitions/option"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"creator":{"description":"Contains the details of the channel which created the reservation. If provided in the payload, will be stored in the reservation. The channel headers must still be provided to perform the permissions check.","$ref":"#/definitions/pointOfSale"},"owner":{"description":"Agency which owns the segment. This is the agency whose IATA number is used for guarantee, and also the agency who is commissioned for the segment. If provided in the payload, will be stored in the reservation instead of the information from the Ama-Reservation-Owner header.","$ref":"#/definitions/reservationOwner"},"corporateAccountInfo":{"$ref":"#/definitions/corporateAccountInfoReq"},"offer":{"$ref":"#/definitions/offerReq"},"formOfPayment":{"$ref":"#/definitions/formOfPaymentReq"},"specialRequests":{"type":"array","description":"List the special requests","maxItems":100,"items":{"$ref":"#/definitions/specialRequestsReq"}},"serviceRequests":{"type":"array","description":"List the service requests","maxItems":25,"items":{"$ref":"#/definitions/serviceRequests"}},"traces":{"type":"array","description":"Traces allow to generate tasks that require fulfillment, which can be associated to a particular department. e.g. \"Review deposits\"","minItems":1,"maxItems":100,"items":{"$ref":"#/definitions/traces"}},"alerts":{"type":"array","description":"Alerts are PMS functionality which can be pre-configured. They include screen and printer notification. e.g. \"VIP guest\"","minItems":1,"maxItems":100,"items":{"$ref":"#/definitions/alerts"}},"arrivalTime":{"$ref":"#/definitions/arrivalTime"},"departureTime":{"$ref":"#/definitions/departureTime"},"arrivalTransport":{"$ref":"#/definitions/transportation"},"departureTransport":{"$ref":"#/definitions/transportation"},"language":{"$ref":"#/definitions/language"},"comments":{"$ref":"#/definitions/comments"},"customData":{"$ref":"#/definitions/customData"},"travelPurpose":{"$ref":"#/definitions/travelPurpose"},"arrivalAmenities":{"type":"array","description":"List of loyalty arrival amenity codes selected by the loyalty guest","maxItems":50,"items":{"$ref":"#/definitions/ArrivalAmenity"}},"cancellationReasons":{"type":"array","maxItems":10,"items":{"$ref":"#/definitions/cancellationReason"}},"invoiceIds":{"type":"array","description":"List of invoice Ids used in the segment","maxItems":100,"items":{"$ref":"#/definitions/invoiceId"}},"chargeRoutings":{"type":"array","maxItems":20,"items":{"$ref":"#/definitions/chargeRouting"}},"customerOwnReference":{"$ref":"#/definitions/customerOwnReference"},"purchaseOrderReference":{"$ref":"#/definitions/purchaseOrderReference"}}}},"segmentModifyPendingReq":{"description":"List of segments","type":"array","items":{"type":"object","title":"segment","required":["propertyCode","offer"],"properties":{"id":{"type":"integer","description":"Identify the segment inside the reservation all along the reservation life."},"synchroNumber":{"$ref":"#/definitions/synchroNumber"},"externalSegmentId":{"type":"integer","description":"Used to identify a segment on external booking engines/GDS side."},"segmentStatus":{"$ref":"#/definitions/segmentStatus"},"segmentPmsStatus":{"$ref":"#/definitions/segmentPmsStatusReq"},"segmentHolderId":{"$ref":"#/definitions/segmentHolderId"},"bookerId":{"$ref":"#/definitions/bookerId"},"parentId":{"$ref":"#/definitions/parentId"},"indicators":{"$ref":"#/definitions/indicatorsReq"},"option":{"$ref":"#/definitions/option"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"corporateAccountInfo":{"$ref":"#/definitions/corporateAccountInfoReq"},"offer":{"$ref":"#/definitions/offerReq"},"formOfPayment":{"$ref":"#/definitions/formOfPaymentReq"},"specialRequests":{"type":"array","description":"List the special requests","maxItems":100,"items":{"$ref":"#/definitions/specialRequestsReq"}},"serviceRequests":{"type":"array","description":"List the service requests","maxItems":25,"items":{"$ref":"#/definitions/serviceRequests"}},"arrivalTime":{"$ref":"#/definitions/arrivalTime"},"departureTime":{"$ref":"#/definitions/departureTime"},"arrivalTransport":{"$ref":"#/definitions/transportation"},"departureTransport":{"$ref":"#/definitions/transportation"},"language":{"$ref":"#/definitions/language"},"comments":{"$ref":"#/definitions/comments"},"customData":{"$ref":"#/definitions/customData"},"travelPurpose":{"$ref":"#/definitions/travelPurpose"},"arrivalAmenities":{"type":"array","description":"List of loyalty arrival amenity codes selected by the loyalty guest","maxItems":50,"items":{"$ref":"#/definitions/ArrivalAmenity"}},"cancellationReasons":{"type":"array","maxItems":10,"items":{"$ref":"#/definitions/cancellationReason"}},"forceRepricing":{"type":"boolean","description":"Used to force the repricing of the segment."},"invoiceIds":{"type":"array","description":"List of invoice Ids used in the segment","maxItems":100,"items":{"$ref":"#/definitions/invoiceId"}},"chargeRoutings":{"type":"array","maxItems":20,"items":{"$ref":"#/definitions/chargeRouting"}},"customerOwnReference":{"$ref":"#/definitions/customerOwnReference"},"purchaseOrderReference":{"$ref":"#/definitions/purchaseOrderReference"}}}},"segmentRes":{"description":"List of segments","type":"array","items":{"type":"object","title":"segment","required":["id","segmentStatus","actionStatus","start","end","creationDateTime","synchroNumber","consolidatedSegmentStatus","channelPreferredRate","propertyCode","creator","requestor","lastUpdateDateTime","offer"],"properties":{"id":{"type":"integer","description":"Identify the segment inside the reservation all along the reservation life."},"warningIds":{"description":"List of warning references","type":"array","items":{"$ref":"#/definitions/id"}},"start":{"description":"Start date","type":"string","format":"date"},"end":{"description":"End date","type":"string","format":"date"},"synchroNumber":{"$ref":"#/definitions/synchroNumber"},"externalSegmentId":{"type":"integer","description":"Used to identify a segment on external booking engines/GDS side."},"segmentStatus":{"$ref":"#/definitions/segmentStatus"},"consolidatedSegmentStatus":{"$ref":"#/definitions/consolidatedSegmentStatus"},"actionStatus":{"$ref":"#/definitions/actionStatus"},"segmentPmsStatus":{"$ref":"#/definitions/segmentPmsStatus"},"segmentHolderId":{"$ref":"#/definitions/segmentHolderId"},"isSegmentHolderNameModified":{"type":"boolean","description":"Indicates that the segment holder name of the current image is different from the one the previous committed image."},"bookerId":{"$ref":"#/definitions/bookerId"},"hasAddOns":{"$ref":"#/definitions/hasAddOns"},"parentId":{"$ref":"#/definitions/parentId"},"creationDateTime":{"$ref":"#/definitions/createDateTime"},"creationDateTimeHotelLocalTime":{"$ref":"#/definitions/createDateTimeHotelLocalTime"},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"},"lastUpdateDateTimeHotelLocalTime":{"$ref":"#/definitions/lastUpdateDateTimeHotelLocalTime"},"cancellationDateTime":{"$ref":"#/definitions/cancellationDateTime"},"cancellationDateTimeHotelLocalTime":{"$ref":"#/definitions/cancellationDateTimeHotelLocalTime"},"indicators":{"description":"How the segment was booked. Example by Force Sell, Rate Override, was repriced...","$ref":"#/definitions/indicatorsRes"},"option":{"description":"Present only for tentative or waitlisted booking","$ref":"#/definitions/option"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"factLines":{"description":"List of free text containing some info about the hotel","$ref":"#/definitions/description"},"creator":{"description":"Contains the details of the channel which created the segment","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"owner":{"description":"Agency which owns the segment. This is the agency whose IATA number is used for guarantee, and also the agency who is commissioned for the segment.","$ref":"#/definitions/reservationOwner"},"isCrossChannelCancel":{"$ref":"#/definitions/isCrossChannelCancel"},"channelPreferredRate":{"$ref":"#/definitions/channelPreferredRate"},"channelExtraPersonChargeIncluded":{"$ref":"#/definitions/channelExtraPersonChargeIncluded"},"cancelByHotelOnly":{"$ref":"#/definitions/cancelByHotelOnly"},"lateArrivalTime":{"$ref":"#/definitions/lateArrivalTime"},"corporateAccountInfo":{"$ref":"#/definitions/corporateAccountInfoRes"},"offer":{"$ref":"#/definitions/offerRes"},"totalSegment":{"$ref":"#/definitions/totalSegment"},"formOfPayment":{"$ref":"#/definitions/formOfPaymentRes"},"taxDefinitions":{"type":"array","description":"The applicable rules of taxes for each tax change of the segment","items":{"$ref":"#/definitions/taxDefinition"}},"specialEvent":{"$ref":"#/definitions/specialEvent"},"specialRequests":{"type":"array","description":"List the special requests","items":{"$ref":"#/definitions/specialRequests"}},"serviceRequests":{"type":"array","description":"List the service requests","items":{"$ref":"#/definitions/serviceRequests"}},"traces":{"type":"array","description":"Traces allow to generate tasks that require fulfillment, which can be associated to a particular department. e.g. \"Review deposits\"","minItems":1,"maxItems":100,"items":{"$ref":"#/definitions/traces"}},"alerts":{"type":"array","description":"Alerts are PMS functionality which can be pre-configured. They include screen and printer notification. e.g. \"VIP guest\"","minItems":1,"maxItems":100,"items":{"$ref":"#/definitions/alerts"}},"arrivalTime":{"$ref":"#/definitions/arrivalTime"},"departureTime":{"$ref":"#/definitions/departureTime"},"arrivalTransport":{"description":"Details of the mean of transport used by the guests to reach the hotel (or the area)","$ref":"#/definitions/transportation"},"departureTransport":{"description":"Details of the mean of transport used by the guests to reach the hotel (or the area)","$ref":"#/definitions/transportation"},"language":{"$ref":"#/definitions/language"},"comments":{"description":"Comment details of corresponding segment. It describes the type, language and text of comments","$ref":"#/definitions/comments"},"customData":{"description":"All data under customData are stored in the reservation and returned in the response and retrieve. Any valid Json object is accepted","$ref":"#/definitions/customData"},"travelPurpose":{"$ref":"#/definitions/travelPurpose"},"arrivalAmenities":{"type":"array","description":"List of loyalty arrival amenity codes selected by the loyalty guest","maxItems":50,"items":{"$ref":"#/definitions/ArrivalAmenity"}},"cancellationReasons":{"description":"Details about cancellation reasons","type":"array","items":{"$ref":"#/definitions/cancellationReason"}},"segmentFolio":{"description":"Describes payment details such as chargeable amount, paid amount and balance related to the segment. THe object is replied only in case of centralised payment","$ref":"#/definitions/segmentFolio"},"rmsData":{"$ref":"#/definitions/rmsData"},"invoiceIds":{"type":"array","description":"List of invoice Ids used in the segment","items":{"$ref":"#/definitions/invoiceId"}},"chargeRoutings":{"description":"Charge routing is used to charge payment in the correct folio","type":"array","items":{"$ref":"#/definitions/chargeRouting"}},"customerOwnReference":{"$ref":"#/definitions/customerOwnReference"},"purchaseOrderReference":{"$ref":"#/definitions/purchaseOrderReference"}}}},"segmentStatus":{"description":"BK if the segment has just been created, MY if it has been modified, CL if it has been cancelled. Used in the modification request for cancelling a segment","type":"string","enum":["BK","MY","CL"]},"actionStatus":{"description":"Action status set to NS by default. NS - Normal Sell; NO - No-Show; FS - Forced-Sell; FO - Forced-Override; FH - Forced-Hurdle; ES - External Forced-Sell; EO - External Rate-Overridden; WL - Waitlist; NR - NoRecord Reservation","type":"string","enum":["NS","NO","FS","FO","FH","ES","EO","WL","NR"]},"synchroNumber":{"description":"Accommodation sequence number used to warranty synchronization with PMS. It is increased when a the product information is modified.","type":"integer"},"consolidatedSegmentStatus":{"description":"Consolidated status of the segment","type":"string","enum":["Guaranteed","Tentative","NonGuaranteedHold","Waitlisted","Cancelled","MissingPayment"]},"segmentPmsStatus":{"description":"Segment status on PMS side","type":"string","enum":["In-house","Checked out","No-show","Waitlisted","Pre-Checkin"]},"segmentPmsStatusReq":{"description":"Segment status on PMS side","type":"string","enum":["In-house","Checked out","No-show","Pre-Checkin"]},"segmentHolderId":{"description":"Determine the segment holder. It references a guest id.","type":"integer"},"bookerId":{"description":"Determine the person who booked on behalf of the segment holder. It references a guest id.","type":"integer"},"specialRequestsReq":{"type":"object","required":["requestCode"],"properties":{"requestCode":{"description":"Code of the special request","type":"string","minLength":1,"maxLength":20},"quantity":{"$ref":"#/definitions/quantity"},"dateTime":{"$ref":"#/definitions/dateTime"}}},"specialRequests":{"type":"object","required":["requestCode"],"properties":{"requestCode":{"description":"Code of the special request","type":"string","minLength":1,"maxLength":20},"description":{"description":"Description associated to the special request","$ref":"#/definitions/description"},"quantity":{"$ref":"#/definitions/quantity"},"dateTime":{"$ref":"#/definitions/dateTime"}}},"serviceRequests":{"type":"object","required":["code","description"],"properties":{"code":{"description":"Code of the service request","type":"string","minLength":1,"maxLength":20,"example":"MEAL"},"quantity":{"$ref":"#/definitions/quantity"},"description":{"description":"Description associated to the service request","$ref":"#/definitions/description"},"type":{"description":"Type of the service request","type":"string","minLength":1,"maxLength":10,"example":"SPE"}}},"traces":{"type":"object","required":["departmentCode"],"properties":{"departmentCode":{"description":"department code of the trace","type":"string","minLength":1,"maxLength":5},"description":{"$ref":"#/definitions/description"},"date":{"$ref":"#/definitions/dateTime"},"resolvedUser":{"description":"name of the user who resolved the trace","type":"string","minLength":1,"maxLength":40},"resolvedDate":{"$ref":"#/definitions/dateTime"}}},"alerts":{"type":"object","required":["code"],"properties":{"code":{"description":"Alert code","type":"string","minLength":1,"maxLength":20},"description":{"$ref":"#/definitions/description"},"area":{"description":"Alert area","type":"string","minLength":1,"maxLength":20},"propertyCode":{"$ref":"#/definitions/propertyCode"}}},"arrivalTime":{"description":"Local hotel time when guests plan to arrive at the hotel, i.e. 22:00","type":"string","format":"time-hour:time-minute"},"departureTime":{"description":"Local hotel time when guests plan to leave the hotel, i.e. 10:00","type":"string","format":"time-hour:time-minute"},"transportation":{"description":"Details of the mean of transport used by the guests to reach the hotel (or the area)","required":["type"],"properties":{"type":{"description":"Type of transportation, based on OTA Code Type TRP (2-Boat, 3-Bus, 5-Car, 8-Helicopter, 9-Limousine, 14-Plane, 17-Shuttle, 18-Subway, 20-Taxi, 21-Train, 26-Other)","type":"integer","enum":[2,3,5,8,9,14,17,18,20,21,26]},"id":{"description":"Identifier of the transportation method (i.e flight Number for air, train Number for rail, …). If transportation type is 14, this field must be the concatenation Carrier Code and '-' Flight NumberID ('AF-1234')","type":"string","minLength":1,"maxLength":32},"locationCode":{"description":"IATA code of the destination","type":"string","format":"alpha","minLength":3,"maxLength":3},"time":{"description":"Arrival time at destination or time of departure (concatenation of date and time)","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-01T18:25:00"},"locationDescription":{"description":"Textual identifier of the transportation departure/arrival (i.e train station, bus station, airport terminal)","type":"string","minLength":1,"maxLength":64},"terminal":{"description":"Terminal of the departure/arrival transportation","type":"string","format":"alphanumeric","minLength":2,"maxLength":2},"remoteLocation":{"description":"IATA code of departure (ONLY used for arrival transport - as locationCode concerns arrival) (used only for ARR option in GDS)","type":"string","format":"alpha","minLength":3,"maxLength":3}}},"loyaltyProgram":{"description":"Loyalty program of the guests with hotel provider","type":"object","required":["loyaltyId"],"properties":{"loyaltyId":{"description":"Identifier of the guest in the loyalty system","type":"string","pattern":"[A-Za-z0-9]{1,28}","minLength":1,"maxLength":28},"programs":{"description":"List of the associated programs","type":"array","maxItems":20,"items":{"type":"object","title":"program","properties":{"programName":{"description":"Name of the program","type":"string","minLength":1,"maxLength":5},"tierLevel":{"description":"Level within the program","type":"string","minLength":1,"maxLength":5}}}},"qualifier":{"$ref":"#/definitions/loyaltyProgramQualifier"}}},"loyaltyProgramQualifier":{"description":"qualifier details of the guest","type":"object","properties":{"dominance":{"description":"A dominant behaviour or interest exhibited by the guest.","type":"string","minLength":1,"maxLength":50},"tier":{"description":"The tier the guest is associated to","type":"string","minLength":1,"maxLength":20}}},"frequentTraveller":{"description":"Loyalty program of the guests with an airline","type":"object","required":["membershipId"],"properties":{"membershipId":{"description":"Unique identifier of the member. Examples - 1234567890 or AF1234567890 (in this case programId is not mandatory)","type":"string","format":"alphanumeric","minLength":1,"maxLength":28},"programId":{"description":"Loyalty program owner’s code (for instance “AF” for Air France). May be absent in case it is unknown","type":"string","format":"alphanumeric","minLength":2,"maxLength":3}}},"ArrivalAmenity":{"description":"It is a Code of loyalty arrival amenity selected by the loyalty guest","type":"string","minLength":1,"maxLength":15,"example":"Welcome Gift"},"specialEvent":{"description":"If an event or a special requirement occurs during the stay, the GRS applies automatically the restrictions configured for this event and send back the related information","type":"object","required":["start","minLOS"],"properties":{"description":{"$ref":"#/definitions/description"},"start":{"description":"The special event start date","type":"string","format":"date"},"minLOS":{"description":"Minimum length of stay required","type":"integer"}}},"travelPurpose":{"description":"Travel purpose of the segment","type":"string","enum":["Business","Leisure"]},"segmentFolio":{"description":"Detail of the payment amounts","type":"object","properties":{"chargeableAmount":{"description":"amount needed to respect the deposit policy","type":"string"},"paidAmount":{"description":"amount paid for this segment","type":"string"},"balance":{"description":"balance of the segment in the folio","type":"string"},"refund":{"description":"Amount that will be refunded for the transaction","type":"string"}}},"chargeRouting":{"description":"Definition of the charge routing settings","type":"object","required":["scope","destination"],"properties":{"scope":{"$ref":"#/definitions/scope"},"destination":{"$ref":"#/definitions/destination"},"isAllowance":{"type":"boolean","description":"Allowance Indicator. If it is set to true the charge routing are considered as allowances. If it is set to false the charge routing are not considered as allowances. By default this indicator is set to false."}}},"scope":{"description":"Define the charge routing scope","type":"object","properties":{"inventoryTypeCodes":{"type":"array","maxItems":1000,"items":{"$ref":"#/definitions/inventoryTypeCode"}},"allowanceGroups":{"type":"array","maxItems":100,"items":{"$ref":"#/definitions/allowanceGroup"}}}},"allowanceGroup":{"description":"Define the charge routing scope","type":"object","required":["code"],"properties":{"code":{"$ref":"#/definitions/code"},"amount":{"type":"string","description":"Amount set for the allowance group."},"currency":{"$ref":"#/definitions/currency"}}},"destination":{"description":"Define the charge routing destination","type":"object","required":["level","type"],"properties":{"level":{"type":"string","description":"Level of the folio, can be \"Segment\" or \"Reservation\"","enum":["Segment","Reservation"]},"userProfileId":{"type":"integer","description":"Identifies a unique guest within the reservation. This is only used when the charge routing destination type is equal to \"Guest\""},"type":{"type":"string","description":"Type of the destination, can be \"Guest\" or \"CorporateAccount\".","enum":["Guest","CorporateAccount"]}}},"customerOwnReference":{"description":"It is used to store reference of the customer. It is used in relation to any form of payment","type":"string","maxLength":24},"purchaseOrderReference":{"description":"It is used to store reference of the purchase order. It is used in relation to any form of payment","type":"string","maxLength":24},"channelPreferredRate":{"description":"Indicates the preferred rate to be returned to the requestor channel.","type":"string","enum":["Check-in","Highest"]},"channelExtraPersonChargeIncluded":{"description":"Indicates if the extra person charges are included in the base amount of the rates","type":"boolean"},"cancelByHotelOnly":{"description":"Cancel can be only allowed by PMS. It is set to false, if no RLP exists for the rate","type":"boolean"},"lateArrivalTime":{"description":"The late arrival time","type":"string"},"fees":{"description":"Fee","type":"object","required":["type"],"properties":{"type":{"description":"Type or origin of the fee","type":"string","enum":["Cancellation","No-show"]},"amount":{"description":"Fee amount","type":"string"},"optionalServicesIncluded":{"description":"If yes, penalty fees include rooms and all services (optional and included). If no, penalty fees include rooms and included services only. Returned only if the penalty rule is a full stay percentage.","type":"boolean"},"numberOfNights":{"description":"Number of nights charged in case of cancellation.","type":"integer"},"description":{"description":"Penalties description.","$ref":"#/definitions/description"}}},"commission":{"description":"Commission","type":"object","properties":{"percent":{"description":"Percentage of the commission","type":"string"},"amount":{"description":"Flat amount of the commission","type":"string"}}},"ratesDefinition":{"type":"object","required":["rateChanges"],"properties":{"rateChanges":{"description":"The applicable rate changes of the stay. Gives the definition of rate set in the GRS.","type":"array","items":{"$ref":"#/definitions/rateDefinition"}},"dailyExtraPersonCharge":{"description":"Daily amount for 1 extra participant for non-service. Returned depending on channel profile and setting.","type":"string"},"average":{"description":"The average rate","type":"string"},"checkin":{"description":"The checkin rate depending on channel setting","type":"string"},"highest":{"description":"The highest rate depending on channel setting","type":"string"}}},"rateDefinition":{"description":"The applicable rate changes of the stay. Gives the definition of rate set in the GRS.","type":"object","required":["id","start","end","amount"],"properties":{"id":{"description":"Id of the RateDefinition element","type":"integer"},"start":{"description":"First date on which the rate amount applies (for the requested stay)","type":"string","format":"date"},"end":{"description":"Last date on which the rate amount applies (for the requested stay)","type":"string","format":"date"},"amount":{"description":"The base daily amount configured in the GRS which can include extra person charges depending on channel setting. In case of Package, it includes the price of all the products","type":"string"}}},"taxDefinition":{"type":"object","allOf":[{"$ref":"#/definitions/taxDefinitionCommon"},{"type":"object","properties":{"description":{"$ref":"#/definitions/description"},"longDescription":{"$ref":"#/definitions/description"}}}]},"taxDefinitionCommon":{"description":"The applicable rules of taxes over the stay","type":"object","required":["id","chargeFrequency","chargeUnit","values","computationType","isIncluded","start","end"],"properties":{"id":{"type":"integer","description":"A unique ID for this tax definition item. Referenced in rates tax breakdown"},"code":{"type":"string","maxLength":5,"description":"User defined code"},"taxTypeCode":{"type":"string","description":"OTA fee tax type code"},"name":{"type":"string","description":"Name of the tax of fee","maxLength":64},"isIncluded":{"type":"boolean","description":"Indicates if the tax is included or excluded"},"currency":{"$ref":"#/definitions/currency"},"computationType":{"type":"string","description":"Type of computation, either Flat or Percentage","enum":["Flat","Percentage"]},"computationMode":{"type":"string","description":"Which base amount to consider. Possible values are TaxOnTax (tax on another tax), TaxOnNet (tax on amount before taxes) or TaxOnRate(tax on amount including included taxes and excluding excluded taxes)","enum":["TaxOnRate","TaxOnNet","TaxOnTax"]},"chargeUnit":{"$ref":"#/definitions/chargeUnit"},"chargeFrequency":{"type":"string","description":"How the tax is computed, once or repeated each day","enum":["PerDay","PerStay"]},"productCodes":{"type":"array","description":"Product Code(s) to which the tax apply","items":{"$ref":"#/definitions/productCode"}},"start":{"description":"First date on which the tax definition item applies (for the requested stay).","type":"string","format":"date"},"end":{"description":"Last date on which the tax applies (for the requested stay).","type":"string","format":"date"},"dow":{"description":"List of applicable days of weeks. 'MTWTFSS' for all days of weeks. A dash is present for any missing day. For instance, 'MT-----' for Monday and Tuesday only, '-T-T---' for Tuesday and Thursday only","type":"string","pattern":"^[M-][T-][W-][T-][F-][S-][S-]$"},"values":{"type":"array","description":"values per criteria","items":{"$ref":"#/definitions/taxValue"}},"isPaidAtHotel":{"$ref":"#/definitions/isPaidAtHotel"}}},"taxValue":{"required":["value"],"properties":{"value":{"type":"string","pattern":"-?[0-9]+(\\.[0-9]+)?","description":"Percentage or flat amount of the tax","example":"9.12"},"guestTypes":{"type":"array","items":{"type":"string"}},"startAge":{"type":"integer","description":"Start age of the range","example":0},"endAge":{"type":"integer","description":"End age of the range. If no end age is specified the age range is considered up to infinite","example":18}}},"chargeUnit":{"description":"Unit for which the charge applies. Note that the PerUse charge unit is deprecated.","type":"string","enum":["PerPerson","PerProduct","PerUse"]},"hasAddOns":{"description":"Indicates if the segment is the parent of one or several add-on segment(s)","type":"boolean"},"parentId":{"description":"Reference to the parent segment by its id. Filled when the current segment is an add-on.","type":"integer"},"rmsData":{"description":"RMS data associated to the current rate plan/product combination.","type":"object","properties":{"calculationMethod":{"description":"Computation mode/Calculation type associated to the current rate plan/product combination for the corresponding dates, indicating how the amount is computed. It is currently used for flat amounts but it might be extended to other types of amounts as well.","type":"string"},"barLevels":{"description":"List of barLevels.","type":"array","items":{"$ref":"#/definitions/barLevel"}}}},"barLevel":{"type":"object","required":["barLevel","start","end"],"properties":{"barLevel":{"description":"Level associated to the current rate plan/product combination for the corresponding dates. It is used as a comment to differentiate between two similar price grids.","type":"string"},"start":{"description":"Period start date.","type":"string","format":"date"},"end":{"description":"Period end date.","type":"string","format":"date"}}},"invoiceId":{"description":"Invoice identifier","type":"string","maxLength":36},"indicatorsReq":{"description":"How the segment was booked. Example by Force Sell, Rate Override, was repriced...","type":"object","properties":{"isForcedSell":{"$ref":"#/definitions/isForcedSell"},"isForcedOverbook":{"$ref":"#/definitions/isForcedOverbook"}}},"indicatorsRes":{"description":"How the segment was booked. Example by Force Sell, Rate Override, was repriced...","type":"object","required":["isConfirmed"],"properties":{"isForcedSell":{"$ref":"#/definitions/isForcedSell"},"isForcedOverbook":{"$ref":"#/definitions/isForcedOverbook"},"isConfirmed":{"$ref":"#/definitions/isConfirmed"},"isPaidByPoints":{"$ref":"#/definitions/isPaidByPoints"},"isRepriced":{"$ref":"#/definitions/isRepriced"},"isAutoCancelled":{"$ref":"#/definitions/isAutoCancelled"},"isMigrated":{"$ref":"#/definitions/isMigrated"},"isCancelledAfterDeadline":{"$ref":"#/definitions/isCancelledAfterDeadline"},"hasRateOverride":{"$ref":"#/definitions/hasRateOverride"},"isRateOverrideWithinThreshold":{"$ref":"#/definitions/isRateOverrideWithinThreshold"},"hasForcedInventoryAvailability":{"$ref":"#/definitions/hasForcedInventoryAvailability"},"hasForcedRestrictions":{"$ref":"#/definitions/hasForcedRestrictions"}}},"indicatorsSearchRes":{"description":"How the segment was booked. Example by Force Sell, Rate Override...","type":"object","properties":{"isCancelledAfterDeadline":{"$ref":"#/definitions/isCancelledAfterDeadline"},"hasRateOverride":{"$ref":"#/definitions/hasRateOverride"},"isRateOverrideWithinThreshold":{"$ref":"#/definitions/isRateOverrideWithinThreshold"},"hasForcedInventoryAvailability":{"$ref":"#/definitions/hasForcedInventoryAvailability"},"hasForcedRestrictions":{"$ref":"#/definitions/hasForcedRestrictions"}}},"isForcedSell":{"description":"Indicates that the segment is forced","type":"boolean"},"isForcedOverbook":{"description":"Indicates if the reservation request is an overbooking request","type":"boolean"},"isConfirmed":{"description":"If false, the 'option' element at segment level is filled","type":"boolean"},"isPaidByPoints":{"description":"Indicates that the segment is paid by point. Default value is false","type":"boolean"},"isAutoCancelled":{"description":"Indicates that the segment has been auto-cancelled. Default value is false","type":"boolean"},"isRepriced":{"description":"Indicates that the segment was repriced during the last modification (Only applies for Modify, Retrieve and Cancel responses)","type":"boolean"},"isCrossChannelCancel":{"description":"Indicates that the reservation was cancelled by another channel. This is only returned if the flag CHL_UnsolicitedSupported of the booking originator channel is true.","type":"boolean"},"isWaitlist":{"description":"Indicates that the segment is waitlisted","type":"boolean"},"isTentative":{"description":"Indicates that the segment is tentative","type":"boolean"},"isMigrated":{"description":"Indicates that the reservation was migrated. Default value is false","type":"boolean"},"hasForcedInventoryAvailability":{"description":"Flag to indicate the inventory availability was bypassed","type":"boolean"},"hasForcedRestrictions":{"description":"Flag to indicate that pricing restrictions were bypassed","type":"boolean"},"isCancelledAfterDeadline":{"description":"Flag to indicate that cancellation was done after cancellation deadline","type":"boolean"},"isRateOverrideWithinThreshold":{"description":"Flag to indicate the rate was overridden within the set threshold","type":"boolean"},"hasRateOverride":{"description":"Flag to indicate the rate was overridden","type":"boolean"},"option":{"description":"Present only for tentative or waitlisted booking,","type":"object","required":["type"],"properties":{"type":{"$ref":"#/definitions/optionType"},"deadline":{"$ref":"#/definitions/optionDeadline"}}},"optionType":{"description":"Type of the option","type":"string","enum":["Tentative","Waitlist"]},"optionDeadline":{"description":"Option date and GMT time before which the Option booking should be confirmed. If not informed with “type”=Tentative, the segment will be cancelled automatically 24h hours later","type":"string","example":"2018-05-26T22:00:00"},"address":{"type":"object","properties":{"index":{"$ref":"#/definitions/addressIndex"},"type":{"$ref":"#/definitions/addressType"},"addressLines":{"$ref":"#/definitions/addressLines"},"cityName":{"$ref":"#/definitions/cityName"},"postalCode":{"$ref":"#/definitions/postalCode"},"county":{"$ref":"#/definitions/county"},"stateProv":{"$ref":"#/definitions/stateProv"},"countryName":{"$ref":"#/definitions/countryName"},"countryCode":{"$ref":"#/definitions/countryCode"},"companyName":{"$ref":"#/definitions/companyName"},"unstructuredAddress":{"$ref":"#/definitions/unstructuredAddress"}}},"addressIndex":{"description":"Address index. Will identify the address inside the reservation all along the reservation life","type":"integer"},"cityName":{"description":"City name","type":"string","minLength":1,"maxLength":30},"companyName":{"description":"Company name, makes sense if type is business address","type":"string","minLength":1,"maxLength":100},"countryCode":{"description":"Country code defined by the ISO 3166 norm","type":"string","pattern":"[A-Za-z]{2,2}","minLength":2,"maxLength":2},"countryName":{"description":"Country name","type":"string","minLength":1,"maxLength":64},"county":{"description":"County name","type":"string","minLength":1,"maxLength":32},"postalCode":{"description":"Postal or ZIP code","type":"string","minLength":1,"maxLength":16},"stateProv":{"description":"Abbreviated state name","type":"string","minLength":1,"maxLength":25},"addressType":{"description":"Defines if the address is personal (1) or business (2), based on OTA_CodeType CLT","type":"integer","enum":[1,2]},"addressLines":{"description":"List of address lines","type":"array","maxItems":5,"items":{"description":"Address line","type":"string","minLength":1,"maxLength":150}},"unstructuredAddress":{"description":"List of unstructured address lines","type":"array","maxItems":10,"items":{"type":"string","minLength":1,"maxLength":150,"description":"Address without any structure"}},"telephone":{"type":"object","required":["number"],"properties":{"locationType":{"$ref":"#/definitions/phoneLocationType"},"deviceType":{"$ref":"#/definitions/phoneDeviceType"},"countryCode":{"$ref":"#/definitions/phoneCountryCode"},"areaCode":{"$ref":"#/definitions/phoneAreaCode"},"extension":{"$ref":"#/definitions/phoneExtension"},"number":{"$ref":"#/definitions/phoneNumber"}}},"phoneLocationType":{"description":"Defines if the given phone/fax Number is business (7) or home (6), based on OTA_CodeType PLT","type":"integer","enum":[6,7]},"phoneDeviceType":{"description":"The technology associated to the Number, based on OTA_CodeType PTT (1-Phone, 3-Fax, 5-Mobile)","type":"integer","enum":[1,3,5]},"phoneCountryCode":{"description":"The country code associated to the phone number","type":"string","format":"numeric","minLength":1,"maxLength":3},"phoneAreaCode":{"description":"The area code associated to the phone number","type":"string","format":"numeric","minLength":1,"maxLength":8},"phoneExtension":{"description":"The extension associated to the phone number","type":"string","format":"numeric","minLength":1,"maxLength":5},"phoneNumber":{"description":"Phone / fax number","type":"string","minLength":1,"maxLength":57},"email":{"type":"object","required":["address"],"properties":{"type":{"$ref":"#/definitions/emailType"},"language":{"$ref":"#/definitions/emailLanguage"},"address":{"$ref":"#/definitions/emailField"}}},"emailType":{"description":"Defines if the given Email Number is business (2) or home (1), based on OTA_CodeType EAT","type":"integer","enum":[1,2]},"emailField":{"description":"Email","type":"string","minLength":1,"maxLength":90},"emailLanguage":{"description":"Preferred language to be used for the email content. Format ISO 639-1 code, like 'en'","type":"string","pattern":"[A-Za-z]{2}","minLength":2,"maxLength":2},"formOfPaymentReq":{"description":"Information concerning form of payment (guarantee, deposit, paid by point,...)","type":"object","properties":{"paymentInfo":{"$ref":"#/definitions/paymentInfoReq"},"depositPayments":{"description":"List of the payments done for deposits (payment by points excluded)","type":"array","maxItems":100,"items":{"$ref":"#/definitions/paymentTransactionReq"}},"paymentByPoints":{"description":"List of payments made by points","type":"array","maxItems":50,"items":{"$ref":"#/definitions/paymentByPoints"}}}},"formOfPaymentRes":{"description":"Information concerning form of payment (guarantee, deposit, paid by point,...)","type":"object","properties":{"paymentInfo":{"$ref":"#/definitions/paymentInfoRes"},"depositPayments":{"description":"List of the payments done for deposits (payment by points excluded)","type":"array","items":{"$ref":"#/definitions/paymentTransactionRes"}},"paymentByPoints":{"description":"List of payments made by points","type":"array","items":{"$ref":"#/definitions/paymentByPoints"}},"transactionIdsForRefundPoints":{"description":"List of transaction ids when refund points is needed after a modify","type":"array","items":{"$ref":"#/definitions/refundPoints"}}}},"formOfPaymentSearchRes":{"description":"Information concerning form of payment","type":"object","properties":{"paymentInfo":{"$ref":"#/definitions/paymentInfoSearchRes"}}},"refundPoints":{"description":"Transaction identifier of the payment to be refunded","type":"string"},"paymentByPoints":{"description":"Payment made with points","type":"object","properties":{"transactionId":{"$ref":"#/definitions/transactionId"},"dailyPoints":{"$ref":"#/definitions/dailyPoints"},"totalPoints":{"$ref":"#/definitions/totalPoints"}}},"transactionId":{"description":"transaction identifier for the payment","type":"string","pattern":"[A-Za-z0-9]{2,9}","minLength":2,"maxLength":9},"dailyPoints":{"description":"Daily points cost","type":"integer"},"totalPoints":{"description":"Total points cost","type":"integer"},"paymentTransactionReq":{"description":"Information concerning payment amount, payment source, form of payment","type":"object","properties":{"id":{"description":"Identifies a payment within the segment. This id is unique for each payment object at segment level.","type":"integer"},"amount":{"$ref":"#/definitions/paymentInfoAmount"},"paymentSource":{"$ref":"#/definitions/paymentSource"},"paymentStatus":{"$ref":"#/definitions/paymentStatus"},"paymentType":{"$ref":"#/definitions/paymentType"},"paymentCard":{"$ref":"#/definitions/paymentCard"},"guaranteePaymentId":{"$ref":"#/definitions/guaranteePaymentId"},"paymentIntent":{"$ref":"#/definitions/paymentIntent"},"fraudRecordId":{"description":"fraud record Id returned by the payment provider","type":"string","maxLength":99},"paymentRecordId":{"description":"payment record Id returned by the payment provider","type":"string","maxLength":99},"transactionDate":{"description":"Date and time of the payment transaction","type":"string","example":"2018-05-26T22:00:00"},"pares":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"invoiceId":{"$ref":"#/definitions/invoiceId"},"xid":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"veresCode":{"description":"Technical identifier of the 3D Secure check","type":"string","maxLength":1},"creditCardCompany":{"description":"company used in the 3DSecure process","type":"string","maxLength":4},"payer":{"$ref":"#/definitions/payerInformation"},"multiFactorInfo":{"$ref":"#/definitions/multiFactorInfo"}}},"paymentTransactionRes":{"description":"Information concerning payment amount, payment source, payment informer, form of payment","type":"object","required":["id"],"properties":{"id":{"description":"Identifies a payment within the segment. This id is unique for each payment object at segment level.","type":"integer"},"amount":{"$ref":"#/definitions/paymentInfoAmount"},"paymentSource":{"$ref":"#/definitions/paymentSource"},"paymentStatus":{"$ref":"#/definitions/paymentStatus"},"paymentType":{"$ref":"#/definitions/paymentType"},"paymentCard":{"$ref":"#/definitions/paymentCardRes"},"guaranteePaymentId":{"$ref":"#/definitions/guaranteePaymentId"},"paymentIntent":{"$ref":"#/definitions/paymentIntent"},"informerVendorCode":{"description":"vendorCode of the channel doing the payment transaction","type":"string","maxLength":5},"channelSubUser":{"description":"subUser of the channel doing the payment transaction","type":"string","maxLength":8},"fraudRecordId":{"description":"fraud record Id returned by the payment provider","type":"string","maxLength":99},"paymentRecordId":{"description":"payment record Id returned by the payment provider","type":"string","maxLength":99},"transactionDate":{"description":"Date and time of the payment transaction","type":"string","example":"2018-05-26T22:00:00"},"pares":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"invoiceId":{"$ref":"#/definitions/invoiceId"},"xid":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"veresCode":{"description":"Technical identifier of the 3D Secure check","type":"string","maxLength":1},"creditCardCompany":{"description":"company used in the 3DSecure process","type":"string","maxLength":4},"payer":{"$ref":"#/definitions/payerInformation"},"multiFactorInfo":{"$ref":"#/definitions/multiFactorInfo"}}},"paymentInfoReq":{"description":"Information concerning payment amount, payment source, payment informer, form of payment","type":"object","properties":{"amount":{"$ref":"#/definitions/paymentInfoAmount"},"paymentSource":{"$ref":"#/definitions/paymentSource"},"paymentStatus":{"$ref":"#/definitions/paymentStatus"},"paymentType":{"$ref":"#/definitions/paymentType"},"paymentCard":{"$ref":"#/definitions/paymentCard"},"guaranteePaymentId":{"$ref":"#/definitions/guaranteePaymentId"},"paymentIntent":{"$ref":"#/definitions/paymentIntent"},"fraudRecordId":{"description":"fraud record Id returned by the payment provider","type":"string","maxLength":99},"paymentRecordId":{"description":"payment record Id returned by the payment provider","type":"string","maxLength":99},"transactionDate":{"description":"Date and time of the payment transaction","type":"string","example":"2018-05-26T22:00:00"},"pares":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"invoiceId":{"$ref":"#/definitions/invoiceId"},"xid":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"veresCode":{"description":"Technical identifier of the 3D Secure check","type":"string","maxLength":1},"creditCardCompany":{"description":"company used in the 3DSecure process","type":"string","maxLength":4},"payer":{"$ref":"#/definitions/payerInformation"},"multiFactorInfo":{"$ref":"#/definitions/multiFactorInfo"}}},"paymentInfoRes":{"description":"Information concerning payment amount, payment source, payment informer, form of payment","type":"object","properties":{"amount":{"$ref":"#/definitions/paymentInfoAmount"},"paymentSource":{"$ref":"#/definitions/paymentSource"},"paymentStatus":{"$ref":"#/definitions/paymentStatus"},"paymentType":{"$ref":"#/definitions/paymentType"},"paymentCard":{"$ref":"#/definitions/paymentCardRes"},"guaranteePaymentId":{"$ref":"#/definitions/guaranteePaymentId"},"paymentIntent":{"$ref":"#/definitions/paymentIntent"},"informerVendorCode":{"$ref":"#/definitions/informerVendorCode"},"fraudRecordId":{"description":"fraud record Id returned by the payment provider","type":"string","maxLength":99},"paymentRecordId":{"description":"payment record Id returned by the payment provider","type":"string","maxLength":99},"transactionDate":{"description":"Date and time of the payment transaction","type":"string","example":"2018-05-26T22:00:00"},"pares":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"invoiceId":{"$ref":"#/definitions/invoiceId"},"xid":{"description":"Technical identifier of the 3D Secure check, binary value","type":"string","maxLength":99},"veresCode":{"description":"Technical identifier of the 3D Secure check","type":"string","maxLength":1},"creditCardCompany":{"description":"company used in the 3DSecure process","type":"string","maxLength":4},"payer":{"$ref":"#/definitions/payerInformation"},"multiFactorInfo":{"$ref":"#/definitions/multiFactorInfo"}}},"paymentInfoSearchRes":{"description":"Information concerning payment amount, payment source, payment informer, form of payment","type":"object","properties":{"amount":{"$ref":"#/definitions/paymentInfoAmount"},"paymentStatus":{"$ref":"#/definitions/paymentStatus"},"paymentType":{"$ref":"#/definitions/paymentType"},"paymentCard":{"$ref":"#/definitions/paymentCardSearch"},"guaranteePaymentId":{"$ref":"#/definitions/guaranteePaymentId"}}},"payerInformation":{"description":"describe the payer of the payment object","type":"object","required":["payerType"],"properties":{"payerId":{"type":"integer","description":"Identifies a guest within the reservation which will be the payer of this payment object. This id cross reference a userProfile. It is only set when payerType is set to Guest."},"payerType":{"type":"string","enum":["Guest","CorporateAccount"],"description":"Identifies the type of the payer. It is either \"Guest\" or \"CorporateAccount\"."}}},"paymentInfoAmount":{"description":"The amount paid/to be paid. Mandatory if the paymentStatus is provided","type":"string"},"paymentSource":{"description":"Payment Source","type":"object","properties":{"code":{"$ref":"#/definitions/paymentSourceCode"},"text":{"$ref":"#/definitions/paymentSourceText"}}},"paymentStatus":{"description":"Indicates if the payment has already been received or not, could be [Payment received or Waiting payment].","type":"string","enum":["Payment received","Waiting payment"]},"paymentType":{"description":"Payment type based on OTA_CodeList PMT. (1-Cash, 2-Direct Bill, 3-Voucher, 5-Credit Card, 7-Check, 19-IATA Number, 30-Corporate Discount Number, 44-Guarantee to Property, 46-Online Payment, 47-Pay by Points, 48-Pay by EFT Electronic Funds Transfer)","type":"integer","enum":[1,2,3,5,7,19,30,44,46,47,48]},"paymentCard":{"description":"Used in case of guarantee per credit card (guaranteeTypeCode 5). Details of a credit card if the chosen means of payment is a credit card","type":"object","required":["cardCode","expireDate","cardNumber"],"properties":{"cardCode":{"$ref":"#/definitions/cardCode"},"expireDate":{"$ref":"#/definitions/expireDate"},"cardNumber":{"$ref":"#/definitions/cardNumber"},"cardHolderName":{"$ref":"#/definitions/cardHolderName"},"cvvNumber":{"$ref":"#/definitions/cvvNumber"},"issuanceCountry":{"$ref":"#/definitions/issuanceCountry"},"isCNP":{"$ref":"#/definitions/isCNP"},"billingAddress":{"description":"Billing address, potentially different from the payer address.","$ref":"#/definitions/addressWithoutIndex"}}},"paymentCardRes":{"description":"Used in case of guarantee per credit card (guaranteeTypeCode 5). Details of a credit card if the chosen means of payment is a credit card","type":"object","required":["cardCode","expireDate","cardNumber"],"properties":{"cardCode":{"$ref":"#/definitions/cardCode"},"expireDate":{"$ref":"#/definitions/expireDate"},"cardNumber":{"$ref":"#/definitions/cardNumber"},"cardHolderName":{"$ref":"#/definitions/cardHolderName"},"issuanceCountry":{"$ref":"#/definitions/issuanceCountry"},"isCNP":{"$ref":"#/definitions/isCNP"},"billingAddress":{"description":"Billing address, potentially different from the payer address.","$ref":"#/definitions/addressWithoutIndex"}}},"paymentCardSearch":{"description":"Used in case of guarantee per credit card (guaranteeTypeCode 5). Details of a credit card if the chosen means of payment is a credit card","type":"object","required":["cardCode","expireDate","cardNumber"],"properties":{"cardCode":{"$ref":"#/definitions/cardCode"},"expireDate":{"$ref":"#/definitions/expireDate"},"cardNumber":{"$ref":"#/definitions/cardNumber"}}},"guaranteePaymentId":{"description":"Guarantee identifier used in case of guarantee per Booking source or CD Number (paymentType 19 or 30)","type":"string","pattern":"[A-Za-z0-9]{1,20}","minLength":1,"maxLength":20},"paymentIntent":{"description":"Specifies if the payment is for a deposit, guarantee or refund.","type":"string","enum":["Deposit","Guarantee","Refund"]},"informerVendorCode":{"description":"Vendor code which set the paymentStatus to 'Payment received'","type":"string","maxLength":5},"multiFactorInfo":{"description":"Payment transaction information","type":"object","properties":{"agreedMandate":{"type":"string","description":"Describes the agreed mandate between the cardholder and the agent/third party. [NA=No agreement for future MIT, NS=Agreement for future No show/Cancellation Fee, BP=Agreement for prepayment/balance payment,FR=Agreement for recurring payment (fixed date), UR=Agreement for recurring payment (usage based non fixed date)]","maxLength":2},"authenticationDidNotComplete":{"type":"string","description":"This value is required to communicate to the authorizing party that authentication could not be completed in certain circumstances","maxLength":2},"bookingChannel":{"type":"string","description":"Indicates in which channel the transaction was initiated. [MO=Mail order, TO=Telephone order, EC=Ecomm, FA=Face-To-Face]","maxLength":2},"cardNumberCollection":{"type":"string","description":"determines how the card number was collected for the transaction. [K=Keyed in, S=Card On File]","maxLength":1},"cavv":{"type":"string","description":"Cardholder Authentication Verification Value. The value should be appended to the authorization message signifying that the transaction has been successfully authenticated. Required only for MasterCard","maxLength":48},"dsTransactionId":{"type":"string","description":"Unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction","maxLength":36},"eci":{"type":"string","description":"Electronic Commerce Indicator. The ECI value is part of the 2 data elements that indicate the transaction was processed electronically. This should be passed on the authorization transaction to the gateway/processor","maxLength":40},"exemptionUsed":{"type":"string","description":"Determines which exemption was used. Before using any exemption or Delegated authentication, a Booking Agent must ensure the acquirer of the merchant is allowing use of this exemption. [TR=Transaction Risk Analysis Exemption, TV=Trusted Beneficiary Exemption, LV=Low Value Exemption, SC=Secure Corporate Exemption, DA=Delegated Authentication]","maxLength":2},"identifierOfAuthorization":{"type":"string","description":"Describes the Transaction ID/Trace ID of the authorization request when performed by the Booking Agent","maxLength":16},"merchantName":{"type":"string","description":"Used by authenticator in authentication request","maxLength":40},"tavv":{"type":"string","description":"Token Authentication Verification Value. Required only for Visa card","maxLength":40},"threeDsAuthenticationValue":{"type":"string","description":"3D Secure Authentication value","maxLength":40},"threeDsVersion":{"type":"string","description":"Version of 3D Secure used","maxLength":10},"transactionXid":{"type":"string","description":"Transaction identifier resulting from authentication processing","maxLength":40}}},"paymentSourceCode":{"description":"The code designating the payment source, e.g. P for PayPal","type":"string","maxLength":20},"paymentSourceText":{"description":"Free-form text to describe or name the payment source, e.g. PayPal","type":"string","maxLength":100},"cardCode":{"description":"The code of the credit card provider.","type":"string","pattern":"[A-Z0-9]{2,2}","minLength":2,"maxLength":2},"expireDate":{"description":"Expire date.","type":"string"},"cardNumber":{"description":"Card number","type":"object","required":["token"],"properties":{"token":{"$ref":"#/definitions/token"}}},"cvvNumber":{"description":"CVV number","type":"object","required":["token"],"properties":{"token":{"$ref":"#/definitions/token"}}},"issuanceCountry":{"description":"issuance country of the card using the ISO 3166-1 standard code for countries, territories or areas","type":"string","pattern":"[a-zA-Z]{2}","minLength":2,"maxLength":2,"example":"BR"},"cardHolderName":{"description":"Name of the credit card holder. The name should be as written on the credit card.","type":"string","minLength":1,"maxLength":64},"token":{"description":"Token provided by the requestor","type":"string","pattern":"[A-Za-z0-9]{1,19}","minLength":1,"maxLength":19},"isCNP":{"description":"Card Not Present indicator. If it is set to true the card can not be present at check-in time. If it is set to false the card needs to be physically present at check-in time. Default value false","type":"boolean"},"policiesRes":{"description":"Element containing all the policies regarding guarantee, deposit, cancellation, no-show and early check-out","type":"object","properties":{"isPrepaid":{"description":"True when deposit is 100% of the stay","type":"boolean"},"guarantee":{"description":"Payment policies for the guarantee","$ref":"#/definitions/guaranteeRes"},"deposit":{"description":"Payment policies for the deposit","$ref":"#/definitions/depositRes"},"cancellation":{"description":"The cancellation policy information applicable to the rate plan for the requested period","$ref":"#/definitions/cancellationRes"},"cancellationNoShow":{"description":"The no-show policy information applicable to the rate plan for the requested period, if present","$ref":"#/definitions/cancellationNoShowRes"},"earlyDeparture":{"description":"The early departure policy information applicable to the rate plan for the requested period, if present. Returned only for rate plans having Sleeping room product","$ref":"#/definitions/earlyDepartureRes"},"checkinTime":{"description":"The check-in time","type":"string"},"checkoutTime":{"description":"The check-out time","type":"string"}}},"guaranteeRes":{"description":"Payment policies for the guarantee","type":"object","required":["isRequired"],"properties":{"isRequired":{"$ref":"#/definitions/isRequired"},"time":{"$ref":"#/definitions/time"},"description":{"$ref":"#/definitions/description"},"acceptedGuarantees":{"description":"Indicate the list of accepted forms of guarantee and credit cards","$ref":"#/definitions/acceptedGuarantees"}}},"depositRes":{"description":"Payment policies for the deposit","type":"object","required":["isRequired","amount"],"properties":{"isRequired":{"$ref":"#/definitions/isRequired"},"feeType":{"$ref":"#/definitions/policyFeeType"},"feeValue":{"description":"Flat amount, flat amount per night, number of nights or percentage fee defined in deposit policy.","type":"string"},"amount":{"description":"Computed amount for deposit due","type":"string"},"description":{"$ref":"#/definitions/description"},"deadline":{"$ref":"#/definitions/deadline"},"acceptedDeposits":{"description":"Indicate the list of accepted forms of deposit and credit cards","$ref":"#/definitions/acceptedDeposits"}}},"cancellationRes":{"description":"The cancellation policy information applicable to the rate plan for the requested period","type":"object","required":["feeType","amount","isGracePeriod"],"properties":{"feeType":{"$ref":"#/definitions/policyFeeType"},"feeValue":{"description":"Flat amount, flat amount per night, number of nights or percentage fee defined in cancellation policy","type":"string"},"amount":{"description":"Computed amount for cancellation due","type":"string"},"deadline":{"$ref":"#/definitions/deadline"},"isGracePeriod":{"description":"Is set to true if policy is not applied","type":"boolean"},"isApplied":{"description":"If true, indicates that this cancellation penalty was used in the fee calculation","type":"boolean"}}},"cancellationNoShowRes":{"description":"The no-show policy information applicable to the rate plan for the requested period, if present","type":"object","required":["feeType","amount","deadline","isGracePeriod"],"properties":{"feeType":{"$ref":"#/definitions/policyFeeType"},"feeValue":{"description":"Flat amount, flat amount per night, number of nights or percentage fee defined in cancellation no show policy.","type":"string"},"amount":{"description":"Computed amount due for cancellation-noshow policy","type":"string"},"deadline":{"$ref":"#/definitions/deadline"},"refundPercentage":{"description":"The refund percentage corresponds to the percentage out of the penalty that the guest will receive in case of cancellation.","type":"string"},"isGracePeriod":{"description":"Is set to true if policy is not applied","type":"boolean"},"isApplied":{"description":"If true, indicates that this cancellation no show penalty was used in the fee calculation","type":"boolean"}}},"earlyDepartureRes":{"description":"The early departure policy information applicable to the rate plan for the requested period, if present. Returned only for rate plans having Sleeping room product","type":"object","required":["feeType","amount"],"properties":{"feeType":{"$ref":"#/definitions/policyFeeType"},"feeValue":{"description":"Flat amount, flat amount per night, number of nights or percentage fee defined in early departure policy","type":"string"},"amount":{"description":"Computed amount for early check-out due","type":"string"},"isApplied":{"description":"If true, indicates that this early Departure penalty was used in the fee calculation","type":"boolean"}}},"isRequired":{"description":"Indicates whether the guarantee/deposit is mandatory.","type":"boolean"},"time":{"description":"Cancellation time of default cancellation no show policy","type":"string"},"policyFeeType":{"description":"The due amount type of the policy","type":"string","enum":["Flat","FlatPerNight","Nights","StayPercent","FirstNight","LastNight","FirstLast","FullStay"]},"amount":{"description":"Amount defined in the CRS which includes included taxes/service charges and excludes excluded taxes/service charges","type":"string"},"deadline":{"type":"object","required":["dateTime","deadlineType"],"properties":{"dateTime":{"description":"The deadline date/time, expressed in UTC","type":"string","example":"2014-05-26T22:00:00"},"deadlineType":{"description":"The deadline type","type":"string","enum":["atBooking","numberOfDaysAfterBooking","numberOfDaysBeforeCheckin"]},"deadlineValue":{"description":"Value of the deadline type. Not returned if deadlineType is atBooking","type":"integer"}}},"acceptedFop":{"type":"string","enum":["cash","directBill","voucher","paymentCard","check","businessAccount","miscChargeOrder","travelAgencyIata","frequentGuestNumber","wirePayment","corporateNumber","paymentManager","advancedDeposit","crqCheck","hotelGuestId"]},"acceptedGuarantees":{"type":"object","description":"Accepted forms of payment and credit cards","properties":{"acceptedFops":{"description":"Accepted forms of payment","type":"array","items":{"$ref":"#/definitions/acceptedFop"}},"creditCards":{"description":"List of accepted credit cards","type":"array","items":{"$ref":"#/definitions/creditCard"}}}},"acceptedDeposits":{"type":"object","description":"Accepted forms of payment and credit cards","properties":{"acceptedFops":{"description":"Accepted forms of payment","type":"array","items":{"$ref":"#/definitions/acceptedFop"}},"creditCards":{"description":"List of accepted credit cards","type":"array","items":{"$ref":"#/definitions/creditCard"}}}},"creditCard":{"description":"Credit card code","type":"string","minLength":2,"maxLength":2},"corporateAccountInfoReq":{"description":"List of corporate accounts (up to 2 from different sources)","type":"array","maxItems":2,"items":{"type":"object","title":"corporateAccount","properties":{"accountName":{"$ref":"#/definitions/accountName"},"cdNumber":{"$ref":"#/definitions/cdNumber"},"isCdAutoAppended":{"$ref":"#/definitions/isCdAutoAppended"},"accountSource":{"$ref":"#/definitions/accountSource"},"address":{"$ref":"#/definitions/address"},"telephone":{"$ref":"#/definitions/telephone"},"email":{"$ref":"#/definitions/email"},"companyProfileId":{"$ref":"#/definitions/companyProfileId"},"externalProfileIds":{"description":"Corporate profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}}}}},"corporateAccountInfoRes":{"description":"List of corporate accounts (up to 2 from different sources)","type":"array","maxItems":2,"items":{"type":"object","title":"corporateAccount","properties":{"accountName":{"$ref":"#/definitions/accountName"},"cdNumber":{"$ref":"#/definitions/cdNumber"},"isCdAutoAppended":{"$ref":"#/definitions/isCdAutoAppended"},"accountSource":{"$ref":"#/definitions/accountSource"},"address":{"$ref":"#/definitions/address"},"telephone":{"$ref":"#/definitions/telephone"},"email":{"$ref":"#/definitions/email"},"isMainCorporateAccount":{"$ref":"#/definitions/isMainCorporateAccount"},"companyProfileId":{"$ref":"#/definitions/companyProfileId"},"companyProfileStatus":{"$ref":"#/definitions/companyProfileStatus"},"profileNotFound":{"$ref":"#/definitions/profileNotFound"},"discrepancyFound":{"$ref":"#/definitions/discrepancyFound"},"discrepancyReason":{"$ref":"#/definitions/discrepancyReason","description":"List of fields separated by comma which has discrepancy"},"externalProfileIds":{"description":"Corporate profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}}}}},"corporateAccountInfoSearchRes":{"type":"object","properties":{"accountName":{"$ref":"#/definitions/accountName"},"cdNumber":{"$ref":"#/definitions/cdNumber"},"companyProfileStatus":{"$ref":"#/definitions/companyProfileStatus"},"externalProfileIds":{"description":"Corporate profile id received from external system","type":"array","items":{"$ref":"#/definitions/externalProfileId"}}}},"accountName":{"description":"Corporate account name","type":"string","minLength":1,"maxLength":35},"cdNumber":{"description":"Corporate discount Number entered for reservation","type":"string","pattern":"[A-Za-z0-9]{1,20}","minLength":1,"maxLength":20},"isCdAutoAppended":{"description":"If true, it means the cd number has not been filled explicitly by the requestor","type":"boolean"},"isMainCorporateAccount":{"description":"Set to true if the corporate account information is the one that is taken into account in the reservation","type":"boolean"},"accountSource":{"description":"Source of the corporate account information (loyalty account or corporate account)","type":"string","enum":["loyalty","corporate"]},"companyProfileId":{"description":"Company identifier on the profile system.","type":"string","maxLength":36},"companyProfileStatus":{"description":"Status of the company in the profile system","type":"string","enum":["Active","Inactive"]},"offerReq":{"type":"object","description":"offer","required":["productUses"],"properties":{"groupCode":{"$ref":"#/definitions/groupCode"},"vendorBookingCode":{"$ref":"#/definitions/vendorBookingCode"},"productUses":{"$ref":"#/definitions/productUseReq"},"propertyMarketSegment":{"$ref":"#/definitions/propertyMarketSegment"},"nightlyCorpMarketSegments":{"description":"List of corporate market segments applicable for each night of the stay.","type":"array","items":{"$ref":"#/definitions/nightlyCorporateMarketSegment"}},"policyTypeCode":{"$ref":"#/definitions/policyTypeCode"},"promoCode":{"$ref":"#/definitions/promoCode"},"isPerpetualOffer":{"$ref":"#/definitions/isPerpetualOffer"},"rateAccessCode":{"$ref":"#/definitions/rateAccessCode"}}},"offerRes":{"type":"object","description":"offer","required":["productUses"],"properties":{"groupCode":{"$ref":"#/definitions/groupCode"},"vendorBookingCode":{"$ref":"#/definitions/vendorBookingCode"},"policies":{"$ref":"#/definitions/policiesRes"},"productUses":{"$ref":"#/definitions/productUseRes"},"totalRate":{"description":"Total amount of a segment with extra person.","$ref":"#/definitions/reservationTotalRateDetails"},"totalBaseOccRate":{"description":"Total amount of a segment without extra person.","$ref":"#/definitions/totalRateDetails"},"totalExtraOccRate":{"description":"Total amount of extra person in a segment.","$ref":"#/definitions/totalRateDetails"},"fees":{"description":"List of fees only used for modify and cancel actions.","type":"array","items":{"$ref":"#/definitions/fees"}},"isRateAccepted":{"description":"Flag returned in case an external rate override has been requested. It is set to true if the rate override has been accepted, false otherwise","type":"boolean"},"commission":{"description":"Commission.","$ref":"#/definitions/commission"},"groupId":{"$ref":"#/definitions/groupId"},"propertyMarketSegment":{"$ref":"#/definitions/propertyMarketSegment"},"nightlyCorpMarketSegments":{"description":"List of corporate market segments applicable for each night of the stay.","type":"array","items":{"$ref":"#/definitions/nightlyCorporateMarketSegment"}},"corpMarketSegment":{"$ref":"#/definitions/corporateMarketSegment"},"policyTypeCode":{"$ref":"#/definitions/policyTypeCode"},"promoCode":{"$ref":"#/definitions/promoCode"},"promoGroupCode":{"$ref":"#/definitions/promoGroupCode"},"isPerpetualOffer":{"$ref":"#/definitions/isPerpetualOffer"},"rateAccessCode":{"$ref":"#/definitions/rateAccessCode"}}},"isPerpetualOffer":{"description":"Indicates if the offer is considered as a perpetual one.","type":"boolean","default":false},"quantity":{"description":"Number of identical offers requested. Default value is 1","type":"integer"},"inventoryTypeCode":{"description":"Business code representing an inventory type","type":"string","minLength":1,"maxLength":50},"upgradedInventoryTypeCode":{"description":"Upgraded Inventory Type code (Hotelier want to upgrade a guest, pricing is still based on the original inventory type, inventory is taken on the upgraded inventory type)","type":"string","minLength":1,"maxLength":50},"pacCode":{"description":"Unique combination code of product, attributes and occupancy","type":"string","pattern":"[A-Z0-9]{2,8}"},"period":{"type":"object","required":["start","end"],"properties":{"start":{"description":"Period start date","type":"string","format":"date"},"end":{"description":"Period end date","type":"string","format":"date"}}},"searchPeriod":{"type":"object","required":["start"],"properties":{"start":{"description":"Search period start date","type":"string","format":"date"},"end":{"description":"Search period end date","type":"string","format":"date"}}},"groupCode":{"description":"Group code, identifies the product in case the reservation is for a group. Group code and rate plan code are mutually exclusive","type":"string","minLength":3,"maxLength":50},"specialRateInd":{"description":"Special rate indicator, computed for each reservation response and retrieval. It is set to ”S” if the last requestor is PMS, ”F” if the reservation was force-overridden, ”G” if the last operation was a shortening of the stay or if the reservation is a noRecord, and ”R” by default if none of these condition applies","type":"string","enum":["S","F","G","R"]},"groupId":{"description":"Internal identifier of the Group Contract","type":"string"},"saleStatus":{"description":"Sale status of the group contract","type":"string","enum":["prospect","definite","tentative"]},"businessSource":{"description":"Business source of the group contract","type":"string","minLength":1,"maxLength":100},"propertyMarketSegment":{"description":"Property market segment applicable for the reservation, e.g. wedding, sport group, company annual party etc.","type":"string"},"corporateMarketSegment":{"description":"Corporate market segment applicable for the next night to be consumed, e.g. GOVERNMENT, CORPORATE, LEISURE etc.","type":"string"},"nightlyCorporateMarketSegment":{"description":"Corporate market segment applicable for each night of the stay.","type":"object","required":["start","end","value"],"properties":{"start":{"description":"Start date","type":"string","format":"date"},"end":{"description":"End date","type":"string","format":"date"},"value":{"description":"Corporate market segment applicable for the given period, e.g. GOVERNMENT, CORPORATE, LEISURE etc.","type":"string"}}},"policyTypeCode":{"description":"Payment policy of the rate plan","type":"string"},"promoCode":{"description":"Promotion code for the offer","type":"string","pattern":"[A-Za-z0-9]{1,20}","minLength":1,"maxLength":20},"promoGroupCode":{"description":"Promotion group code associated with the promotion code in the offer","type":"string","pattern":"[A-Za-z0-9]{1,20}","minLength":1,"maxLength":20},"rateAccessCode":{"description":"Rate access code attached to the rate plan","type":"string","pattern":"[A-Za-z0-9]{1,6}","minLength":1,"maxLength":6},"productUseId":{"description":"Unique ID, generated by the CRS, identifying a product use. Included services are also assigned IDs. This ID is required when modifying an existing requested product use and should not specified at creation time.","type":"integer","format":"int32"},"productUseReq":{"description":"List of products (w/o attributes) with associated dates that are part of the offer","type":"array","maxItems":100,"items":{"type":"object","title":"productUse","required":["period","inventoryTypeCode","guestCounts"],"properties":{"id":{"$ref":"#/definitions/productUseId"},"period":{"description":"Period where the product is available","$ref":"#/definitions/period"},"isDayUse":{"description":"Indicates that the reservation is a day use reservation","type":"boolean"},"ratePlanCode":{"$ref":"#/definitions/ratePlanCode"},"routingInstructions":{"description":"List of routing Instructions","type":"array","items":{"$ref":"#/definitions/routingInstruction"}},"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"upgradedInventoryTypeCode":{"$ref":"#/definitions/upgradedInventoryTypeCode"},"quantity":{"$ref":"#/definitions/quantity"},"guestCounts":{"description":"Number of guests for the requested product. Per unit if there is no load balancing, for the whole offer if there is. Only one element should be filled for each age qualifying code","type":"array","items":{"$ref":"#/definitions/guestCountReq"}},"guestOccIds":{"description":"List of guest id which are part of this segment","type":"array","maxItems":50,"items":{"$ref":"#/definitions/id"}},"requestedProductRates":{"type":"array","maxItems":100,"items":{"$ref":"#/definitions/rateReq"}},"assignedRoom":{"$ref":"#/definitions/assignedRoom"}}}},"productUseRes":{"description":"List of products (w/o attributes) with associated dates that are part of the offer","type":"array","items":{"type":"object","title":"productUse","required":["period","quantity","inventoryTypeCode","guestCounts","totalGuestCounts"],"properties":{"id":{"$ref":"#/definitions/productUseId"},"period":{"description":"Period where the product is available","$ref":"#/definitions/period"},"isDayUse":{"description":"Indicates that the reservation is a day use reservation","type":"boolean"},"ratePlanCode":{"$ref":"#/definitions/ratePlanCode"},"routingInstructions":{"description":"List of routing Instructions","type":"array","items":{"$ref":"#/definitions/routingInstruction"}},"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"isOptional":{"$ref":"#/definitions/isOptional"},"isMainProduct":{"$ref":"#/definitions/isMainProduct"},"isConsumedNextDay":{"$ref":"#/definitions/isConsumedNextDay"},"upgradedInventoryTypeCode":{"$ref":"#/definitions/upgradedInventoryTypeCode"},"quantity":{"$ref":"#/definitions/quantity"},"guestCounts":{"description":"Number of guests for the requested product. Per unit if there is no load balancing, for the whole offer if there is. Only one element should be filled for each age qualifying code","type":"array","items":{"$ref":"#/definitions/guestCountRes"}},"hasGuestCountChanged":{"$ref":"#/definitions/hasGuestCountChanged"},"guestOccIds":{"description":"List of guest id which are part of this segment","type":"array","items":{"$ref":"#/definitions/id"}},"totalGuestCounts":{"description":"Total number of guests for the requested product","type":"array","items":{"$ref":"#/definitions/guestCountRes"}},"isProductIncludedInOffer":{"description":"Indicates if the product rate is included in the offer.","type":"boolean"},"specialRateInd":{"$ref":"#/definitions/specialRateInd"},"productRates":{"$ref":"#/definitions/productUseRates"},"packageRates":{"$ref":"#/definitions/productUseRates"},"assignedRoom":{"$ref":"#/definitions/assignedRoom"},"promotions":{"description":"Different types of promotions","type":"array","items":{"$ref":"#/definitions/promotionRes"}},"priceGridCode":{"description":"Price grid code. It is used for non-room products for packages only.","$ref":"#/definitions/priceGridCode"}}}},"productUseSearchRes":{"description":"List of products (w/o attributes) with associated dates that are part of the offer","type":"array","items":{"type":"object","title":"productUseSearch","required":["period","quantity","inventoryTypeCode","guestCounts","totalGuestCounts","productCode"],"properties":{"id":{"$ref":"#/definitions/productUseId"},"period":{"description":"Period where the product is available","$ref":"#/definitions/period"},"isDayUse":{"description":"Indicates that the reservation is a day use reservation","type":"boolean"},"ratePlanCode":{"$ref":"#/definitions/ratePlanCode"},"routingInstructions":{"description":"List of routing Instructions","type":"array","items":{"$ref":"#/definitions/routingInstruction"}},"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"isOptional":{"$ref":"#/definitions/isOptional"},"isMainProduct":{"$ref":"#/definitions/isMainProduct"},"isConsumedNextDay":{"$ref":"#/definitions/isConsumedNextDay"},"upgradedInventoryTypeCode":{"$ref":"#/definitions/upgradedInventoryTypeCode"},"inventoryTypeName":{"description":"Name of the inventory Type (short description)","$ref":"#/definitions/description"},"quantity":{"$ref":"#/definitions/quantity"},"guestCounts":{"description":"Number of guests for the requested product. Per unit if there is no load balancing, for the whole offer if there is. Only one element should be filled for each age qualifying code","type":"array","items":{"$ref":"#/definitions/guestCountRes"}},"totalGuestCounts":{"description":"Total number of guests for the requested product.","type":"array","items":{"$ref":"#/definitions/guestCountRes"}},"isProductIncludedInOffer":{"description":"Indicates if the product rate is included in the offer.","type":"boolean"},"assignedRoom":{"$ref":"#/definitions/assignedRoom"},"productCode":{"description":"Code defining the product (Sleeping room, meeting room or any service).","type":"string"},"priceGridCode":{"description":"Price grid code. It is used for non-room products for packages only.","$ref":"#/definitions/priceGridCode"}}}},"ratePlanCode":{"description":"Rate plan code","type":"string","pattern":"[A-Z0-9]{1,50}","minLength":1,"maxLength":50},"guestCountReq":{"title":"GuestCount","type":"object","minProperties":1,"properties":{"otaCode":{"description":"OTA Age Qualifier Code (e.g. for an Adult, \"AQC10\"). Either age or a combination of ota code and count is mandatory.","type":"string"},"count":{"description":"Number of guest","type":"integer","default":1},"age":{"description":"age of guest. Either age or a combination of ota code is mandatory.","$ref":"#/definitions/age"}}},"guestCountRes":{"title":"GuestCount","type":"object","minProperties":1,"properties":{"otaCode":{"description":"OTA Age Qualifier Code (e.g. for an Adult, \"AQC10\").","type":"string"},"count":{"description":"Number of guest","type":"integer"},"age":{"$ref":"#/definitions/age"},"guestType":{"description":"Guest Type Code","type":"string"}}},"productUseRates":{"type":"object","description":"rates of the product","properties":{"dailyRates":{"type":"array","items":{"$ref":"#/definitions/rateChange"}},"totalRate":{"description":"Total amount of a segment with extra person.","$ref":"#/definitions/totalRateDetails"},"totalBaseOccRate":{"description":"Total amount of a segment without extra person.","$ref":"#/definitions/totalRateDetails"},"totalExtraOccRate":{"description":"Total amount of extra person in a segment.","$ref":"#/definitions/totalRateDetails"},"bookingPattern":{"$ref":"#/definitions/bookingPattern"},"pricingFrequency":{"$ref":"#/definitions/pricingFrequency"},"pricingMethod":{"$ref":"#/definitions/pricingMethod"},"isDefaultPricingBased":{"description":"Indicates if current product is priced using default rate","type":"boolean"},"taxInclusionMode":{"$ref":"#/definitions/taxInclusionMode"},"hasRateChange":{"description":"Indicates that the base amount of the offer is changing over the stay","type":"boolean"},"ratesDefinition":{"description":"The list of applicable rates for current offer","$ref":"#/definitions/ratesDefinition"},"requestedRates":{"type":"array","items":{"$ref":"#/definitions/rateRes"}}}},"hasGuestCountChanged":{"description":"Indicates that the guest counts of the current image is different from the one the previous committed image","type":"boolean"},"dateTime":{"description":"Date and Time of the special request (UTC)","type":"string","pattern":"(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\\d|3[0-1])T([0-1]\\d|2[0-4]):([0-5]\\d):([0-5]\\d)","example":"2018-05-26T22:00:00"},"assignedRoom":{"description":"Room assignment, it is valid if the quantity  is equal to 1","type":"string","maxLength":50},"isOptional":{"description":"Defines whether or not the productUse is optional (if not, then it is part of a pre-defined package)","type":"boolean","default":false},"isMainProduct":{"description":"Defines whether or not the productUse contains the main product of the offer","type":"boolean","default":false},"isConsumedNextDay":{"description":"Indicates if the product is consumed the next day","type":"boolean","default":false},"pricingFrequency":{"description":"The frequency under which the product is priced","type":"string","enum":["PerNight","PerStay","PerUse"]},"bookingPattern":{"description":"The booking pattern defines when and how many times the product is used","type":"string","enum":["DayOfCheckIn","DayOfCheckOut","Anytime"]},"pricingMethod":{"description":"The method under which the product is priced","type":"string","enum":["PerProduct","PerPerson","PerProductPerOcc","PerProductPerGuestType"]},"routingInstruction":{"title":"RoutingInstruction","type":"object","description":"Routing Instruction object used for the Rate Plan","allOf":[{"$ref":"#/definitions/routingInstructionWithoutId"},{"type":"object","properties":{"id":{"type":"string","description":"Unique Identifier of the Routing Instruction generated by the system","maxLength":16}}}]},"routingInstructionWithoutId":{"title":"RoutingInstructionWithoutId","type":"object","description":"Routing Instruction object used for the Rate Plan","properties":{"code":{"type":"string","description":"Code of the Routing Instruction object given by the user","maxLength":64},"authorizerCode":{"type":"string","description":"Authorizer code from the Authorizer catalog","maxLength":32},"routingCode":{"type":"string","description":"Routing Codes from the Authorizer Catalog","maxLength":32},"window":{"type":"string","description":"Billing window used in the guest checkout process","maxLength":32},"limitCriteria":{"type":"string","description":"Determines the computation type of the Routing instruction complimentary limit","enum":["Flat","Percent"]},"limitValue":{"type":"string","description":"Computation value of the Routing Instruction complimentary limit. It could be an amount or a percentage","maxLength":32},"dow":{"type":"string","description":"Days of week of the Routing Instruction","example":"MT-TFS-","maxLength":32},"period":{"description":"Period of the routing instruction","$ref":"#/definitions/period"},"routingLimitType":{"type":"string","description":"Determines the type of the Routing limit","enum":["Room","Window","Comp"]},"couponNumber":{"type":"string","description":"Coupon number used per Routing Instruction","maxLength":64},"covers":{"type":"integer","description":"Number of participants covered by the Routing Instructions","maxLength":32},"source":{"type":"string","description":"Determines the source of routing","enum":["Client","System"]},"isDaily":{"type":"boolean","description":"Determines if the Routing Instruction is used daily"},"comment":{"type":"string","description":"Comment of the Routing Instruction","maxLength":2000}}},"rateReq":{"description":"List of requested rate amounts","type":"object","required":["start","end","base"],"properties":{"start":{"description":"Start date","type":"string","format":"date"},"end":{"description":"End date","type":"string","format":"date"},"base":{"$ref":"#/definitions/baseReq"}}},"rateRes":{"description":"List of the applied rates per period, and the list of original rates in case of an effective rate override","type":"object","required":["start","end","base"],"properties":{"start":{"description":"Start date","type":"string","format":"date"},"end":{"description":"End date","type":"string","format":"date"},"base":{"$ref":"#/definitions/baseRes"}}},"baseReq":{"description":"Used only to override the daily amount","type":"object","required":["amount"],"properties":{"amount":{"$ref":"#/definitions/amount"},"currency":{"$ref":"#/definitions/currency"},"overrideInd":{"$ref":"#/definitions/overrideInd"}}},"baseRes":{"description":"Used only to override the daily amount","type":"object","required":["amount"],"properties":{"amount":{"$ref":"#/definitions/amount"},"overrideInd":{"$ref":"#/definitions/overrideInd"},"originalBaseRates":{"description":"Original base rates in the CRS in case rate has been overridden","type":"array","items":{"$ref":"#/definitions/originalBaseRate"}}}},"currency":{"description":"Indicates the currency [ISO4217]","type":"string","pattern":"[A-Z]{3,3}","minLength":3,"maxLength":3,"example":"USD"},"overrideInd":{"description":"Flag to indicate the amount was overridden","type":"boolean"},"originalBaseRate":{"description":"Original base rates in the CRS in case rate has been overridden","type":"object","required":["start","end"],"properties":{"start":{"description":"Period start date","type":"string","format":"date"},"end":{"description":"Period end date","type":"string","format":"date"},"bsAmt":{"$ref":"#/definitions/baseAmount"}}},"totalSegment":{"description":"Total for the segment","type":"object","properties":{"finalPriceAmt":{"$ref":"#/definitions/finalPriceAmt"}}},"totalRateDetails":{"description":"All details on a given total rate.","type":"object","allOf":[{"$ref":"#/definitions/rateAmounts"},{"type":"object","properties":{"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"},"taxGroups":{"description":"The applicable taxes grouped by tax code and inclusion in rate","type":"array","minItems":1,"maxItems":99,"items":{"$ref":"#/definitions/taxAmount"}},"totalTaxes":{"description":"Total amount of all applicable taxes","type":"string","minLength":1,"maxLength":20},"daily":{"description":"Daily average, highest or checkin rate for the stay","type":"array","items":{"$ref":"#/definitions/dailyTypeAmount"}},"subTotalServiceCharges":{"description":"Total tax amounts classified as service charge.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"subTotalTaxes":{"description":"Total tax amounts classified as tax.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"}}}]},"reservationTotalRateDetails":{"description":"All details on a given total rate.","type":"object","allOf":[{"$ref":"#/definitions/reservationRateAmounts"},{"type":"object","properties":{"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"},"taxGroups":{"description":"The applicable taxes grouped by tax code and inclusion in rate","type":"array","minItems":1,"maxItems":99,"items":{"$ref":"#/definitions/taxAmount"}},"totalTaxes":{"description":"Total amount of all applicable taxes","type":"string"},"daily":{"description":"Daily average, highest or checkin rate for the stay","type":"array","minItems":1,"maxItems":99,"items":{"$ref":"#/definitions/dailyTypeAmount"}},"subTotalServiceCharges":{"description":"Total tax amounts classified as service charge.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"subTotalTaxes":{"description":"Total tax amounts classified as tax.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"}}}]},"reservationRateAmounts":{"type":"object","properties":{"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"amtAfTx":{"$ref":"#/definitions/amountAfterTax"}}},"rateAmounts":{"type":"object","required":["bsAmt"],"properties":{"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"amtAfTx":{"$ref":"#/definitions/amountAfterTax"}}},"dailyTypeAmount":{"description":"All details on a given daily rate.","type":"object","required":["amtType","bsAmt"],"properties":{"amtType":{"description":"Defines if amounts are average, checkin or highest rate","type":"string","enum":["Average","Checkin","Highest"]},"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"amtAfTx":{"$ref":"#/definitions/amountAfterTax"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"}}},"dailyRate":{"type":"object","properties":{"dailyBaseOccRate":{"$ref":"#/definitions/dailyRateDetails"},"dailyExtraOccRate":{"$ref":"#/definitions/dailyRateDetails"},"dailyTotalRate":{"$ref":"#/definitions/dailyRateDetails"}}},"rateChange":{"type":"object","allOf":[{"$ref":"#/definitions/dailyRate"},{"type":"object","required":["start","end"],"properties":{"start":{"description":"Period start date","type":"string","format":"date"},"end":{"description":"Period end date","type":"string","format":"date"}}}]},"dailyRateDetails":{"description":"All details on a given daily rate.","type":"object","properties":{"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"amtAfTx":{"$ref":"#/definitions/amountAfterTax"},"taxList":{"description":"The list of applicable taxes for this rate","type":"array","minItems":1,"maxItems":99,"items":{"$ref":"#/definitions/taxAmount"}},"totalTaxes":{"description":"Total of all the taxes and fees in a day","type":"string","minLength":1,"maxLength":20},"rateDefId":{"description":"When Amount is a dailyTotal, id of the reference RatesDefinitions item","$ref":"#/definitions/id"},"subTotalServiceCharges":{"description":"Total tax amounts classified as service charge.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"subTotalTaxes":{"description":"Total tax amounts classified as tax.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"}}},"amountBeforeTax":{"description":"Amount excluding all taxes/service charges","type":"string"},"amountAfterTax":{"description":"Amount including all taxes/service charges","type":"string"},"baseAmount":{"description":"Amount defined in the CRS which includes included taxes/service charges and excludes excluded taxes/service charges","type":"string"},"taxAmount":{"description":"Tax amount.","type":"object","required":["amount","isIncludedInRate"],"properties":{"amount":{"description":"Amount computed for this tax code","type":"string","minLength":1,"maxLength":20},"taxCode":{"description":"Tax code","type":"string","minLength":1,"maxLength":20},"isIncludedInRate":{"description":"Indicates if the tax has been included in the rate conveyed in associated \"baseAmount\". This field takes into account the inclusion set at house and rate plan level.","type":"boolean"},"otaCode":{"$ref":"#/definitions/otaTaxCode"},"taxDefIds":{"description":"References the Tax Definition Item applied to compute this tax amount.","type":"array","items":{"type":"integer"}}}},"subTotalTaxAmt":{"description":"Tax amount, with pay at hotel Taxes.","type":"object","allOf":[{"$ref":"#/definitions/taxAmount"},{"type":"object","title":"subTotalTaxAmt","properties":{"payableAmount":{"description":"Part of the sub total amount that can be payed before arriving at the hotel. Returned only when at least one tax or service charge that must be paid at the hotel is applicable. Returned only for subtotals of excluded taxes or service charges.","type":"string","minLength":1,"maxLength":20},"payHotelAmount":{"description":"Part of the sub total amount that need to be paid at the hotel. Returned only when at least one tax or service charge that must be paid at the hotel is applicable. Returned only for subtotals of excluded taxes or service charges","type":"string","minLength":1,"maxLength":20}}}]},"otaTaxCode":{"description":"Tax Code (Refer to [FTT] OTA code list)","type":"string","enum":["FTT1","FTT2","FTT3","FTT4","FTT5","FTT6","FTT7","FTT8","FTT9","FTT10","FTT11","FTT12","FTT13","FTT14","FTT15","FTT16","FTT17","FTT18","FTT19","FTT20","FTT21","FTT22","FTT23","FTT24","FTT25","FTT26","FTT27","FTT28","FTT29","FTT30","FTT31","FTT32","FTT33","FTT34","FTT35","FTT36","FTT37","FTT38","FTT39","FTT40","FTT41","FTT42","FTT43","FTT44","FTT45","FTT46","FTT47","FTT48","FTT49","FTT50","FTT51","FTT52","FTT53","FTT54","FTT55","FTT56"]},"isPaidAtHotel":{"description":"Set to true if the tax must be paid at the hotel.","type":"boolean"},"payableTotalTaxes":{"description":"Total amount of taxes and services charges that can be payed before arriving at the hotel. Returned only when at least one tax or service charge that must be paid at the hotel is applicable.","type":"string","minLength":1,"maxLength":20},"payHotelTotalTaxes":{"description":"Total amount of taxes and service charges to pay at the hotel. Returned only when at least one tax or service charge that must be paid at the hotel is applicable.","type":"string","minLength":1,"maxLength":20},"id":{"description":"A unique ID for the corresponding definition item. Used as reference.","type":"integer","format":"int32"},"finalPriceAmt":{"description":"Total including cancellation or no-show fees, with taxes except those payable at the hotel.","type":"string"},"finalPriceAmtWithoutFees":{"description":"Total excluding cancellation or no-show fees, with taxes except those payable at the hotel.","type":"string"},"history":{"description":"List of past images of the reservation","type":"array","items":{"type":"object","title":"historyImage","required":["resStatus","imageStatus","lastUpdateDateTime","reservationIds"],"properties":{"resStatus":{"$ref":"#/definitions/resStatus"},"reservationType":{"$ref":"#/definitions/reservationType"},"imageStatus":{"$ref":"#/definitions/imageStatus"},"bookingOfficeIds":{"description":"List of IDs of the booking office which requested the last transaction. Each ID is limited to 70 characters","type":"array","items":{"type":"string"}},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"},"lastUpdateDateTimeHotelLocalTime":{"$ref":"#/definitions/lastUpdateDateTimeHotelLocalTime"},"authenticatedUser":{"$ref":"#/definitions/authenticatedUser"},"impersonatedUser":{"$ref":"#/definitions/authenticatedUser"},"reservationIds":{"$ref":"#/definitions/reservationIdsRes"},"userProfiles":{"$ref":"#/definitions/guestsHistoryRes"},"requestor":{"$ref":"#/definitions/historyPointOfSale"},"segments":{"$ref":"#/definitions/historySegmentsRes"},"products":{"description":"The list of products (base product + attribute(s)) returned","type":"array","items":{"$ref":"#/definitions/product"}},"attributes":{"description":"The list of attributes","type":"array","items":{"$ref":"#/definitions/attribute"}},"links":{"description":"Link reservation details.","type":"array","items":{"$ref":"#/definitions/reservationLinks"}},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractRes"}},"ratePlans":{"description":"List of rate plans used in the reservation","type":"array","items":{"$ref":"#/definitions/ratePlanRes"}},"printRate":{"$ref":"#/definitions/printRate"},"chargePrivilege":{"$ref":"#/definitions/chargePrivilege"}}}},"authenticatedUser":{"description":"Authenticated user information. It is a LSS information (user id, first name, last name) related to the user who performed the transaction","type":"object","properties":{"userId":{"$ref":"#/definitions/userId"},"userLastName":{"$ref":"#/definitions/userLastName"},"userFirstName":{"$ref":"#/definitions/userFirstName"}}},"userId":{"description":"User id of the authenticated user","type":"string"},"userLastName":{"description":"Last name of the authenticated user","type":"string"},"userFirstName":{"description":"First name of the authenticated user","type":"string"},"historyProductUseRes":{"description":"List of products (w/o attributes) with associated dates that are part of the offer","type":"array","items":{"type":"object","title":"historyProductUse","required":["period","quantity","inventoryTypeCode","guestCounts","totalGuestCounts"],"properties":{"period":{"description":"Period where the product is available","$ref":"#/definitions/period"},"isDayUse":{"description":"Indicates that the reservation is a day use reservation","type":"boolean"},"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"isOptional":{"$ref":"#/definitions/isOptional"},"isMainProduct":{"$ref":"#/definitions/isMainProduct"},"upgradedInventoryTypeCode":{"$ref":"#/definitions/upgradedInventoryTypeCode"},"quantity":{"$ref":"#/definitions/quantity"},"routingInstructions":{"description":"List of routing Instructions","type":"array","items":{"$ref":"#/definitions/routingInstruction"}},"guestCounts":{"description":"Number of guests for the requested product. Per unit if there is no load balancing, for the whole offer if there is. Only one element should be filled for each age qualifying code","type":"array","items":{"$ref":"#/definitions/guestCountRes"}},"totalGuestCounts":{"description":"Total number of guests for the requested product","type":"array","items":{"$ref":"#/definitions/guestCountRes"}},"isProductIncludedInOffer":{"description":"Indicates if the product rate is included in the offer.","type":"boolean"},"ratePlanCode":{"$ref":"#/definitions/ratePlanCode"},"specialRateInd":{"$ref":"#/definitions/specialRateInd"},"productRates":{"$ref":"#/definitions/productUseRates"},"assignedRoom":{"$ref":"#/definitions/assignedRoom"},"promotions":{"description":"Different types of promotions","type":"array","items":{"$ref":"#/definitions/promotionRes"}},"guestOccIds":{"description":"List of guest id which are part of this segment","type":"array","items":{"$ref":"#/definitions/id"}},"priceGridCode":{"description":"Price grid code. It is used for non-room products for packages only.","$ref":"#/definitions/priceGridCode"}}}},"historyOfferRes":{"type":"object","description":"historyOffer","required":["productUses"],"properties":{"groupCode":{"$ref":"#/definitions/groupCode"},"productUses":{"$ref":"#/definitions/historyProductUseRes"},"totalRate":{"description":"Total amount of a segment with extra person.","$ref":"#/definitions/historyTotalRateDetails"},"totalBaseOccRate":{"description":"Total amount of a segment without extra person.","$ref":"#/definitions/historyTotalOccupancyRateDetails"},"totalExtraOccRate":{"description":"Total amount of extra person in a segment.","$ref":"#/definitions/historyTotalOccupancyRateDetails"},"groupId":{"$ref":"#/definitions/groupId"},"propertyMarketSegment":{"$ref":"#/definitions/propertyMarketSegment"},"nightlyCorpMarketSegments":{"description":"List of corporate market segments applicable for each night of the stay.","type":"array","items":{"$ref":"#/definitions/nightlyCorporateMarketSegment"}},"corpMarketSegment":{"$ref":"#/definitions/corporateMarketSegment"},"policyTypeCode":{"$ref":"#/definitions/policyTypeCode"},"promoCode":{"$ref":"#/definitions/promoCode"},"promoGroupCode":{"$ref":"#/definitions/promoGroupCode"},"isPerpetualOffer":{"$ref":"#/definitions/isPerpetualOffer"},"rateAccessCode":{"$ref":"#/definitions/rateAccessCode"}}},"historyTotalRateDetails":{"type":"object","properties":{"amtAfTx":{"$ref":"#/definitions/amountAfterTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"},"taxGroups":{"description":"The applicable taxes grouped by tax code and inclusion in rate","type":"array","items":{"$ref":"#/definitions/taxAmount"}},"daily":{"description":"Daily average, highest or checkin rate for the stay","type":"array","minItems":1,"maxItems":99,"items":{"$ref":"#/definitions/historyDailyTypeAmount"}},"subTotalServiceCharges":{"description":"Total tax amounts classified as service charge.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"subTotalTaxes":{"description":"Total tax amounts classified as tax.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"}}},"historyTotalOccupancyRateDetails":{"type":"object","required":["bsAmt"],"properties":{"amtBfTx":{"$ref":"#/definitions/amountBeforeTax"},"bsAmt":{"$ref":"#/definitions/baseAmount"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"},"daily":{"$ref":"#/definitions/historyDailyTypeAmount"},"subTotalServiceCharges":{"description":"Total tax amounts classified as service charge.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"subTotalTaxes":{"description":"Total tax amounts classified as tax.","type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/definitions/subTotalTaxAmt"}},"payableTotalTaxes":{"$ref":"#/definitions/payableTotalTaxes"},"payHotelTotalTaxes":{"$ref":"#/definitions/payHotelTotalTaxes"}}},"historyDailyTypeAmount":{"description":"Base amount on a given daily rate.","type":"object","required":["amtType","bsAmt"],"properties":{"amtType":{"description":"When daily rate detail is part of an daily rate item, defines if amount are average, checkin or highest rate. For history, we return the average rate","type":"string","enum":["Average","Checkin","Highest"]},"bsAmt":{"$ref":"#/definitions/baseAmount"},"payableAmtAfTx":{"description":"Amount after all taxes except those payable at the hotel","type":"string"}}},"historyFormOfPaymentRes":{"description":"Information concerning form of payment","type":"object","properties":{"paymentInfo":{"$ref":"#/definitions/paymentInfoRes"},"depositPayments":{"description":"List of the payments done for deposits (payment by points excluded)","type":"array","items":{"$ref":"#/definitions/paymentTransactionRes"}}}},"historySegmentsRes":{"description":"List of segments","type":"array","items":{"type":"object","title":"historySegment","required":["id","segmentStatus","actionStatus","segmentHolderId","propertyCode","offer","lastUpdateDateTime"],"properties":{"id":{"type":"integer","description":"Identify the segment inside the reservation all along the reservation life."},"customerOwnReference":{"$ref":"#/definitions/customerOwnReference"},"segmentStatus":{"$ref":"#/definitions/segmentStatus"},"segmentPmsStatus":{"$ref":"#/definitions/segmentPmsStatus"},"actionStatus":{"$ref":"#/definitions/actionStatus"},"segmentHolderId":{"$ref":"#/definitions/segmentHolderId"},"bookerId":{"$ref":"#/definitions/bookerId"},"purchaseOrderReference":{"$ref":"#/definitions/purchaseOrderReference"},"propertyCurrency":{"$ref":"#/definitions/currency"},"lastUpdateDateTime":{"$ref":"#/definitions/lastUpdateDateTime"},"lastUpdateDateTimeHotelLocalTime":{"$ref":"#/definitions/lastUpdateDateTimeHotelLocalTime"},"indicators":{"$ref":"#/definitions/historyIndicatorsRes"},"option":{"$ref":"#/definitions/option"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"creator":{"description":"Contains the details of the channel which created the segment","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"offer":{"$ref":"#/definitions/historyOfferRes"},"formOfPayment":{"$ref":"#/definitions/historyFormOfPaymentRes"},"taxDefinitions":{"type":"array","description":"The applicable rules of taxes for each tax change of the segment","items":{"$ref":"#/definitions/taxDefinition"}},"travelPurpose":{"$ref":"#/definitions/travelPurpose"},"owner":{"description":"Agency which owns the segment. This is the agency whose IATA number is used for guarantee, and also the agency who is commissioned for the segment.","$ref":"#/definitions/reservationOwner"},"corporateAccountInfo":{"$ref":"#/definitions/corporateAccountInfoRes"},"comments":{"$ref":"#/definitions/comments"},"specialRequests":{"type":"array","description":"List the special requests","items":{"$ref":"#/definitions/specialRequests"}},"serviceRequests":{"type":"array","description":"List the service requests","items":{"$ref":"#/definitions/serviceRequests"}},"traces":{"type":"array","description":"Traces allow to generate tasks that require fulfillment, which can be associated to a particular department. e.g. \"Review deposits\"","minItems":1,"maxItems":100,"items":{"$ref":"#/definitions/traces"}},"alerts":{"type":"array","description":"Alerts are PMS functionality which can be pre-configured. They include screen and printer notification. e.g. \"VIP guest\"","minItems":1,"maxItems":100,"items":{"$ref":"#/definitions/alerts"}},"arrivalTime":{"$ref":"#/definitions/arrivalTime"},"departureTime":{"$ref":"#/definitions/departureTime"},"arrivalTransport":{"$ref":"#/definitions/transportation"},"departureTransport":{"$ref":"#/definitions/transportation"},"arrivalAmenities":{"type":"array","description":"List of loyalty arrival amenity codes selected by the loyalty guest","maxItems":50,"items":{"$ref":"#/definitions/ArrivalAmenity"}},"cancellationReasons":{"type":"array","items":{"$ref":"#/definitions/cancellationReason"}}}}},"historyIndicatorsRes":{"description":"How the segment was booked. Example by Force Sell, Rate Override... ,","type":"object","properties":{"isForcedSell":{"$ref":"#/definitions/isForcedSell"},"isWaitlist":{"$ref":"#/definitions/isWaitlist"},"isTentative":{"$ref":"#/definitions/isTentative"},"isCancelledAfterDeadline":{"$ref":"#/definitions/isCancelledAfterDeadline"},"hasRateOverride":{"$ref":"#/definitions/hasRateOverride"},"isRateOverrideWithinThreshold":{"$ref":"#/definitions/isRateOverrideWithinThreshold"},"hasForcedInventoryAvailability":{"$ref":"#/definitions/hasForcedInventoryAvailability"},"hasForcedRestrictions":{"$ref":"#/definitions/hasForcedRestrictions"}}},"modificationChanges":{"description":"List of changes following a successful modification request","type":"array","items":{"type":"object","title":"modificationChange","required":["op","path"],"properties":{"op":{"description":"Operation used for the change","type":"string","enum":["upsert","append","remove"]},"path":{"description":"Path used for the change","type":"string"},"value":{"description":"The json structure (not a string, i.e. without opening and closing quotes) to be inserted at the specified path"}}}},"linkModificationChanges":{"description":"List of changes following a successful modification request","type":"array","items":{"type":"object","title":"linkModificationChange","required":["op","value"],"properties":{"op":{"description":"Operation used for the change","type":"string","enum":["Link","Unlink"]},"value":{"description":"List of cfNumbers","type":"array","items":{"type":"string","properties":{"cfNumber":{"$ref":"#/definitions/cfNumber"}}}}}}},"ReservationModifyRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"dataModifyRes","properties":{"denials":{"description":"Request denial details","$ref":"#/definitions/denial"},"creator":{"description":"Contains the details of the channel which created the reservation","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"hotelReservation":{"$ref":"#/definitions/HotelReservationRes"},"modificationChanges":{"$ref":"#/definitions/modificationChanges"}}}}},"ReservationModifyPendingRes":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"type":"object","title":"dataModifyPendingRes","properties":{"denials":{"description":"Request denial details","$ref":"#/definitions/denial"},"creator":{"description":"Contains the details of the channel which created the reservation","$ref":"#/definitions/pointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/pointOfSale"},"hotelReservation":{"$ref":"#/definitions/HotelReservationPendingRes"},"modificationChanges":{"$ref":"#/definitions/modificationChanges"}}}}},"ReservationPartialModifyReq":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/definitions/modificationChanges"}}},"LinkReservationModifyReq":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/definitions/linkModificationChanges"}}},"ReservationSearchReq":{"type":"object","required":["data"],"properties":{"data":{"description":"Search reservation request","type":"object","title":"hotelReservationSearch","properties":{"agencyIdentifiers":{"$ref":"#/definitions/agencyIdentifiers"},"agencyName":{"description":"Name of the agency. For inputs, the service searches for reservations with agency name's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of agency name. Single character excluding wildcard expression (*), is not supported in the input","type":"string"},"arrivalDate":{"description":"Date range of arrival date","$ref":"#/definitions/searchPeriod"},"assignedRoom":{"description":"Assigned room code or name","type":"string","pattern":"[A-Za-z0-9]{1,50}","minLength":1,"maxLength":50},"bookerFirstName":{"description":"First name of the booker. If used, the bookerLastName is mandatory. For inputs, the service searches for reservations with booker first name's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of booker first name. Single character excluding wildcard expression (*), is not supported in the input","type":"string"},"bookerLastName":{"description":"Last name of the booker. For inputs, the service searches for reservations with booker last name's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of booker last name. Single character excluding wildcard expression (*), is not supported in the input","type":"string"},"cardNumber":{"description":"Last 4 digits of the tokenized credit card number associated to reservations' form of payment","type":"string","maxLength":4},"cdNumber":{"description":"Corporate discount Number entered for reservation","type":"string","pattern":"[A-Za-z0-9]{1,20}","minLength":1,"maxLength":20},"cfNumber":{"description":"It is the Confirmation number which the guest receives. It searches for CRS confirmation number but also into the external confirmation numbers stored in the reservation.","type":"string","minLength":1,"maxLength":50},"corporateAccountName":{"description":"Name of the corporate account. For inputs, the service searches for reservations with corporate account name's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of corporate account name. Single character excluding wildcard expression (*), is not supported in the input","type":"string","minLength":1,"maxLength":35},"creationDate":{"description":"Date range of creation","$ref":"#/definitions/searchPeriod"},"cxNumber":{"description":"Cancellation Number. It is the cancellation number which is received by the guest. It searches for CRS cancellation number but also into the external cancellation numbers stored in the reservation.","type":"string","minLength":1,"maxLength":50},"departureDate":{"description":"Date range of departure date (reservation end date).","$ref":"#/definitions/searchPeriod"},"firstName":{"description":"First name of the guest. If used, the \"lastName\" is mandatory. For inputs, the service searches for reservations with guest first name's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of first name. Single character excluding wildcard expression (*), is not supported in the input","type":"string","minLength":1,"maxLength":56},"groupCode":{"description":"It is the identifier code of a reservation. For inputs, the service searches for reservations with group code's starting with, ending with or containing characters using wildcard expression (ST*, *EN, *CO*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of group code. Single character excluding wildcard expression (*), is not supported in the input","type":"string","minLength":3,"maxLength":51},"groupContractSaleStatus":{"description":"Sale status of the reservation contract","enum":["prospect","definite","tentative"],"type":"string"},"groupName":{"description":"It is a name of a group","type":"string"},"guaranteeRequired":{"description":"Indicates if guarantee is required or not. Searches reservations requiring guarantee. If true, output is reservations with guarantee required, else not.","type":"boolean"},"hideNoShow":{"description":"Exclude no-show status reservations","type":"boolean","default":false},"isCommissionable":{"description":"Indicates if this rate is commissionable or not","type":"boolean"},"lastName":{"description":"Last name of the guest. For inputs, the service searches for reservations with guest first name's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of last name. Single character excluding wildcard expression (*), is not supported in the input","type":"string","minLength":1,"maxLength":57},"loyaltyId":{"description":"Loyalty identifier of the reservation holder, mandatory if hotelCode is not present in the request","type":"string","pattern":"[A-Za-z0-9]{1,28}","minLength":1,"maxLength":28},"paymentType":{"description":"Payment type based on OTA_CodeList PMT. (1-Cash, 2-Direct Bill, 3-Voucher, 5-Credit Card, 7-Check, 19-IATA Number, 30-Corporate Discount Number, 44-Guarantee to Property, 46-Online Payment, 47-Pay by Points, 48-Pay by EFT Electronic Funds Transfer) = ['1', '2', '3', '5', '7', '19', '30', '44', '46', '47', '48']","enum":[1,2,3,5,7,19,30,44,46,47,48],"type":"integer"},"inventoryTypeCode":{"$ref":"#/definitions/inventoryTypeCode"},"priceGridCode":{"description":"Price grid code linked to the reservation.","type":"string","pattern":"[A-Z0-9]{1,16}","minLength":1,"maxLength":16},"propertyCode":{"description":"list of property codes","type":"array","items":{"$ref":"#/definitions/propertyCode"}},"promoCodes":{"description":"Promotion code linked to the reservation.","type":"array","items":{"$ref":"#/definitions/promoCode"},"maxItems":10},"promoGroupCodes":{"description":"Promotion Group code linked to the reservation promotion code.","type":"array","items":{"$ref":"#/definitions/promoGroupCode"},"maxItems":10},"ratePlanCode":{"description":"Rate plan of the reservation. For inputs, the service searches for reservations with rate plan code's starting with, ending with or containing characters using wildcard expression (STA*, *END, *CONT*). For inputs where wildcard expression (*) is not used, the service searches for reservations with exact match of rate plan code. Single character excluding wildcard expression (*), is not supported in the input","$ref":"#/definitions/ratePlanCode"},"segmentPmsStatus":{"description":"Segment status on PMS side","type":"array","items":{"type":"string","enum":["In-house","Checked out","No-show","Waitlisted","Pre-Checkin"]}},"reservationStatus":{"description":"Status of the reservations expected in result booked (BK), modified (MY) or cancelled (CL)","type":"array","items":{"$ref":"#/definitions/resStatus"}},"reservationTypes":{"description":"Parameter used to specify which reservationType the user wants to search for. The value \"Individual\" also includes the reservation without a reservationType.","type":"array","default":["Individual"],"items":{"type":"string","enum":["GroupMaster","Individual"]}},"retrieveMode":{"description":"Type of result expected for the search, displayList to return the list of reservations, checkOneFound to check if at least one reservation matches the criteria.","enum":["displayList","checkOneFound"],"type":"string"},"stayDate":{"description":"Date situated within the stay period, between reservationStartDate (included) and reservationEndDate (excluded)","$ref":"#/definitions/searchPeriod"},"vendorCode":{"description":"vendor code","$ref":"#/definitions/vendorCode"},"reportingData":{"$ref":"#/definitions/reportingData"},"corpMarketSegment":{"description":"Corporate market segment, e.g. GOVERNMENT, CORPORATE, LEISURE etc.","$ref":"#/definitions/corporateMarketSegment"},"includePseudoPropertyReservations":{"description":"When set to true, search returns all the reservations tagged to both pseudo and master property code. By default, only reservations related to master property code will be returned with master property code in input.","type":"boolean","default":false},"includeSharedReservations":{"description":"When set to true, returns all the reservations part of the share of the matching reservations.","type":"boolean","default":false},"includeJointReservations":{"description":"When set to true, returns all the reservations part of the link of type joint of the matching reservations.","type":"boolean","default":false},"links":{"description":"list of linkId that could be of type joint or share","type":"array","items":{"$ref":"#/definitions/reservationLinkId"},"maxItems":50},"externalShareId":{"$ref":"#/definitions/externalShareId"}}}}},"foundReservation":{"description":"Returned in case retrieve_mode in request is set to checkOneFound. It is true if at least one reservation matching the criteria is found, false otherwise.","type":"boolean"},"reservationCount":{"description":"Total number of reservations in the search response","type":"integer"},"holdTime":{"description":"Hold time limit (i.e '18:00'), filled if consolidatedRoomStayStatus = 'NonGuaranteedHold',","type":"string"},"isAccessibleByWeb":{"description":"Indicates if the reservation is available through website","type":"boolean"},"matchedSearchCriteria":{"description":"Indicates if the segment matched the input criteria","type":"boolean"},"CancellationReq":{"type":"object","properties":{"data":{"title":"cancelReq","properties":{"cancellationReasons":{"type":"array","items":{"$ref":"#/definitions/cancellationReason"}},"extCxNumber":{"$ref":"#/definitions/extCxNumber"},"pmsCxNumber":{"$ref":"#/definitions/pmsCxNumber"}}}}},"cancellationReason":{"type":"object","description":"Reason of the reservation or segment cancellation","properties":{"code":{"description":"Code of the cancellation reason","type":"string","maxLength":30},"description":{"description":"Description of the cancellation reason","$ref":"#/definitions/description"},"others":{"description":"Exceptional cancellation reason","$ref":"#/definitions/description"},"waiveFees":{"description":"Flag to waive the cancellation fees","type":"boolean"}}},"code":{"description":"Group of products for which an allowance is booked","type":"string","pattern":"[A-Z0-9]{2,8}","minLength":2,"maxLength":8},"guaranteeRes-postSearchReservations":{"description":"Payment policies for the guarantee","type":"object","required":["isRequired"],"properties":{"isRequired":{"$ref":"#/definitions/isRequired"}},"title":"guaranteeRes-postSearchReservations"},"policiesRes-postSearchReservations":{"description":"Element containing all the policies regarding guarantee, deposit, cancellation, no-show and early check-out","type":"object","properties":{"guarantee":{"description":"Payment policies for the guarantee","$ref":"#/definitions/guaranteeRes-postSearchReservations"}},"title":"policiesRes-postSearchReservations"},"offerSearchRes-postSearchReservations":{"type":"object","description":"offer","required":["productUses"],"properties":{"groupCode":{"$ref":"#/definitions/groupCode"},"productUses":{"$ref":"#/definitions/productUseSearchRes"},"groupId":{"$ref":"#/definitions/groupId"},"propertyMarketSegment":{"$ref":"#/definitions/propertyMarketSegment"},"nightlyCorpMarketSegments":{"description":"List of corporate market segments applicable for each night of the stay.","type":"array","items":{"$ref":"#/definitions/nightlyCorporateMarketSegment"}},"corpMarketSegment":{"$ref":"#/definitions/corporateMarketSegment"},"policies":{"$ref":"#/definitions/policiesRes-postSearchReservations"},"policyTypeCode":{"$ref":"#/definitions/policyTypeCode"},"promoCode":{"$ref":"#/definitions/promoCode"},"promoGroupCode":{"$ref":"#/definitions/promoGroupCode"},"isPerpetualOffer":{"$ref":"#/definitions/isPerpetualOffer"},"rateAccessCode":{"$ref":"#/definitions/rateAccessCode"}},"title":"offerSearchRes-postSearchReservations"},"segmentSearchRes-postSearchReservations":{"description":"List of segments","type":"array","items":{"type":"object","title":"segment","required":["id","matchedSearchCriteria","segmentStatus","start","end","synchroNumber","consolidatedSegmentStatus","hasAddOns","propertyCode","checkInRate","offer"],"properties":{"id":{"type":"integer","description":"Identify the segment inside the reservation all along the reservation life."},"matchedSearchCriteria":{"$ref":"#/definitions/matchedSearchCriteria"},"start":{"description":"Start date","type":"string","format":"date"},"end":{"description":"End date","type":"string","format":"date"},"synchroNumber":{"$ref":"#/definitions/synchroNumber"},"segmentStatus":{"$ref":"#/definitions/segmentStatus"},"consolidatedSegmentStatus":{"$ref":"#/definitions/consolidatedSegmentStatus"},"holdTime":{"$ref":"#/definitions/holdTime"},"segmentPmsStatus":{"$ref":"#/definitions/segmentPmsStatus"},"segmentHolderId":{"$ref":"#/definitions/segmentHolderId"},"bookerId":{"$ref":"#/definitions/bookerId"},"hasAddOns":{"$ref":"#/definitions/hasAddOns"},"indicators":{"$ref":"#/definitions/indicatorsSearchRes"},"parentId":{"$ref":"#/definitions/parentId"},"creationDateTime":{"$ref":"#/definitions/createDateTime"},"creationDateTimeHotelLocalTime":{"$ref":"#/definitions/createDateTimeHotelLocalTime"},"option":{"$ref":"#/definitions/option"},"propertyCode":{"$ref":"#/definitions/propertyCode"},"creator":{"description":"Contains the details of the channel which created the segment","$ref":"#/definitions/searchPointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/searchPointOfSale"},"owner":{"description":"Agency which owns the segment. This is the agency whose IATA number is used for guarantee, and also the agency who is commissioned for the segment.","$ref":"#/definitions/searchReservationOwner"},"areAmountsConfidential":{"description":"Indicates if amounts defined in the rate plan are confidential","type":"boolean","default":false},"isAccessibleByWeb":{"$ref":"#/definitions/isAccessibleByWeb"},"checkInRate":{"description":"Daily check in rate","type":"string"},"offer":{"$ref":"#/definitions/offerSearchRes-postSearchReservations"},"formOfPayment":{"$ref":"#/definitions/formOfPaymentSearchRes"},"travelPurpose":{"$ref":"#/definitions/travelPurpose"},"cancellationReasons":{"type":"array","items":{"$ref":"#/definitions/cancellationReason","description":"Details about cancellation reasons"}},"corporateAccountInfo":{"type":"array","maxItems":2,"description":"List of corporate accounts (up to 2 from different sources)","items":{"$ref":"#/definitions/corporateAccountInfoSearchRes"}}}},"title":"segmentSearchRes-postSearchReservations"},"ratePlanCommon-postSearchReservations":{"type":"object","required":["code"],"properties":{"code":{"$ref":"#/definitions/ratePlanCode"},"types":{"description":"List of rate plan type (OTA codes as per RPT OTA list)","$ref":"#/definitions/ratePlanTypes"},"name":{"description":"Name of the rate plan.","$ref":"#/definitions/DescriptionOfRatePlanAndInventoryType"},"description":{"description":"Short description of the rate plan.","$ref":"#/definitions/DescriptionOfRatePlanAndInventoryType"},"longDescription":{"description":"Long description of the rate plan.","$ref":"#/definitions/description"}},"title":"ratePlanCommon-postSearchReservations"},"ratePlanRes-postSearchReservations":{"type":"object","allOf":[{"$ref":"#/definitions/ratePlanCommon-postSearchReservations"},{"type":"object","properties":{"isCommissionable":{"description":"Indicates if this rate is commissionable or not","type":"boolean"}}}],"title":"ratePlanRes-postSearchReservations"},"HotelReservationSearchRes-postSearchReservations":{"type":"object","title":"HotelReservationSearchRes-postSearchReservations","required":["status","reservationIds","hotels","userProfiles","segments","products"],"properties":{"status":{"$ref":"#/definitions/resStatus"},"type":{"$ref":"#/definitions/reservationType"},"reservationIds":{"$ref":"#/definitions/reservationIdsSearchRes"},"creator":{"description":"Contains the details of the channel which created the reservation","$ref":"#/definitions/searchPointOfSale"},"requestor":{"description":"Contains the details of the channel which requested the transaction","$ref":"#/definitions/searchPointOfSale"},"creationDateTime":{"$ref":"#/definitions/createDateTime"},"links":{"description":"Link reservation details.","type":"array","items":{"$ref":"#/definitions/reservationLinks"}},"groupContracts":{"description":"List of groupContract","type":"array","maxItems":99,"items":{"$ref":"#/definitions/groupContractRes"}},"installments":{"description":"Deposit rule details","type":"array","maxItems":3,"items":{"$ref":"#/definitions/installment"}},"hotels":{"description":"List of hotels","type":"array","items":{"$ref":"#/definitions/hotelSearchRes"}},"userProfiles":{"$ref":"#/definitions/guestsSearchRes"},"segments":{"$ref":"#/definitions/segmentSearchRes-postSearchReservations"},"products":{"description":"List of products","type":"array","items":{"$ref":"#/definitions/product"}},"ratePlans":{"description":"List of rate plans used in the reservation","type":"array","items":{"$ref":"#/definitions/ratePlanRes-postSearchReservations"}}}},"ReservationSearchRes-postSearchReservations":{"type":"object","required":["data"],"properties":{"warnings":{"type":"array","items":{"$ref":"#/definitions/warning"}},"data":{"description":"Search reservation response","type":"object","title":"dataSearchRes","properties":{"foundReservation":{"$ref":"#/definitions/foundReservation"},"reservationCount":{"$ref":"#/definitions/reservationCount"},"hotelReservations":{"description":"List of reservations matching the search criteria. Returned in case retrieve_mode in request is set to displayList.","type":"array","items":{"$ref":"#/definitions/HotelReservationSearchRes-postSearchReservations"}}}}},"title":"ReservationSearchRes-postSearchReservations"}},"responses":{"400":{"description":"Bad Request - Client sent a request that is not conforming to API. Client has to modify the request so that it passes. Most of functional error responses fall under this category.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n15      | Invalid max modification date in query\n41      | Occupancy must include an adult\n12115   | Different loyalty Ids requested for the same segment.\n","schema":{"$ref":"#/definitions/responseError_400"}},"401":{"description":"Unauthorized - The request requires user authentication.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n71      | Wrong authentication credentials\n12222   | Missing authentication information: the credit card authentication failed\n","schema":{"$ref":"#/definitions/responseError_401"}},"403":{"description":"Forbidden - Server refuses to fulfil request for functional or security reasons. If it is for security reasons, the authentication will not solve the issue.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n13011   | There is no pending image to be committed\n14010   | You are not allowed to use 2-step services\n15042   | The purge date must be set to at most 4 years after the checkout date\n","schema":{"$ref":"#/definitions/responseError_403"}},"404":{"description":"Not Found - Client requested resource that does not exist.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n97      | No reservation available for the input cancellation number\n161     | Search criteria invalid: No image available for the input image id\n12610   | Segments [X,X] not found in reservation\n","schema":{"$ref":"#/definitions/responseError_404"}},"406":{"description":"Not Acceptable - Client requested resource does not support requested method or requested version.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n172     | Requested version not supported [ X.X ]. Please use one of the following : X.X / X.X\n","schema":{"$ref":"#/definitions/responseError_406"}},"429":{"description":"Too Many Requests - The network rate limit is exceeded or The quota limit is exceeded.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n38194   | Too many requests\n38195   | Quota limit exceeded\n","schema":{"$ref":"#/definitions/responseError_429"}},"500":{"description":"Internal Server Error - Server was unable to process request due to unexpected problem that can't be corrected by client. This error is not used to describe functional problems.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n448     | System error\n450     | Unable to process\n","schema":{"$ref":"#/definitions/responseError_500"}},"504":{"description":"Gateway Timeout - This status code is returned by the Enterprise Service Bus in case of timeout on backend side.\n\nExamples of functional error codes (not exhaustive list):\n\ncode    | title\n------- | -------------------\n15345   | ESPINV RTO occurred\n15346   | ESPINV Message too old\n","schema":{"$ref":"#/definitions/responseError_504"}},"reservationResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ReservationRes"}},"reservationCreatePendingResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ReservationPendingRes"}},"reservationModifyResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ReservationModifyRes"}},"reservationModifyPendingResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ReservationModifyPendingRes"}},"reservationRetrieveResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ReservationRetrieveRes"}},"linkReservationResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/LinkReservationRes"}},"linkReservationRetrieveResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/LinkReservationRetrieveRes"}},"shareReservationSynchronizeResponse":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ShareReservationSynchronizeRes"}},"reservationSearchResponse-postSearchReservations":{"description":"Successful operation.","schema":{"$ref":"#/definitions/ReservationSearchRes-postSearchReservations"}}}}