{"items":[{"type":"link","label":"TripServices Stays","link":"/apis/stays","routeSlug":"/apis/stays","content":{"contentType":"overview","meta":{"name":"TripServices Stays"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"TripServices Stays (11.35.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TripServices Stay v11 APIs are a robust, flexible set of RESTful JSON endpoints that empower developers to build seamless, beautiful hotel booking experiences with global reach and real-time data. Built for developers, our APIs are designed to integrate easily into your applications, enabling you to build rich, responsive hotel booking interfaces tailored to your users. For information on how Travelport uses polymorphism in our APIs please see documentation available. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/best-practice-polymorphism"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Polymorphism guide"},"children":[]}]}]}]}]}],"sectionId":"/apis/stays"}],"sectionId":"/apis/stays"}]}]}},{"type":"group","label":"Search and Details","link":"/apis/stays/search-and-details","routeSlug":"/apis/stays/search-and-details","items":[{"label":"Return hotel details.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/search-and-details/getpropertiesdetail","routeSlug":"/apis/stays/search-and-details/getpropertiesdetail","metadata":{"seo":{"title":"Return hotel details.","description":"The Hotel Details request retrieves, for a specified property, a additional property-level information such as description and images provided by the supplier. It is an optional request and does not need to be preceded by a Hotel Search request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPropertiesDetail","name":"Return hotel details.","isWebhook":false,"pointer":"/paths/~1hotel~1search~1propertiesdetail/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return hotel details.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Hotel Details request retrieves, for a specified property, a additional property-level information such as description and images provided by the supplier. It is an optional request and does not need to be preceded by a Hotel Search request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"chainCode","in":"query","schemaId":"schema_491","description":"The chain code of the requested property.","required":true,"example":"HL"},{"name":"propertyCode","in":"query","schemaId":"schema_492","description":"The property code of the requested property (typically 5 characters).","required":true},{"name":"ImageSize","in":"query","schemaId":"schema_493","description":"The size of the images to return."}],"pointer":"/paths/~1hotel~1search~1propertiesdetail/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1search~1propertiesdetail/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hotel/search/propertiesdetail","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"chainCode","in":"query","required":true,"example":"HL","schemaId":"schema_491"},{"name":"propertyCode","in":"query","required":true,"schemaId":"schema_492"},{"name":"ImageSize","in":"query","required":false,"example":"Small","schemaId":"components/schemas/ImageSizeEnum"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/search/propertiesdetail","href":"search-and-details/getpropertiesdetail","openApiOperationId":"GetPropertiesDetail","summary":"Return hotel details."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}},"schemaId":"components/schemas/PropertiesResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1search~1propertiesdetail/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PropertiesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-details/getpropertiesdetail"}],"panels":[]}]},"httpPath":"/hotel/search/propertiesdetail"},{"label":"Search hotels by location.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/search-and-details/searchbylocation","routeSlug":"/apis/stays/search-and-details/searchbylocation","metadata":{"seo":{"title":"Search hotels by location.","description":"The Search by Location request searches for hotels by any one of these: 1) geographic coordinates, 2) address, 3) IATA airport code, or 4) IATA city code. Although you can search by various criteria, all responses return results in the same format. The response returns up to 100 properties, or all available properties if less than 100. If more than 100 properties matching the search criteria are available, you can request the next page of results with the Search Pagination API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SearchByLocation","name":"Search hotels by location.","isWebhook":false,"pointer":"/paths/~1hotel~1search~1properties~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search hotels by location.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Search by Location request searches for hotels by any one of these: 1) geographic coordinates, 2) address, 3) IATA airport code, or 4) IATA city code. Although you can search by various criteria, all responses return results in the same format. The response returns up to 100 properties, or all available properties if less than 100. If more than 100 properties matching the search criteria are available, you can request the next page of results with the Search Pagination API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1search~1properties~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertiesQuerySearchWrapper","exampleIds":["paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs"]}},"schemaId":"components/schemas/PropertiesQuerySearchWrapper","exampleIds":["paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs"],"pointer":"/paths/~1hotel~1search~1properties~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/search/properties/search","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PropertiesQuerySearchWrapper","exampleIds":["paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs"]}},"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/search/properties/search","href":"search-and-details/searchbylocation","openApiOperationId":"SearchByLocation","summary":"Search hotels by location."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/PropertiesQuerySearchWrapper","exampleIds":["paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertiesQuerySearchWrapper","exampleIds":["paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city","paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}},"schemaId":"components/schemas/PropertiesResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1search~1properties~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PropertiesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-details/searchbylocation"}],"panels":[]}]},"httpPath":"/hotel/search/properties/search"},{"label":"Search hotels by property ID.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/search-and-details/create","routeSlug":"/apis/stays/search-and-details/create","metadata":{"seo":{"title":"Search hotels by property ID.","description":"The Search by ID request searches for specific hotels by their property ID. You can send up to 250 property IDs. The response returns a list of properties based on the ID/s sent. The Search by ID response format is the same as for Search by Location. The response returns up to 100 properties, or all requested properties if less than 100. If more than 100 properties were requested and are available, you can request the next page with the Search Pagination API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create","name":"Search hotels by property ID.","isWebhook":false,"pointer":"/paths/~1hotel~1search~1properties/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search hotels by property ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Search by ID request searches for specific hotels by their property ID. You can send up to 250 property IDs. The response returns a list of properties based on the ID/s sent. The Search by ID response format is the same as for Search by Location. The response returns up to 100 properties, or all requested properties if less than 100. If more than 100 properties were requested and are available, you can request the next page with the Search Pagination API."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1search~1properties/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertiesQuerySpecificPropertyListWrapper","exampleIds":["paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id","paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs"]}},"schemaId":"components/schemas/PropertiesQuerySpecificPropertyListWrapper","exampleIds":["paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id","paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs"],"pointer":"/paths/~1hotel~1search~1properties/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/search/properties","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PropertiesQuerySpecificPropertyListWrapper","exampleIds":["paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id","paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs"]}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/search/properties","href":"search-and-details/create","openApiOperationId":"Create","summary":"Search hotels by property ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/PropertiesQuerySpecificPropertyListWrapper","exampleIds":["paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id","paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertiesQuerySpecificPropertyListWrapper","exampleIds":["paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id","paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}},"schemaId":"components/schemas/PropertiesResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}},"schemaId":"components/schemas/PropertiesResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1search~1properties/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PropertiesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/PropertiesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-details/create"}],"panels":[]}]},"httpPath":"/hotel/search/properties"},{"label":"Return additional search results (pagination).","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/search-and-details/getpropertiespage","routeSlug":"/apis/stays/search-and-details/getpropertiespage","metadata":{"seo":{"title":"Return additional search results (pagination).","description":"Return additional search results. The v11 hotel search APIs (Search by Location and Search by ID) use pagination by default. Search responses return up to 100 properties in the initial response, or all available properties if fewer than 100. The search response notes the total number of properties found and includes an identifier to be used for retrieving additional pages. If the search response indicates that more than 100 properties are available, you can use this Search Pagination request to retrieve each additional page of 100 properties until all available properties have been retrieved."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPropertiesPage","name":"Return additional search results (pagination).","isWebhook":false,"pointer":"/paths/~1hotel~1search~1properties~1{identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return additional search results (pagination).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return additional search results. The v11 hotel search APIs (Search by Location and Search by ID) use pagination by default. Search responses return up to 100 properties in the initial response, or all available properties if fewer than 100. The search response notes the total number of properties found and includes an identifier to be used for retrieving additional pages. If the search response indicates that more than 100 properties are available, you can use this Search Pagination request to retrieve each additional page of 100 properties until all available properties have been retrieved."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_498","description":"The Identifier of the Properties from which a page is to be returned","required":true}],"pointer":"/paths/~1hotel~1search~1properties~1{identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_499","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number of the page of results to retrieve (e.g., second page is pageNumber=2, etc.). The Search by ID or Search by Location response returns page 1, so values here should be between 2 and 5 inclusive. You are not required to retrieve pages consecutively."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hotel~1search~1properties~1{identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1search~1properties~1{identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hotel/search/properties/{identifier}","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_499"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/search/properties/{identifier}","href":"search-and-details/getpropertiespage","openApiOperationId":"GetPropertiesPage","summary":"Return additional search results (pagination)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}},"schemaId":"components/schemas/PropertiesResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1search~1properties~1{identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PropertiesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertiesResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search-and-details/getpropertiespage"}],"panels":[]}]},"httpPath":"/hotel/search/properties/{identifier}"}],"content":{"contentType":"group","meta":{"name":"Search and Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search and Details","showPageActions":true},{"nodeType":"markdoc","content":"Hotel searches."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hotel/search/propertiesdetail","summary":"Return hotel details.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-details/getpropertiesdetail","deprecated":false},{"title":"/hotel/search/properties/search","summary":"Search hotels by location.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search-and-details/searchbylocation","deprecated":false},{"title":"/hotel/search/properties","summary":"Search hotels by property ID.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search-and-details/create","deprecated":false},{"title":"/hotel/search/properties/{identifier}","summary":"Return additional search results (pagination).","prefix":{"name":"get","color":"get"},"badges":[],"link":"/search-and-details/getpropertiespage","deprecated":false}]}]}]}]}},{"type":"group","label":"Availability","link":"/apis/stays/availability","routeSlug":"/apis/stays/availability","items":[{"label":"Return hotel availability.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/availability/createhotelavailability","routeSlug":"/apis/stays/availability/createhotelavailability","metadata":{"seo":{"title":"Return hotel availability.","description":"Hotel Availability returns room types and rates available at one or more specified properties on specified dates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateHotelAvailability","name":"Return hotel availability.","isWebhook":false,"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return hotel availability.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Hotel Availability returns room types and rates available at one or more specified properties on specified dates."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper","exampleIds":["paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability","paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC"]}},"schemaId":"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper","exampleIds":["paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability","paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC"],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/availability/catalogofferingshospitality","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper","exampleIds":["paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability","paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC"]}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/availability/catalogofferingshospitality","href":"availability/createhotelavailability","openApiOperationId":"CreateHotelAvailability","summary":"Return hotel availability."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper","exampleIds":["paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability","paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper","exampleIds":["paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability","paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/availability/createhotelavailability"}],"panels":[]}]},"httpPath":"/hotel/availability/catalogofferingshospitality"},{"label":"Return additional availability results (pagination).","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/availability/gethotelavailabilitypage","routeSlug":"/apis/stays/availability/gethotelavailabilitypage","metadata":{"seo":{"title":"Return additional availability results (pagination).","description":"Return additional availability results. The Hotel Availability response uses pagination by default. The response notes the total number of rates found and, if greater than 100, also returns a pagination identifier that can be used for retrieving additional pages of results using this Availability Pagination request. You can send an Availability Pagination request to retrieve each additional page of 100 rates until all available rates have been retrieved. NOTE: Availability results are cached for 30 minutes. You cannot retrieve additional results from that Availability response after it expires."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetHotelAvailabilityPage","name":"Return additional availability results (pagination).","isWebhook":false,"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality~1{identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return additional availability results (pagination).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return additional availability results. The Hotel Availability response uses pagination by default. The response notes the total number of rates found and, if greater than 100, also returns a pagination identifier that can be used for retrieving additional pages of results using this Availability Pagination request. You can send an Availability Pagination request to retrieve each additional page of 100 rates until all available rates have been retrieved. NOTE: Availability results are cached for 30 minutes. You cannot retrieve additional results from that Availability response after it expires."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identifier","in":"path","schemaId":"schema_498","description":"The Identifier of the CatalogOfferings from which a page is to be returned","required":true}],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality~1{identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageNumber","in":"query","schemaId":"schema_499","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page number of the page of availability results to retrieve (e.g., second page is pageNumber=2, etc.). The Availability response returns page 1, so values here should be between 2 and 5 inclusive. You are not required to retrieve pages consecutively."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality~1{identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_500","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality~1{identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hotel/availability/catalogofferingshospitality/{identifier}","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"identifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"pageNumber","in":"query","required":true,"schemaId":"schema_499"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_500","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/availability/catalogofferingshospitality/{identifier}","href":"availability/gethotelavailabilitypage","openApiOperationId":"GetHotelAvailabilityPage","summary":"Return additional availability results (pagination)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1availability~1catalogofferingshospitality~1{identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsHospitalityResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/availability/gethotelavailabilitypage"}],"panels":[]}]},"httpPath":"/hotel/availability/catalogofferingshospitality/{identifier}"}],"content":{"contentType":"group","meta":{"name":"Availability"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Availability","showPageActions":true},{"nodeType":"markdoc","content":"Hotel availability and pagination."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hotel/availability/catalogofferingshospitality","summary":"Return hotel availability.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/availability/createhotelavailability","deprecated":false},{"title":"/hotel/availability/catalogofferingshospitality/{identifier}","summary":"Return additional availability results (pagination).","prefix":{"name":"get","color":"get"},"badges":[],"link":"/availability/gethotelavailabilitypage","deprecated":false}]}]}]}]}},{"type":"group","label":"Rules","link":"/apis/stays/rules","routeSlug":"/apis/stays/rules","items":[{"label":"Return hotel rules (reference payload).","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/rules/buildhotelrulesfromcatalogoffering","routeSlug":"/apis/stays/rules/buildhotelrulesfromcatalogoffering","metadata":{"seo":{"title":"Return hotel rules (reference payload).","description":"Available January 2023. Hotel Rules retrieves the rules associated with a specific rate. The reference payload references an offer by sending the unique offer ID from an Availability response, instead of sending all required offer details as in the full payload Rules request. The response for both the reference and full payload is the same."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildHotelRulesFromCatalogOffering","name":"Return hotel rules (reference payload).","isWebhook":false,"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return hotel rules (reference payload).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Available January 2023. Hotel Rules retrieves the rules associated with a specific rate. The reference payload references an offer by sending the unique offer ID from an Availability response, instead of sending all required offer details as in the full payload Rules request. The response for both the reference and full payload is the same."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload"]}},"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload"],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/rules/offershospitality/buildfromcatalogoffering","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload"]}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/rules/offershospitality/buildfromcatalogoffering","href":"rules/buildhotelrulesfromcatalogoffering","openApiOperationId":"BuildHotelRulesFromCatalogOffering","summary":"Return hotel rules (reference payload)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}},"schemaId":"components/schemas/OfferHospitalityResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}},"schemaId":"components/schemas/OfferHospitalityResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/buildhotelrulesfromcatalogoffering"}],"panels":[]}]},"httpPath":"/hotel/rules/offershospitality/buildfromcatalogoffering"},{"label":"Return hotel rules (full payload).","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/rules/createhotelrules","routeSlug":"/apis/stays/rules/createhotelrules","metadata":{"seo":{"title":"Return hotel rules (full payload).","description":"Hotel Rules retrieves the rules associated with a specific rate. The full payload request in this topic sends all required rate details, while the reference payload Rules request references rate details from a previous Availability response by sending the offer ID from that response. The response for both the reference and full payload is the same."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateHotelRules","name":"Return hotel rules (full payload).","isWebhook":false,"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return hotel rules (full payload).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Hotel Rules retrieves the rules associated with a specific rate. The full payload request in this topic sends all required rate details, while the reference payload Rules request references rate details from a previous Availability response by sending the offer ID from that response. The response for both the reference and full payload is the same."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryHospitalityRequestWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload"]}},"schemaId":"components/schemas/OfferQueryHospitalityRequestWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload"],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/rules/offershospitality/buildfromrequest","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryHospitalityRequestWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload"]}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/rules/offershospitality/buildfromrequest","href":"rules/createhotelrules","openApiOperationId":"CreateHotelRules","summary":"Return hotel rules (full payload)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryHospitalityRequestWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryHospitalityRequestWrapper","exampleIds":["paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}},"schemaId":"components/schemas/OfferHospitalityResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}},"schemaId":"components/schemas/OfferHospitalityResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/createhotelrules"}],"panels":[]}]},"httpPath":"/hotel/rules/offershospitality/buildfromrequest"},{"label":"Return hotel rules (reference payload).","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/rules/buildfromcatalogofferings","routeSlug":"/apis/stays/rules/buildfromcatalogofferings","metadata":{"seo":{"title":"Return hotel rules (reference payload).","description":"Deprecated - use BuildFromCatalogOffering end point"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildFromCatalogOfferings","name":"Return hotel rules (reference payload).","deprecated":true,"isWebhook":false,"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return hotel rules (reference payload).","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated - use BuildFromCatalogOffering end point"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_500","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper"}},"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper","pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/rules/offershospitality/buildfromcatalogofferings","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_500","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper"}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/rules/offershospitality/buildfromcatalogofferings","href":"rules/buildfromcatalogofferings","openApiOperationId":"BuildFromCatalogOfferings","summary":"Return hotel rules (reference payload)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}},"schemaId":"components/schemas/OfferHospitalityResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}},"schemaId":"components/schemas/OfferHospitalityResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1rules~1offershospitality~1buildfromcatalogofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferHospitalityResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferHospitalityResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/rules/buildfromcatalogofferings"}],"panels":[]}]},"httpPath":"/hotel/rules/offershospitality/buildfromcatalogofferings"}],"content":{"contentType":"group","meta":{"name":"Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rules","showPageActions":true},{"nodeType":"markdoc","content":"Reference payload and full payload hotel rules."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hotel/rules/offershospitality/buildfromcatalogoffering","summary":"Return hotel rules (reference payload).","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rules/buildhotelrulesfromcatalogoffering","deprecated":false},{"title":"/hotel/rules/offershospitality/buildfromrequest","summary":"Return hotel rules (full payload).","prefix":{"name":"post","color":"post"},"badges":[],"link":"/rules/createhotelrules","deprecated":false},{"title":"/hotel/rules/offershospitality/buildfromcatalogofferings","summary":"Return hotel rules (reference payload).","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/rules/buildfromcatalogofferings","deprecated":true}]}]}]}]}},{"type":"group","label":"Unified Check Out","link":"/apis/stays/unified-check-out","routeSlug":"/apis/stays/unified-check-out","items":[{"label":"Create Reservation (Full Payload) or Sync Hotel Reservation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/createhotelreservation","routeSlug":"/apis/stays/unified-check-out/createhotelreservation","metadata":{"seo":{"title":"Create Reservation (Full Payload) or Sync Hotel Reservation","description":"Use the Create Reservation Full Payload request to book a room by sending complete stay details and the booking code from the Availability response, along with traveler, form of payment, and payment information. NOTE: Availability results are stored in cache for 30 minutes. If the offers expire before you create a reservation, you must send a new request before booking. The Create Reservation Full Payload response uses the same format as the reference payload response. The only difference is that the Reference Payload response returns Reservation/id, which is the offer ID sent in that request. The full payload response does not return this information. Note for Multi-room sell requests- when making a reservation, Travelport attempts to sell the number of rooms requested; however, the supplier may not be able to accommodate the total number of rooms. Each room sold creates a unique hotel segment on the Travelport reservation. A traveler name is associated with each room with these limitations: If the number of rooms requested is equal to the number of traveler names in the request, each room is associated with a unique traveler name. If the number of rooms requested is not equal to the number of traveler names in the request, all rooms are associated with the first traveler name. Note for query parameters- Hotel APIs that create a new reservation or add to an existing one verify the reservation request with the guarantee type and price returned in preceding workflow steps. If there is any difference, the API does not yet create the reservation but instead returns an error to notify about the change. To accept the change, send the request a second time with the applicable query parameter/s (acceptPriceChangeInd and/or acceptGuaranteeChangeInd). Do not send either of these query parameters in the initial request. If you do not want to proceed with the booking because of the changes, you are not required to send a second booking request with the false value(s). You can simply let these offers expire. Use the Sync Reservation request to synchronize a Booking.com hotel reservation to a Travelport PNR whenever specific sell failures occur. The Sync Reservation request is a scaled down re-try of a previous Create or Add Reservation request that adds to the original sell request the Traveler email address and the Booking.com booking information. The Sync message attempts to add the reservation information into a Travelport reservation as a standard aggregator segment but without re-selling the segment in the aggregator system. Booking.com requires the traveler email address in a hotel sell request. If the sell completes in the Booking.com system, the traveler receives a confirmation email containing information needed to synchronize the Travelport booking if the user receives one of two specific error messages on the original sell attempt. The Sync Reservation response returns all available data for the reservation using the same structure as the Create Reservation response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateHotelReservation","name":"Create Reservation (Full Payload) or Sync Hotel Reservation","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Reservation (Full Payload) or Sync Hotel Reservation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the Create Reservation Full Payload request to book a room by sending complete stay details and the booking code from the Availability response, along with traveler, form of payment, and payment information. NOTE: Availability results are stored in cache for 30 minutes. If the offers expire before you create a reservation, you must send a new request before booking. The Create Reservation Full Payload response uses the same format as the reference payload response. The only difference is that the Reference Payload response returns Reservation/id, which is the offer ID sent in that request. The full payload response does not return this information.\nNote for Multi-room sell requests- when making a reservation, Travelport attempts to sell the number of rooms requested; however, the supplier may not be able to accommodate the total number of rooms. Each room sold creates a unique hotel segment on the Travelport reservation. A traveler name is associated with each room with these limitations: If the number of rooms requested is equal to the number of traveler names in the request, each room is associated with a unique traveler name. If the number of rooms requested is not equal to the number of traveler names in the request, all rooms are associated with the first traveler name.\nNote for query parameters- Hotel APIs that create a new reservation or add to an existing one verify the reservation request with the guarantee type and price returned in preceding workflow steps. If there is any difference, the API does not yet create the reservation but instead returns an error to notify about the change.  To accept the change, send the request a second time with the applicable query parameter/s (acceptPriceChangeInd and/or acceptGuaranteeChangeInd). Do not send either of these query parameters in the initial request.  If you do not want to proceed with the booking because of the changes, you are not required to send a second booking request with the false value(s). You can simply let these offers expire.\nUse the Sync Reservation request to synchronize a Booking.com hotel reservation to a Travelport PNR whenever specific sell failures occur. The Sync Reservation request is a scaled down re-try of a previous Create or Add Reservation request that adds to the original sell request the Traveler email address and the Booking.com booking information. The Sync message attempts to add the reservation information into a Travelport reservation as a standard aggregator segment but without re-selling the segment in the aggregator system. Booking.com requires the traveler email address in a hotel sell request. If the sell completes in the Booking.com system, the traveler receives a confirmation email containing information needed to synchronize the Travelport booking if the user receives one of two specific error messages on the original sell attempt. The Sync Reservation response returns all available data for the reservation using the same structure as the Create Reservation response."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"acceptPriceChangeInd","in":"query","schemaId":"schema_501","description":"Send with true to accept any difference in the current sell price from the total price returned in an earlier response. Default is false; terminates the sell process without booking. Create Reservation only."},{"name":"acceptGuaranteeChangeInd","in":"query","schemaId":"schema_501","description":"Send with true to accept any difference in the guarantee type from the guarantee type returned in an earlier response. (The guarantee types checked for differences are guarantee required, deposit required, prepay required.) Default is false; terminates the sell process without booking. Create Reservation only."},{"name":"applyStrictReservationCommentValidationInd","in":"query","schemaId":"schema_501","description":"If true, the user expects that the sell request will be failed if any of the requested reservation comments fail. If indicator is not sent the service will default to false."},{"name":"roomPerTravelerInd","in":"query","schemaId":"schema_501","description":"If true, the multi-room request will be sold as a separate reservation per traveler. If indicator is not sent the service will create a single reservation for all travelers. Default is false."}],"pointer":"/paths/~1hotel~1book~1reservations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation"]}},"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation"],"pointer":"/paths/~1hotel~1book~1reservations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/book/reservations","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"acceptPriceChangeInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"acceptGuaranteeChangeInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"applyStrictReservationCommentValidationInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"roomPerTravelerInd","in":"query","required":false,"schemaId":"schema_501"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation"]}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations","href":"unified-check-out/createhotelreservation","openApiOperationId":"CreateHotelReservation","summary":"Create Reservation (Full Payload) or Sync Hotel Reservation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation"]}},"examples":[{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/createhotelreservation"}],"panels":[]}]},"httpPath":"/hotel/book/reservations"},{"label":"Create hotel reservation (Reference payload).","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/buildhotelreservation","routeSlug":"/apis/stays/unified-check-out/buildhotelreservation","metadata":{"seo":{"title":"Create hotel reservation (Reference payload).","description":"Use the Create Reservation Reference Payload request to book a room using a cached offer from either a preceding Availability or SearchComplete response. The reference payload request sends an offer ID plus traveler details and both form of payment and payment information. NOTE: Results from Availability and SearchComplete are stored in cache for 30 minutes. If the offers expire before you create a reservation, you must send a new request before booking. The Create Reservation Full Payload response uses the same format as the Reference Payload response. The only difference is that the reference payload response returns Reservation/id, which is the offer ID sent in that request. The full payload response does not return this information.\" Note for query parameters- Hotel APIs that create a new reservation or add to an existing one verify the reservation request with the guarantee type and price returned in preceding workflow steps. If there is any difference, the API does not yet create the reservation but instead returns an error to notify about the change. To accept the change, send the request a second time with the applicable query parameter/s (acceptPriceChangeInd and/or acceptGuaranteeChangeInd). Do not send either of these query parameters in the initial request. If you do not want to proceed with the booking because of the changes, you are not required to send a second booking request with the false value(s). You can simply let these offers expire."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildHotelReservation","name":"Create hotel reservation (Reference payload).","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1build/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create hotel reservation (Reference payload).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the Create Reservation Reference Payload request to book a room using a cached offer from either a preceding Availability or SearchComplete response. The reference payload request sends an offer ID plus traveler details and both form of payment and payment information. NOTE: Results from Availability and SearchComplete are stored in cache for 30 minutes. If the offers expire before you create a reservation, you must send a new request before booking. The Create Reservation Full Payload response uses the same format as the Reference Payload response. The only difference is that the reference payload response returns Reservation/id, which is the offer ID sent in that request. The full payload response does not return this information.\"\nNote for query parameters- Hotel APIs that create a new reservation or add to an existing one verify the reservation request with the guarantee type and price returned in preceding workflow steps. If there is any difference, the API does not yet create the reservation but instead returns an error to notify about the change.  To accept the change, send the request a second time with the applicable query parameter/s (acceptPriceChangeInd and/or acceptGuaranteeChangeInd). Do not send either of these query parameters in the initial request.  If you do not want to proceed with the booking because of the changes, you are not required to send a second booking request with the false value(s). You can simply let these offers expire."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"acceptPriceChangeInd","in":"query","schemaId":"schema_501","description":"Send with true to accept any difference in the current sell price from the total price returned in an earlier response. Default is false; terminates the sell process without booking."},{"name":"acceptGuaranteeChangeInd","in":"query","schemaId":"schema_501","description":"Send with true to accept any difference in the guarantee type from the guarantee type returned in an earlier response. (The guarantee types checked for differences are guarantee required, deposit required, prepay required.) Default is false; terminates the sell process without booking."},{"name":"applyStrictReservationCommentValidationInd","in":"query","schemaId":"schema_501","description":"If true, the user expects that the sell request will be failed if any of the requested reservation comments fail.  If indicator is not sent the service will default to false."},{"name":"roomPerTravelerInd","in":"query","schemaId":"schema_501","description":"If true, the multi-room request will be sold as a separate reservation per Traveler. If indicator is not sent the service will create a single reservation for all travelers. Default is false."}],"pointer":"/paths/~1hotel~1book~1reservations~1build/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1build/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryBuildWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"]}},"schemaId":"components/schemas/ReservationQueryBuildWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"],"pointer":"/paths/~1hotel~1book~1reservations~1build/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/book/reservations/build","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"acceptPriceChangeInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"acceptGuaranteeChangeInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"applyStrictReservationCommentValidationInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"roomPerTravelerInd","in":"query","required":false,"schemaId":"schema_501"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryBuildWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"]}},"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/build","href":"unified-check-out/buildhotelreservation","openApiOperationId":"BuildHotelReservation","summary":"Create hotel reservation (Reference payload)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryBuildWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryBuildWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1build/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/buildhotelreservation"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/build"},{"label":"Retrieve hotel reservation.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/retrievehotelreservation","routeSlug":"/apis/stays/unified-check-out/retrievehotelreservation","metadata":{"seo":{"title":"Retrieve hotel reservation.","description":"The Retrieve Hotel Reservation API returns all existing data on a reservation. You may retrieve details about a held booking or PNR. While a PNR refers to a held booking that has not been ticketed, the PNR code persists after ticketing to provide the booking records. Once a PNR has been ticketed, you can still use Retrieve to return both booking and ticketing details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveHotelReservation","name":"Retrieve hotel reservation.","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve hotel reservation.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Retrieve Hotel Reservation API returns all existing data on a reservation. You may retrieve details about a held booking or PNR. While a PNR refers to a held booking that has not been ticketed, the PNR code persists after ticketing to provide the booking records. Once a PNR has been ticketed, you can still use Retrieve to return both booking and ticketing details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Identifier","in":"path","schemaId":"schema_498","description":"Identifier provides the ability to create a globally unique identifier. For the identifier to be globally unique it must have a system provided identifier and the system must be identified using a global naming authority. System identification uses the domain naming system (DNS) to assure they are globally unique and should be an URL. The system provided ID will typically be a primary or surrogate key in a database.","required":true}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"detailViewInd","in":"query","schemaId":"schema_501","description":"If true, ReservationDetail will be returned."},{"name":"identifierType","in":"query","schemaId":"schema_502","description":"The type of identifier key used to retrieve the reservation","example":"Locator"}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/hotel/book/reservations/{Identifier}","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"Identifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"identifierType","in":"query","required":false,"example":"Locator","schemaId":"components/schemas/IdentifierTypeENUM"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/{Identifier}","href":"unified-check-out/retrievehotelreservation","openApiOperationId":"RetrieveHotelReservation","summary":"Retrieve hotel reservation."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/retrievehotelreservation"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/{Identifier}"},{"label":"Modify existing hotel reservation.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/updatehotelreservation","routeSlug":"/apis/stays/unified-check-out/updatehotelreservation","metadata":{"seo":{"title":"Modify existing hotel reservation.","description":"Use Modify Hotel Reservation to modify specific data on an existing booking. Modify Hotel supports changes to the following data: 1) Dates of reservation, if allowed by supplier; note that a change in price may occur, 2) Form of payment details, 3) Specific details of the traveler associated with a booking as follows: a) Changing the given name and/or surname to that of another traveler currently on the reservation; other name changes are not supported, b) Telephone number, c) Email address, and/or d) Adding new comments. NOTE: Booking.com does not support modify capabilities. You cannot modify reservations made from Booking.com content. NOTE: When changing dates for a reservation sold through Travelport, best practice is to first send an Availability request for the new dates and look for the same booking code that is on the existing reservation. Although an Availability request is not mandatory, the Modify request will fail if the new dates are not available. Add Hotel Reservation allows you to add another hotel room to an existing reservation. The full payload request sends complete offer details and the booking code from a preceding Availability request. Reference payload request sends a cached offer ID from a preceding Availability response. It requires both a preceding search (either by location or by ID) request and an Availability request, or a SearchComplete request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateHotelReservation","name":"Modify existing hotel reservation.","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify existing hotel reservation.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use Modify Hotel Reservation to modify specific data on an existing booking. Modify Hotel supports changes to the following data: 1) Dates of reservation, if allowed by supplier; note that a change in price may occur, 2) Form of payment details, 3) Specific details of the traveler associated with a booking as follows: a) Changing the given name and/or surname to that of another traveler currently on the reservation; other name changes are not supported, b) Telephone number, c) Email address, and/or d) Adding new comments. NOTE: Booking.com does not support modify capabilities. You cannot modify reservations made from Booking.com content. NOTE: When changing dates for a reservation sold through Travelport, best practice is to first send an Availability request for the new dates and look for the same booking code that is on the existing reservation. Although an Availability request is not mandatory, the Modify request will fail if the new dates are not available.  Add Hotel Reservation allows you to add another hotel room to an existing reservation. The full payload request sends complete offer details and the booking code from a preceding Availability request. Reference payload request sends a cached offer ID from a preceding Availability response. It requires both a preceding search (either by location or by ID) request and an Availability request, or a SearchComplete request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Identifier","in":"path","schemaId":"schema_498","description":"Identifier provides the ability to create a globally unique identifier. For the identifier to be globally unique it must have a system provided identifier and the system must be identified using a global naming authority. System identification uses the domain naming system (DNS) to assure they are globally unique and should be an URL. The system provided ID will typically be a primary or surrogate key in a database.","required":true}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"acceptPriceChangeInd","in":"query","schemaId":"schema_501","description":"If true, user accepts any difference in the total price received in availability versus what is the current price in the sell process; false denotes that the user does not accept a price difference and the sell process should not complete. If indicator is not sent the service will default to false."},{"name":"acceptGuaranteeChangeInd","in":"query","schemaId":"schema_501","description":"If true, the user accepts any difference in the guarantee type (guarantee required, deposit required, prepay required) received in availability versus what is the current guarantee type in the sell process; false denotes that the user does not accept a guarantee type difference and the sell process should not complete. If indicator is not sent the service will default to false."},{"name":"applyStrictReservationCommentValidationInd","in":"query","schemaId":"schema_501","description":"If true, the user expects that the sell request will be failed if any of the requested reservation comments fail.  If indicator is not sent the service will default to false."}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation"]}},"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation"],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hotel/book/reservations/{Identifier}","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"Identifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"acceptPriceChangeInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"acceptGuaranteeChangeInd","in":"query","required":false,"schemaId":"schema_501"},{"name":"applyStrictReservationCommentValidationInd","in":"query","required":false,"schemaId":"schema_501"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation"]}},"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/{Identifier}","href":"unified-check-out/updatehotelreservation","openApiOperationId":"UpdateHotelReservation","summary":"Modify existing hotel reservation."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation"]}},"examples":[{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1{Identifier}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/updatehotelreservation"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/{Identifier}"},{"label":"Cancel hotel reservation.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/cancelhoteloffer","routeSlug":"/apis/stays/unified-check-out/cancelhoteloffer","metadata":{"seo":{"title":"Cancel hotel reservation.","description":"The Cancel Hotel Reservation API cancels an existing hotel reservation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelHotelOffer","name":"Cancel hotel reservation.","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1canceloffer/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel hotel reservation.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Cancel Hotel Reservation API cancels an existing hotel reservation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reservationIdentifier","in":"path","schemaId":"schema_498","required":true}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1canceloffer/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"supplierLocator","in":"query","schemaId":"schema_492"},{"name":"offerID","in":"query","schemaId":"schema_499"}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1canceloffer/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1canceloffer/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hotel/book/reservations/{reservationIdentifier}/canceloffer","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"reservationIdentifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"supplierLocator","in":"query","required":false,"schemaId":"schema_492"},{"name":"offerID","in":"query","required":false,"schemaId":"schema_499"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/{reservationIdentifier}/canceloffer","href":"unified-check-out/cancelhoteloffer","openApiOperationId":"CancelHotelOffer","summary":"Cancel hotel reservation."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1canceloffer/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/cancelhoteloffer"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/{reservationIdentifier}/canceloffer"},{"label":"Create passive hotel reservation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/createhotelpassivereservation","routeSlug":"/apis/stays/unified-check-out/createhotelpassivereservation","metadata":{"seo":{"title":"Create passive hotel reservation","description":"Create Passive Reservation creates a new booking with a hotel segment booked outside the Travelport GDS, called a passive segment. This allows the booking to include complete travel details. Passive hotel segments are confirmed with a status code of MK, which is returned in the response in Receipt/OfferStatus/code. A status code of AK is used for placeholder-only passive segments. A passive hotel segment is any segment that is booked using anything other than the JSON APIs or another product that uses the Travelport GDS. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateHotelPassiveReservation","name":"Create passive hotel reservation","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1passive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create passive hotel reservation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create Passive Reservation creates a new booking with a hotel segment booked outside the Travelport GDS, called a passive segment. This allows the booking to include complete travel details. Passive hotel segments are confirmed with a status code of MK, which is returned in the response in Receipt/OfferStatus/code. A status code of AK is used for placeholder-only passive segments. A passive hotel segment is any segment that is booked using anything other than the JSON APIs or another product that uses the Travelport GDS. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1passive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation"]}},"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation"],"pointer":"/paths/~1hotel~1book~1reservations~1passive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/hotel/book/reservations/passive","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation"]}},"responseCodes":["200","201","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/passive","href":"unified-check-out/createhotelpassivereservation","openApiOperationId":"CreateHotelPassiveReservation","summary":"Create passive hotel reservation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper","exampleIds":["paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name","paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation"]}},"examples":[{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1passive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/createhotelpassivereservation"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/passive"},{"label":"Add passive reservation to a booking.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/addpassiveoffer","routeSlug":"/apis/stays/unified-check-out/addpassiveoffer","metadata":{"seo":{"title":"Add passive reservation to a booking.","description":"Use the Add Passive Reservation request to add a passive hotel booking segment to an existing reservation. You can add either of two types of passive segments to an existing reservation: 1) Sending full details of the room in the request adds a single hotel segment with a status of MK (confirmed passive) to the reservation, or, 2) Sending only dates in the request, which adds a placeholder segment to the reservation. You may want to add a placeholder if you do not have all booking details. Or, you can send only dates to add a dummy or retention segment, which can be used to keep the reservation details active in the system after travel is complete, up to the dates on the passive segment. Placeholder segments return a status of AK. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPassiveOffer","name":"Add passive reservation to a booking.","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passive/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add passive reservation to a booking.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the Add Passive Reservation request to add a passive hotel booking segment to an existing reservation. You can add either of two types of passive segments to an existing reservation: 1) Sending full details of the room in the request adds a single hotel segment with a status of MK (confirmed passive) to the reservation, or, 2) Sending only dates in the request, which adds a placeholder segment to the reservation. You may want to add a placeholder if you do not have all booking details. Or, you can send only dates to add a dummy or retention segment, which can be used to keep the reservation details active in the system after travel is complete, up to the dates on the passive segment. Placeholder segments return a status of AK. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reservationIdentifier","in":"path","schemaId":"schema_498","required":true}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passive/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Locator","in":"query","schemaId":"schema_492"}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passive/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passive/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hotel/book/reservations/{reservationIdentifier}/passive","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"reservationIdentifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"Locator","in":"query","required":false,"schemaId":"schema_492"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/{reservationIdentifier}/passive","href":"unified-check-out/addpassiveoffer","openApiOperationId":"AddPassiveOffer","summary":"Add passive reservation to a booking."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passive/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/addpassiveoffer"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/{reservationIdentifier}/passive"},{"label":"Modify passive hotel reservation.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/stays/unified-check-out/updatepassiveoffer","routeSlug":"/apis/stays/unified-check-out/updatepassiveoffer","metadata":{"seo":{"title":"Modify passive hotel reservation.","description":"Use Modify Passive Reservation to update any parameter within an MK passive hotel booking segment of an existing reservation. MK designates a confirmed passive segment, while AK is used for placeholder-only segments. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatePassiveOffer","name":"Modify passive hotel reservation.","isWebhook":false,"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passiveupdate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify passive hotel reservation.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use Modify Passive Reservation to update any parameter within an MK passive hotel booking segment of an existing reservation. MK designates a confirmed passive segment, while AK is used for placeholder-only segments. (A passive hotel segment is any segment that is booked using anything other than a product that uses the Travelport GDS. Passive segments are informational only. They do not result in a reservation or a change in inventory. Information on a passive segment is not received from or passed to the hotel supplier. Instead, passive segments provide a way to consolidate all booking information, including details from direct hotel bookings or even phone reservations.)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reservationIdentifier","in":"path","schemaId":"schema_498","required":true}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passiveupdate/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Locator","in":"query","schemaId":"schema_492"}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passiveupdate/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_494","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_495","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_496","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"TVP-Correlation-Id","in":"header","schemaId":"schema_497","description":"Identifier used to correlate hotel API invocations across a multi-call business flows."}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passiveupdate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/hotel/book/reservations/{reservationIdentifier}/passiveupdate","servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"reservationIdentifier","in":"path","required":true,"schemaId":"schema_498"}],"query":[{"name":"Locator","in":"query","required":false,"schemaId":"schema_492"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_494","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_495","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_496","style":"simple","explode":false},{"name":"TVP-Correlation-Id","in":"header","required":false,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_497","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/hotel/book/reservations/{reservationIdentifier}/passiveupdate","href":"unified-check-out/updatepassiveoffer","openApiOperationId":"UpdatePassiveOffer","summary":"Modify passive hotel reservation."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/stays","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}},"schemaId":"components/schemas/ReservationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1hotel~1book~1reservations~1{reservationIdentifier}~1passiveupdate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"402","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/unified-check-out/updatepassiveoffer"}],"panels":[]}]},"httpPath":"/hotel/book/reservations/{reservationIdentifier}/passiveupdate"}],"content":{"contentType":"group","meta":{"name":"Unified Check Out"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unified Check Out","showPageActions":true},{"nodeType":"markdoc","content":"Create, modify and cancel hotel reservations with a single payload."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/hotel/book/reservations","summary":"Create Reservation (Full Payload) or Sync Hotel Reservation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unified-check-out/createhotelreservation","deprecated":false},{"title":"/hotel/book/reservations/build","summary":"Create hotel reservation (Reference payload).","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unified-check-out/buildhotelreservation","deprecated":false},{"title":"/hotel/book/reservations/{Identifier}","summary":"Retrieve hotel reservation.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/unified-check-out/retrievehotelreservation","deprecated":false},{"title":"/hotel/book/reservations/{Identifier}","summary":"Modify existing hotel reservation.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/unified-check-out/updatehotelreservation","deprecated":false},{"title":"/hotel/book/reservations/{reservationIdentifier}/canceloffer","summary":"Cancel hotel reservation.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/unified-check-out/cancelhoteloffer","deprecated":false},{"title":"/hotel/book/reservations/passive","summary":"Create passive hotel reservation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/unified-check-out/createhotelpassivereservation","deprecated":false},{"title":"/hotel/book/reservations/{reservationIdentifier}/passive","summary":"Add passive reservation to a booking.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/unified-check-out/addpassiveoffer","deprecated":false},{"title":"/hotel/book/reservations/{reservationIdentifier}/passiveupdate","summary":"Modify passive hotel reservation.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/unified-check-out/updatepassiveoffer","deprecated":false}]}]}]}]}},{"type":"group","label":"Sessioned Check Out","link":"/apis/stays/sessioned-check-out","routeSlug":"/apis/stays/sessioned-check-out","items":[],"content":{"contentType":"group","meta":{"name":"Sessioned Check Out"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sessioned Check Out","showPageActions":true},{"nodeType":"markdoc","content":"Create, modify and cancel hotel reservations in a sessioned environment using the reservation workbench."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sessioned-check-out"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/ImageSizeEnum":{"id":"components/schemas/ImageSizeEnum","kind":"json-schema","title":"ImageSizeEnum","data":{"type":"string","description":"A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail.","example":"Small","enum":["Large","Medium","Small","Thumbnail","ExtraLarge"]}},"components/schemas/PropertiesResponseWrapper":{"id":"components/schemas/PropertiesResponseWrapper","kind":"json-schema","title":"PropertiesResponseWrapper","data":{"properties":{"PropertiesResponse":{"$ref":"#/components/schemas/PropertiesResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/PropertiesResponse":{"id":"components/schemas/PropertiesResponse","kind":"json-schema","title":"PropertiesResponse","data":{"properties":{"Properties":{"$ref":"#/components/schemas/Properties"}},"description":"The response of a Properties endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/BaseResponse":{"id":"components/schemas/BaseResponse","kind":"json-schema","title":"BaseResponse","data":{"properties":{"@type":{"type":"string","example":"response"},"transactionId":{"type":"string","description":"A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  \nAlso known as E2ETrackingId.  \nNot returned in all Hotel API responses.","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"traceId":{"type":"string","description":"Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response.  \nFor Air Eligibility, returned if a custom trace ID was sent in the request header.  \nFor Hotel Rules, returned if a custom trace ID was sent in the request header.","example":"TraceID_123456"},"correlationId":{"type":"string","description":"Identifier used to correlate hotel API invocations across a multi-call business flows.","format":"uuid"},"reservationStatus":{"$ref":"#/components/schemas/ReservationOfferStatusEnum"},"Result":{"$ref":"#/components/schemas/Result"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"NextSteps":{"$ref":"#/components/schemas/NextSteps"},"ReferenceList":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/ReferenceList"}},"CurrencyRateConversion":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/CurrencyRateConversion"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}},"description":"Base response is part of all JSON APIs responses and includes common items which are relevant across all APIs"}},"components/schemas/ReservationOfferStatusEnum":{"id":"components/schemas/ReservationOfferStatusEnum","kind":"json-schema","title":"ReservationOfferStatusEnum","data":{"type":"string","description":"Status of reservation or offer completion.","enum":["Success","Fail","Partial","Pending","OnHold","Retry","Other"],"x-enumDescriptions":{"Success":"All offer items have been booked and issued successfully.","Fail":"All offer items have failed to issue.","Partial":"Some offer items have failed to issue.","Pending":"Some offer items are pending carrier response.","OnHold":"Document issuance has not been attempted.","Retry":"A communication error has occurred and retry of document issuance is required.","Other":"An issue has occurred and will be communicated in the error or warning response."}}},"components/schemas/Result":{"id":"components/schemas/Result","kind":"json-schema","title":"Result","data":{"properties":{"@type":{"type":"string","description":"Discriminator class Result only","example":"Result"},"status":{"$ref":"#/components/schemas/ResultStatusEnum"},"Error":{"maxItems":50,"type":"array","description":"A list of error information returned at the provider level for a response.","items":{"$ref":"#/components/schemas/Error"}},"Warning":{"maxItems":100,"type":"array","description":"A list of warning information returned at the provider level for a response.","items":{"$ref":"#/components/schemas/Warning"}}},"description":"Returns the error and/or warning message information, if applicable."}},"components/schemas/ResultStatusEnum":{"id":"components/schemas/ResultStatusEnum","kind":"json-schema","title":"ResultStatusEnum","data":{"type":"string","description":"The status of an error or warning","example":"Complete","enum":["Not processed","Incomplete","Complete","Unknown"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Error or ErrorDetail","example":"ErrorDetail"},"StatusCode":{"type":"integer","description":"Http standard response code","format":"int32","example":200,"deprecated":true},"Message":{"maxLength":4096,"type":"string","description":"The Travelport standardized error or warning message","example":"No flights found."},"NameValuePair":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}}},"description":"A list of error information returned from the provider.","discriminator":{"propertyName":"@type"}}},"components/schemas/NameValuePair":{"id":"components/schemas/NameValuePair","kind":"json-schema","title":"NameValuePair","data":{"required":["name"],"properties":{"value":{"maxLength":512,"type":"string","description":"Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).","example":"Sunday"},"id":{"type":"string","description":"Optional internally referenced id","example":"6"},"name":{"maxLength":512,"type":"string","description":"Key, categorizing the type of remark or error.","example":"Day1"}},"description":"Further details describing remarks or error response, structured in name-value pairs."}},"components/schemas/Warning":{"id":"components/schemas/Warning","kind":"json-schema","title":"Warning","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Warning or WarningDetail","example":"WarningDetail"},"StatusCode":{"type":"integer","description":"Http standard response code","format":"int32","example":200,"deprecated":true},"Message":{"maxLength":4096,"type":"string","description":"The Travelport standardized error or warning message","example":"Customer Loyalty could not be applied."},"NameValuePair":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}}},"description":"A list of warning information returned from the provider.","discriminator":{"propertyName":"@type"}}},"components/schemas/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"properties":{"value":{"maxLength":1024,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique offer identifier that can be sent in subsequent payload requests to reference this offer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea')."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When building an AirPrice or Add Offer reference payload request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request."},"children":[]}]}]}],"example":"A0656EFF-FAF4-456F-B061-0161008D7C4E"},"authority":{"maxLength":128,"type":"string","description":"Name of the supplier system that created this identifier - the source of information.  \nFor AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  \nWhen returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  \nFor Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  \nFor Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.","example":"TVPT"}},"description":"A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination)."}},"components/schemas/NextSteps":{"id":"components/schemas/NextSteps","kind":"json-schema","title":"NextSteps","data":{"required":["NextStep","baseURI"],"properties":{"baseURI":{"type":"string","description":"The base portion of the URI in order to shorten the uris in the individual steps"},"id":{"type":"string","description":"Optional internally referenced id","example":"5"},"NextStep":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/NextStep"}}},"description":"Container for the steps that describe actions that may be taken on the containing object.  \nNot applicable for an Eligibility or Exchange response."}},"components/schemas/NextStep":{"id":"components/schemas/NextStep","kind":"json-schema","title":"NextStep","data":{"required":["action","method"],"properties":{"value":{"type":"string","example":"www.resourcelocation.com"},"id":{"type":"string","description":"Identifier for the Next Step","example":"2"},"action":{"maxLength":32,"type":"string","description":"The action this next step is intended to achieve","example":"cancel"},"method":{"$ref":"#/components/schemas/NextStepMethodEnum"},"description":{"maxLength":32,"type":"string","description":"Additional clarification for the next step","example":"remove offer from the order"}},"description":"A URL that describes a step that can be applied to the resource containing the next step structure."}},"components/schemas/NextStepMethodEnum":{"id":"components/schemas/NextStepMethodEnum","kind":"json-schema","title":"NextStepMethodEnum","data":{"type":"string","description":"Describes the set of potential methods that can be taken after an operation.","enum":["GET","DELETE","PUT","POST"]}},"components/schemas/ReferenceList":{"id":"components/schemas/ReferenceList","kind":"json-schema","title":"ReferenceList","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Price child classes are ReferenceListAmenity and ReferenceListBrand."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FareRules child class is ReferenceListFlight."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Ancillaries child class is ReferenceListFlight."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seat Map child class is ReferenceListSeatingChart."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Availability child class is ReferenceListPropertyDates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Book_Traveler child class is ReferenceListTraveler."},"children":[]}]}]}]}],"example":"ReferenceListFlight"},"id":{"type":"string","description":"Uniquely identifies for the Reference List"}},"description":"ReferenceList consolidates frequently referenced objects into a single instance, which is referenced throughout the response payload.  \nThis is most commonly used in our Search APIs where response size is a consideration. Air Search API will return one instance ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, ReferenceListBrand, and optionally if requested, ReferenceListAmenity and ReferenceListUniversalProductAttributes.  \nNot applicable for an Eligibility or Exchange response.","discriminator":{"propertyName":"@type"}}},"components/schemas/CurrencyRateConversion":{"id":"components/schemas/CurrencyRateConversion","kind":"json-schema","title":"CurrencyRateConversion","data":{"required":["ConversionRate","SourceCurrency","TargetCurrency"],"properties":{"@type":{"type":"string","default":"CurrencyRateConversion"},"SourceCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"TargetCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"ConversionRate":{"$ref":"#/components/schemas/ConversionRate"}},"description":"Conversion information for currency exchange between one currency and another. The response does not convert any amounts.  \nFor Hotel, returned only if requestedCurrency was sent in the request. By default the Hotel APIs return all rates in the currency of the hotel's location."}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"properties":{"value":{"pattern":"[a-zA-Z]{3}","type":"string","description":"An ISO 4217 currency code.","example":"USD"},"codeAuthority":{"maxLength":32,"type":"string","description":"Currency code authority","example":"ISO 4217"},"decimalPlace":{"type":"integer","description":"Number of decimal places for the currency.","format":"int32","example":4},"decimalAuthority":{"maxLength":32,"type":"string","description":"Currency code decimal authority","example":"ISO 4217"}},"description":"Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  \nUnless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  \nFor Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency."}},"components/schemas/ConversionRate":{"id":"components/schemas/ConversionRate","kind":"json-schema","title":"ConversionRate","data":{"properties":{"value":{"type":"number","format":"float"},"rateAuthority":{"maxLength":32,"type":"string","description":"Contextual rate authority","example":"ISO 4217"},"rateAsOf":{"type":"string","description":"Rate as of","format":"date-time","example":"2026-08-07T12:12:00Z"}},"description":"Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts."}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"required":["@type","page","pageSize","totalItems","totalPages"],"properties":{"@type":{"type":"string","example":"Pagination"},"page":{"type":"integer","description":"The current page number of the full result set","format":"int32","example":1},"pageSize":{"type":"integer","description":"The total number of items on this page","format":"int32","example":20},"totalPages":{"type":"integer","description":"The total number of pages in this result set","format":"int32","example":5},"totalItems":{"type":"integer","description":"The total number of pages in this result set","format":"int32","example":100}},"description":"Pagination object used when result sets span across a number of pages."}},"components/schemas/Properties":{"id":"components/schemas/Properties","kind":"json-schema","title":"Properties","data":{"description":"Returns the properties list and pagination information.","allOf":[{"$ref":"#/components/schemas/PropertiesID"},{"required":["PropertyInfo"],"properties":{"totalProperties":{"type":"integer","description":"The total number of properties returned in the search.","format":"int32"},"propertiesPerPage":{"type":"integer","description":"The number of properties returned in the current page.","format":"int32"},"numberOfPages":{"type":"integer","description":"The total number of pages that can returned in the search.","format":"int32"},"PropertyInfo":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PropertyInfo"}}}}]}},"components/schemas/PropertiesID":{"id":"components/schemas/PropertiesID","kind":"json-schema","title":"PropertiesID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Properties and PropertiesID"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/PropertyInfo":{"id":"components/schemas/PropertyInfo","kind":"json-schema","title":"PropertyInfo","data":{"description":"Each instance of PropertyInfo provides all information returned about one property.","allOf":[{"$ref":"#/components/schemas/PropertyInfoID"},{"required":["Property"],"properties":{"availability":{"$ref":"#/components/schemas/AvailabilityStatusEnum"},"Distance":{"$ref":"#/components/schemas/Distance"},"Property":{"$ref":"#/components/schemas/PropertyDetail"},"LowestAvailableRate":{"$ref":"#/components/schemas/CurrencyAmount"},"NextSteps":{"$ref":"#/components/schemas/NextSteps"},"featuredPropertyInd":{"type":"boolean","description":"Indicates if a property has been promoted to the top of the Properties list through the featured properties program. Featured properties always have this indicator and are sorted at the top of the list when searching by IATA city/airport codes."},"MaximumAvailableRate":{"$ref":"#/components/schemas/MaximumAvailableRate"}}}]}},"components/schemas/PropertyInfoID":{"id":"components/schemas/PropertyInfoID","kind":"json-schema","title":"PropertyInfoID","data":{"properties":{"@type":{"type":"string"},"id":{"type":"string","description":"Property identifier composed of the chain and property codes."},"Identifier":{"$ref":"#/components/schemas/Identifier"}}}},"components/schemas/AvailabilityStatusEnum":{"id":"components/schemas/AvailabilityStatusEnum","kind":"json-schema","title":"AvailabilityStatusEnum","data":{"type":"string","description":"Indicates whether the property has rooms available for the requested dates.","enum":["Open","Close","ClosedOnArrival","ClosedOnArrivalOnRequest","OnRequest","RemoveCloseOnly","Other"],"x-enumDescriptions":{"Open":"Property has rooms/rates available that match search parameters.","Close":"Property has no rooms available.","Other":"Property has rooms/rates available that do not match search parameters."}}},"components/schemas/Distance":{"id":"components/schemas/Distance","kind":"json-schema","title":"Distance","data":{"properties":{"value":{"type":"number","description":"When using distance as a Hotel property search parameter, the maximum distance is 25 for miles and 40 for kilometres.","format":"float","example":25},"unitOfDistance":{"$ref":"#/components/schemas/UnitOfDistanceEnum"}},"description":"For Air: distance covered by the flight.  \nFor Hotel: a radius around a specified location. The Distance object is returned in all Hotel Search responses but is not relevant to a search by property IDs, only for a search by location."}},"components/schemas/UnitOfDistanceEnum":{"id":"components/schemas/UnitOfDistanceEnum","kind":"json-schema","title":"UnitOfDistanceEnum","data":{"type":"string","description":"For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries.","example":"Kilometers","enum":["Miles","Kilometers"]}},"components/schemas/PropertyDetail":{"id":"components/schemas/PropertyDetail","kind":"json-schema","title":"PropertyDetail","data":{"allOf":[{"$ref":"#/components/schemas/Property"},{"properties":{"classTypeCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"The OTA code of the property detail"},"segmentCatagoryCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Segment category code"},"locationCatagoryCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Location category code"},"complimentaryParking":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"Address":{"$ref":"#/components/schemas/Address"},"Telephone":{"maxItems":5,"minItems":1,"type":"array","description":"Property phone number.","items":{"maxLength":128,"type":"string","example":"001-123-45678"}},"Email":{"$ref":"#/components/schemas/Email"},"PropertyAmenity":{"maxItems":250,"type":"array","items":{"$ref":"#/components/schemas/PropertyAmenity"}},"PetPolicy":{"$ref":"#/components/schemas/PetPolicy"},"Restaurant":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Restaurant"}},"Attraction":{"maxItems":100,"type":"array","description":"Each instance is one attraction near the property.","items":{"$ref":"#/components/schemas/Attraction"}},"DrivingDirections":{"$ref":"#/components/schemas/TextFree"},"MeetingRooms":{"$ref":"#/components/schemas/MeetingRooms"},"VirtualTour":{"$ref":"#/components/schemas/VirtualTour"},"CheckInOutPolicy":{"$ref":"#/components/schemas/CheckInOutPolicy"}}}]}},"components/schemas/Property":{"id":"components/schemas/Property","kind":"json-schema","title":"Property","data":{"allOf":[{"$ref":"#/components/schemas/PropertyID"},{"required":["name"],"properties":{"name":{"maxLength":128,"type":"string","description":"The name of a specific property."},"Rating":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Rating"}},"GeoLocation":{"$ref":"#/components/schemas/GeoLocation"},"Image":{"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/Image"}},"Description":{"maxItems":5,"type":"array","description":"A text description of the property.","items":{"type":"string"}},"BusinessService":{"maxItems":100,"type":"array","description":"Any business services available at the property.","items":{"$ref":"#/components/schemas/Service"}},"AccessibilityFeature":{"maxItems":25,"type":"array","items":{"$ref":"#/components/schemas/OTA_CodeWithDescription"}},"GuestRoomInfo":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/GuestRoomInfo"}}}}]}},"components/schemas/PropertyID":{"id":"components/schemas/PropertyID","kind":"json-schema","title":"PropertyID","data":{"required":["@type","PropertyKey"],"properties":{"@type":{"type":"string","description":"Discriminator classes Property, PropertyID, and PropertyDetail","example":"PropertyDetail"},"id":{"type":"string","description":"Property ID composed of the chain and property codes."},"Identifier":{"$ref":"#/components/schemas/Identifier"},"PropertyKey":{"$ref":"#/components/schemas/PropertyKey"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/PropertyKey":{"id":"components/schemas/PropertyKey","kind":"json-schema","title":"PropertyKey","data":{"required":["chainCode","propertyCode"],"properties":{"@type":{"type":"string","default":"PropertyKey"},"chainCode":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string","description":"Code for the hotel chain (typically 2 characters)","example":"UR"},"propertyCode":{"maxLength":32,"type":"string","description":"The property code of the requested property (typically 5 characters).","example":"G3375"}},"description":"Contains up to 250 PropertyKey objects. Each PropertyKey object identifies one property."}},"components/schemas/Rating":{"id":"components/schemas/Rating","kind":"json-schema","title":"Rating","data":{"properties":{"value":{"type":"number","description":"Rating used to classify hotels according to the quality","format":"float","example":5},"provider":{"maxLength":32,"type":"string","description":"The source who has granted the quality rating","example":"NTM"}},"description":"The actual award or rating received by the facility."}},"components/schemas/GeoLocation":{"id":"components/schemas/GeoLocation","kind":"json-schema","title":"GeoLocation","data":{"required":["latitude","longitude"],"properties":{"latitude":{"type":"number","description":"Numeric value representing latitude of search center point in degrees and decimal minutes.","format":"double","example":38.8951},"longitude":{"type":"number","description":"Numeric value representing longitude of search center point in degrees and decimal minutes.","format":"double","example":-77.0364},"altitude":{"type":"number","description":"The height of a location, typically measured above sea level","format":"float","example":5280},"altitudeUnitOfDistance":{"$ref":"#/components/schemas/UnitOfDistanceEnum"},"positionAccuracy":{"$ref":"#/components/schemas/PositionAccuracyEnum"},"mapURL":{"type":"string","description":"link for embedded map showing location","example":"www.destinationmap.com"},"formatURL":{"type":"string","description":"The URL to the format for the latitude and longitude for this location.","example":"www.destinationmap.com"}},"description":"For Hotel: the geographic coordinates of the property."}},"components/schemas/PositionAccuracyEnum":{"id":"components/schemas/PositionAccuracyEnum","kind":"json-schema","title":"PositionAccuracyEnum","data":{"type":"string","description":"Specifies the level of accuracy for the position","enum":["Zip9Code","Zip7Code","Zip5Code","Street","State","Property","Intersection","Exact","County","City","Block"]}},"components/schemas/Image":{"id":"components/schemas/Image","kind":"json-schema","title":"Image","data":{"properties":{"value":{"type":"string","description":"URL of the image"},"dimensionCategory":{"maxLength":1,"type":"string","description":"Deprecated and replaced by imageSize"},"width":{"type":"integer","description":"Image width","format":"int32","example":42},"height":{"type":"integer","description":"Image height","format":"int32","example":43},"caption":{"maxLength":128,"type":"string","description":"Image caption","example":"Ticket"},"pictureCategory":{"type":"integer","description":"deprecated and replaced by pictureOf","format":"int32","example":5},"imageSize":{"$ref":"#/components/schemas/ImageSizeEnum"},"pictureOf":{"$ref":"#/components/schemas/PictureofEnum"}},"description":"Each instance is one image and its accompanying details, including a link to the image. Key value pairs; not all may be returned."}},"components/schemas/PictureofEnum":{"id":"components/schemas/PictureofEnum","kind":"json-schema","title":"PictureofEnum","data":{"type":"string","description":"The image category","example":"Lobby","enum":["Exterior","Lobby","Pool","Restaurant","HealthClub","GuestRoom","Suite","ConferenceRoom","Ballroom","Golf","Beach","Spa","Bar","Recreational","RoomAmenity","PropertyAmenity","BusinessCentre","Map","Promotional","Undefined","Studio","Attraction","Other","Amenity","Logo","MeetingRoom"]}},"components/schemas/Service":{"id":"components/schemas/Service","kind":"json-schema","title":"Service","data":{"properties":{"code":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for this type of service."},"description":{"maxLength":128,"type":"string","description":"A description of the service."},"proximityCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Proximity code"},"existsInd":{"type":"boolean","description":"If present and true this service exists"},"includedInd":{"type":"boolean","description":"If present and true this service is included with no charge"}},"description":"Any services available at the property."}},"components/schemas/OTA_CodeWithDescription":{"id":"components/schemas/OTA_CodeWithDescription","kind":"json-schema","title":"OTA_CodeWithDescription","data":{"properties":{"value":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for this offering."},"description":{"maxLength":128,"type":"string","description":"Free text description of a given offering."}},"description":"One instance for each feature/service option.","example":"An array of AccessibilityFeature options"}},"components/schemas/GuestRoomInfo":{"id":"components/schemas/GuestRoomInfo","kind":"json-schema","title":"GuestRoomInfo","data":{"properties":{"@type":{"type":"string","example":"GuestRoomInfo"},"code":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for this description."},"number":{"type":"integer","description":"Number of rooms with this feature or type of information.","format":"int32"},"description":{"maxLength":128,"type":"string","description":"Description of the guest room information."}},"description":"One instance for each type of information about the guest rooms.","example":"Total number of rooms or number of floors."}},"components/schemas/YesNoUnknownEnum":{"id":"components/schemas/YesNoUnknownEnum","kind":"json-schema","title":"YesNoUnknownEnum","data":{"type":"string","description":"Yes , No , Unknown","example":"Yes","enum":["Yes","No","Unknown"]}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"required":["@type","City"],"properties":{"@type":{"type":"string","description":"Discriminator classes Address or AddressDetail","example":"AddressDetail"},"id":{"type":"string","description":"unique address id","example":"Address_1"},"BldgRoom":{"$ref":"#/components/schemas/AddressBldgRoom"},"Number":{"$ref":"#/components/schemas/AddressStreetNumber"},"Street":{"maxLength":128,"type":"string","description":"Street name. May also contain the street number when the Number element is missing.","example":"ABC Street"},"AddressLine":{"maxItems":3,"type":"array","description":"Property street address. Used in place of Street and Number. Each element of the array represents an address line.","items":{"maxLength":128,"type":"string","example":"2035 S Havana street"}},"City":{"maxLength":128,"type":"string","description":"Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).","example":"Dublin"},"County":{"maxLength":128,"type":"string","description":"County or Region Name.","example":"Berkshire"},"StateProv":{"$ref":"#/components/schemas/StateProv"},"Country":{"$ref":"#/components/schemas/Country"},"PostalCode":{"maxLength":128,"type":"string","description":"Postal code for the address.","example":"Sl6 1AB"},"Addressee":{"maxLength":37,"type":"string","description":"The name of the company or person to be addressed","example":"ACME INC"},"role":{"$ref":"#/components/schemas/Enum_AddressRole"}},"description":"The property or billing address information.  \nFor Flights Add Traveler sending Address is optional, but when sent it must have the role set to 'Delivery' and include at least one of its objects, such as Number or City.","discriminator":{"propertyName":"@type"}}},"components/schemas/AddressBldgRoom":{"id":"components/schemas/AddressBldgRoom","kind":"json-schema","title":"AddressBldgRoom","data":{"properties":{"value":{"maxLength":128,"type":"string","example":"Moore House"},"buldingInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the information is a building name. When false, it is an apartment or room #"},"children":[]}]}]}],"example":true}},"description":"Address with building and room number"}},"components/schemas/AddressStreetNumber":{"id":"components/schemas/AddressStreetNumber","kind":"json-schema","title":"AddressStreetNumber","data":{"properties":{"value":{"maxLength":128,"type":"string","description":"Street number value.","example":"23B"},"streetNmbrSuffix":{"maxLength":32,"type":"string","description":"Street Number Suffix","example":"B"},"streetDirection":{"maxLength":32,"type":"string","description":"Direction of the Street","example":"NW"},"ruralRouteNmbr":{"pattern":"[0-9]{1,5}","type":"string","description":"RuralRoute Number","example":"76"},"po_Box":{"maxLength":128,"type":"string","description":"PO Box Number","example":"1001"}},"description":"The street number alone is the numerical number that precedes the street name in the address."}},"components/schemas/StateProv":{"id":"components/schemas/StateProv","kind":"json-schema","title":"StateProv","data":{"properties":{"value":{"maxLength":8,"minLength":1,"type":"string","description":"State, province, or region code needed to identify location (typically two characters).","example":"CA"},"name":{"maxLength":512,"type":"string","description":"State, province, or region name needed to identify location.","example":"California"}},"description":"The standard code or abbreviation for the state, province, or region. May also include full length name."}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"properties":{"value":{"pattern":"[a-zA-Z]{2}","type":"string","description":"The ISO 3166 code for the property's address.","example":"US"},"id":{"type":"string","description":"Custom user-assigned identifier for the country.","example":"23"},"name":{"maxLength":128,"type":"string","description":"The full name of the country for the property's address.","example":"United States"},"codeContext":{"maxLength":32,"type":"string","description":"The source of a code, such as the organization that provided the id number","example":"IATA"}},"description":"Contains the information needed to identify a country."}},"components/schemas/Enum_AddressRole":{"id":"components/schemas/Enum_AddressRole","kind":"json-schema","title":"Enum_AddressRole","data":{"type":"string","description":"Defines the type of location the address is assigned to. For TravelAgency address leave blank or use \"Other\".","example":"Business","enum":["Home","Business","Mailing","Delivery","Destination","Other","Billing"]}},"components/schemas/Email":{"id":"components/schemas/Email","kind":"json-schema","title":"Email","data":{"properties":{"value":{"maxLength":128,"type":"string","description":"The email address.","example":"exampledomain@example.com"},"id":{"type":"string","description":"Electronic email addresses, in IETF specified format.","example":"email_1"},"emailType":{"type":"string","description":"Use email type to specify if the email is to be sent \"TO\" or sent \"FROM\"","example":"FROM"},"comment":{"maxLength":4096,"type":"string","description":"Any freeform note for the email, such as its purpose.","example":"work email"},"preferredFormat":{"maxLength":32,"type":"string","description":"Mime media type","example":"text/html"},"shareMarketing":{"$ref":"#/components/schemas/YesNoInheritEnum"},"shareSync":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optOutInd":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optInStatus":{"$ref":"#/components/schemas/OptInStatusEnum"},"optInDate":{"type":"string","description":"The datetime of receiving the opt in notice","format":"date-time","example":"2026-03-03T11:11:00Z"},"optOutDate":{"type":"string","description":"The datetime the opt out notice was received","format":"date-time","example":"2026-03-03T11:11:00Z"},"validInd":{"type":"boolean","description":"If true, this is a valid email address that has been system verified via a successful email transmission.","example":true},"provisionedInd":{"type":"boolean","description":"If true then the email address came from the provisioning process","example":true}},"description":"Electronic email addresses, in IETF specified format.  \nBooking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes.\nFor Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC."}},"components/schemas/YesNoInheritEnum":{"id":"components/schemas/YesNoInheritEnum","kind":"json-schema","title":"YesNoInheritEnum","data":{"type":"string","description":"Used to indicate marketing preferences, Yes, No, Inherit","example":"Yes","enum":["Yes","No","Inherit"]}},"components/schemas/OptInStatusEnum":{"id":"components/schemas/OptInStatusEnum","kind":"json-schema","title":"OptInStatusEnum","data":{"type":"string","description":"Used to indicate marketing preferences, OptIn, OptOut","enum":["OptedIn","OptedOut","Unknown"]}},"components/schemas/PropertyAmenity":{"id":"components/schemas/PropertyAmenity","kind":"json-schema","title":"PropertyAmenity","data":{"properties":{"@type":{"type":"string","example":"PropertyAmenity"},"description":{"maxLength":512,"type":"string","description":"The type of amenity.","example":"Wedding services"},"location":{"maxLength":32,"type":"string","description":"Location of the property"},"Name":{"maxLength":512,"type":"string","description":"Name of the property"},"OperationTimes":{"$ref":"#/components/schemas/OperationTimes"},"Inclusion":{"maxItems":10,"type":"array","items":{"maxLength":32,"type":"string"}},"includedInd":{"type":"boolean","description":"To represent if the Amenity is included in the rate"},"surchargeInd":{"type":"boolean","description":"To represent if the Amenity attracts a surcharge"},"code":{"pattern":"[0-9A-Z]{1,3}(\\\\.[A-Z]{3}(\\\\.X){0,1}){0,1}","type":"string","description":"OTA code used to describe the property amenity.","example":"104"},"category":{"type":"string","description":"Category of amenity.","example":"Meeting Facilities"}},"description":"Each array instance is a specific amenity, such as type of breakfast, spa, or pool."}},"components/schemas/OperationTimes":{"id":"components/schemas/OperationTimes","kind":"json-schema","title":"OperationTimes","data":{"properties":{"@type":{"type":"string","default":"OperationTimes"},"daysOfWeek":{"type":"array","items":{"$ref":"#/components/schemas/DayOfWeekEnum"}},"openTime":{"type":"string","example":"45900"},"closeTime":{"type":"string","example":"06:00:00"}},"description":"The daily times of operation of the location."}},"components/schemas/DayOfWeekEnum":{"id":"components/schemas/DayOfWeekEnum","kind":"json-schema","title":"DayOfWeekEnum","data":{"type":"string","description":"The names of the days of the week.","example":"Saturday","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"components/schemas/PetPolicy":{"id":"components/schemas/PetPolicy","kind":"json-schema","title":"PetPolicy","data":{"required":["allowed"],"properties":{"@type":{"type":"string","example":"PetPolicy"},"allowed":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"policyCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Pet policy code"},"Description":{"$ref":"#/components/schemas/TextTitleAndDescription"}}}},"components/schemas/TextTitleAndDescription":{"id":"components/schemas/TextTitleAndDescription","kind":"json-schema","title":"TextTitleAndDescription","data":{"properties":{"value":{"maxLength":4096,"type":"string","description":"Descriptive text provided by the supplier.","example":"Ticket exchanged, room description text, or check in/out policy details."},"languages":{"type":"array","description":"The language code of the description text.","items":{"type":"string","example":"English"}},"title":{"maxLength":512,"type":"string","description":"Title of the Text","example":"Group details."}},"description":"A descriptive text string and the related language."}},"components/schemas/Restaurant":{"id":"components/schemas/Restaurant","kind":"json-schema","title":"Restaurant","data":{"required":["name"],"properties":{"@type":{"type":"string","example":"Restaurant"},"name":{"maxLength":128,"type":"string","description":"The name of the restaurant"},"cuisineCodes":{"type":"array","description":"An OTA code to define the cuisine type","example":12,"items":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string"}},"proximityCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"An OTA proximity code"},"Distance":{"$ref":"#/components/schemas/Distance"}}}},"components/schemas/Attraction":{"id":"components/schemas/Attraction","kind":"json-schema","title":"Attraction","data":{"required":["name"],"properties":{"@type":{"type":"string","example":"Attraction"},"name":{"maxLength":128,"type":"string","description":"The name of the attraction."},"Distance":{"$ref":"#/components/schemas/Distance"}},"description":"An attraction near the property."}},"components/schemas/TextFree":{"id":"components/schemas/TextFree","kind":"json-schema","title":"TextFree","data":{"properties":{"value":{"maxLength":4096,"type":"string","example":"Additional information"},"language":{"type":"string","description":"Language of the text.","example":"English"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Textual information to provide descriptions and/or additional information."},"children":[]}]}]}]}},"components/schemas/MeetingRooms":{"id":"components/schemas/MeetingRooms","kind":"json-schema","title":"MeetingRooms","data":{"properties":{"@type":{"type":"string","example":"MeetingRooms"},"number":{"type":"integer","format":"int32"},"MeetingRoom":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/MeetingRoom"}}}}},"components/schemas/MeetingRoom":{"id":"components/schemas/MeetingRoom","kind":"json-schema","title":"MeetingRoom","data":{"required":["name"],"properties":{"@type":{"type":"string","example":"MeetingRoom"},"name":{"maxLength":128,"type":"string","description":"The name of the meeting room"},"codes":{"type":"array","description":"OTA code for this room type.","items":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string"}},"capacity":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"unitOfSize":{"$ref":"#/components/schemas/UnitOfSize"}}}},"components/schemas/UnitOfSize":{"id":"components/schemas/UnitOfSize","kind":"json-schema","title":"UnitOfSize","data":{"type":"string","description":"List of units of size i.e Square Feet, Square Meters","enum":["Square Feet","Square Meters"]}},"components/schemas/VirtualTour":{"id":"components/schemas/VirtualTour","kind":"json-schema","title":"VirtualTour","data":{"required":["url"],"properties":{"@type":{"type":"string","example":"VirtualTour"},"url":{"type":"string"},"Description":{"$ref":"#/components/schemas/TextFree"}}}},"components/schemas/CheckInOutPolicy":{"id":"components/schemas/CheckInOutPolicy","kind":"json-schema","title":"CheckInOutPolicy","data":{"required":["checkInTime","checkOutTime"],"properties":{"@type":{"type":"string","example":"CheckInOutPolicy"},"checkInTime":{"pattern":"^(2[0-3]|[01][0-9]):([0-5]?[0-9])$","type":"string","description":"The check-in time, local to the property, in 24 hour format.","example":"900"},"checkOutTime":{"pattern":"^(2[0-3]|[01][0-9]):([0-5]?[0-9])$","type":"string","description":"The check-out time, local to the property, in 24 hour format.","example":"600"},"minimumAge":{"type":"integer","description":"Minimum age to reserve room.","format":"int32","example":18},"Description":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TextTitleAndDescription"}}},"description":"Property check in and out policies."}},"components/schemas/CurrencyAmount":{"id":"components/schemas/CurrencyAmount","kind":"json-schema","title":"CurrencyAmount","data":{"properties":{"value":{"type":"number","description":"The amount of a given currency.","format":"float","example":124.56},"code":{"pattern":"[a-zA-Z]{3}","type":"string","description":"An ISO 4217 alpha character code (3 characters) that specifies a money unit.","example":"USD"},"minorUnit":{"type":"integer","description":"Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit.  \nIt is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit.","format":"int32","example":2},"currencySource":{"$ref":"#/components/schemas/CurrencySourceEnum"},"approximateInd":{"type":"boolean","description":"If true, the currency amount has been converted from the original amount.  \nFor Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion.  \nFor Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property.","example":true}},"description":"A monetary amount, up to 4 decimal places. Decimal place must be included."}},"components/schemas/CurrencySourceEnum":{"id":"components/schemas/CurrencySourceEnum","kind":"json-schema","title":"CurrencySourceEnum","data":{"type":"string","description":"The system requesting or returning the currency code specified in the attribute","example":"Supplier","enum":["Supplier","Charged","Requested"]}},"components/schemas/MaximumAvailableRate":{"id":"components/schemas/MaximumAvailableRate","kind":"json-schema","title":"MaximumAvailableRate","data":{"properties":{"value":{"type":"number","description":"Amount of maximum available rate.","format":"float","example":124.56},"code":{"pattern":"[a-zA-Z]{3}","type":"string","description":"An ISO 4217 alpha character code that specifies a money unit.","example":"USD"},"minorUnit":{"minimum":0,"exclusiveMinimum":false,"pattern":"([0-4])","type":"integer","description":"Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit.","format":"int32","example":2},"authority":{"maxLength":128,"type":"string","description":"Indicates which supplier returned the maximum available rate for that property. Authority is not returned if it matches the value in PropertyInfo.Identifier.authority","example":"TVPT"}},"description":"The hotel's maximum available rate for the property for the requested dates."}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"description":"Base common error response","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/PropertiesQuerySearchWrapper":{"id":"components/schemas/PropertiesQuerySearchWrapper","kind":"json-schema","title":"PropertiesQuerySearchWrapper","data":{"properties":{"PropertiesQuerySearch":{"$ref":"#/components/schemas/PropertiesQuerySearch"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/PropertiesQuerySearch":{"id":"components/schemas/PropertiesQuerySearch","kind":"json-schema","title":"PropertiesQuerySearch","data":{"required":["@type","CheckInDate","CheckOutDate","SearchBy"],"properties":{"@type":{"type":"string","description":"Discriminator class PropertiesQuerySearch only","example":"PropertiesQuerySearch"},"SortOrder":{"$ref":"#/components/schemas/HotelSortOrderEnum"},"CheckInDate":{"type":"string","description":"Check-in date in YYYY-MM-DD format.","format":"date"},"CheckOutDate":{"type":"string","description":"Check-out date in YYYY-MM-DD format.","format":"date"},"ChainCodes":{"type":"array","description":"One to six hotel chain codes to include in the search results. Each chain code is typically two alpha characters. ChainCodes supports the entry of brand codes, which are expanded internally by Travelport into the associated chain codes for that brand.","items":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string"}},"HotelName":{"maxLength":512,"type":"string","description":"Search for properties with a matching hotel name. This string must match as a substring (case insensitive) in a property's name for the property to be returned. Must be at least three characters long. Supported characters are alphanumeric, comma, period, apostrophe, hyphen, semicolon, colon, and space."},"RequestedCurrency":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Send a currency code to request conversion rate information for converting to that currency from the hotel location's currency. The response then returns the CurrencyRateConversion object, which provides the conversion rate of the specified currency that can be used to calculate, independently of the API, the conversion of the rates returned in the response."},"ImageSize":{"$ref":"#/components/schemas/ImageSizeEnum"},"RoomStayCandidate":{"maxItems":10,"type":"array","description":"Contains information associated with room searches.","items":{"$ref":"#/components/schemas/RoomStayCandidate"}},"RateCandidates":{"$ref":"#/components/schemas/RateCandidates"},"SearchBy":{"$ref":"#/components/schemas/SearchBy"},"returnAllImagesInd":{"type":"boolean","description":"If true, returns all property images of the requested ImageSize. If false, returns the best single image. Default behavior is false."},"PropertyAmenityCode":{"type":"array","items":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string"}},"BrandCodes":{"type":"array","description":"The permitted property brand code(s) to be returned for this request","example":"EM, EH","items":{"maxLength":2,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string"}},"returnOnlyAvailablePropertiesInd":{"type":"boolean","description":"If true, returns only properties with current availability for the dates requested. In some cases, fewer than 25 properties per page may be returned. If false, return properties regardless of availability. Default behavior is false."},"AggregatorList":{"type":"array","items":{"$ref":"#/components/schemas/HotelAggregatorCodeEnum"}},"recommendedPropertyAmenitiesInd":{"type":"boolean","description":"If true, a limited set of property amenities will be returned in the response. if false, or omitted a full set of property amenities will be returned in the response."},"applyLenientPropertyListRulesInd":{"type":"boolean","description":"If true, properties are returned by distance from location, some properties in the list will not support any of the negotiated rates in the request."}},"description":"Used for a Hotel Search by Location request. Defines the search criteria, including the type of location to search by (address, coordinates, airport, or city), stay dates, room occupancy details, and optional filtering criteria. This request is usually followed by a Hotel Availability request or optionally a Hotel Details request."}},"components/schemas/HotelSortOrderEnum":{"id":"components/schemas/HotelSortOrderEnum","kind":"json-schema","title":"HotelSortOrderEnum","data":{"type":"string","description":"The method to be used in sorting hotel properties","enum":["StarRating","Proximity"]}},"components/schemas/RoomStayCandidate":{"id":"components/schemas/RoomStayCandidate","kind":"json-schema","title":"RoomStayCandidate","data":{"required":["GuestCounts"],"properties":{"GuestCounts":{"$ref":"#/components/schemas/GuestCounts"},"RoomAmenity":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/RoomAmenity"}}},"description":"Information associated with room searches, such as the number of guests."}},"components/schemas/GuestCounts":{"id":"components/schemas/GuestCounts","kind":"json-schema","title":"GuestCounts","data":{"required":["GuestCount"],"properties":{"@type":{"type":"string","example":"GuestCounts"},"GuestCount":{"maxItems":99,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/GuestCount"}}},"description":"The number and age(s) of guests within the room."}},"components/schemas/GuestCount":{"id":"components/schemas/GuestCount","kind":"json-schema","title":"GuestCount","data":{"properties":{"@type":{"type":"string","example":"GuestCount"},"age":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The age of the guest. Required only when request includes a child in the room.","format":"int32","example":21},"count":{"type":"integer","description":"Number of guests. Supports numeric values 1-9 inclusive.","format":"int32","example":2},"ageQualifyingCode":{"maxLength":32,"type":"string","description":"\"Required only for children or if traveler age is relevant, such as for a senior discount. Supported values include '8' and '10'. 8: Traveler in this GuestCount is a child. 10: Traveler in this GuestCount is an adult.\"","example":"10"}},"description":"Defines the number of guests and their age(s).\n Required for Create Reservation (Full Payload) if children are part of the request."}},"components/schemas/RoomAmenity":{"id":"components/schemas/RoomAmenity","kind":"json-schema","title":"RoomAmenity","data":{"properties":{"@type":{"type":"string","default":"RoomAmenity"},"description":{"maxLength":512,"type":"string","description":"Description of amenity received from supplier.","example":"WiFi"},"quantity":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"quantity of amenity","format":"int32"},"Name":{"maxLength":32,"type":"string","description":"Room Amenity Name","example":"24 hour Room Service"},"Inclusion":{"maxItems":10,"type":"array","items":{"maxLength":32,"type":"string"}},"includedInd":{"type":"boolean","description":"Represents if the amenity is included with the rate"},"surchargeInd":{"type":"boolean","description":"Represents if the amenity attracts a surcharge."},"code":{"pattern":"[0-9A-Z]{1,3}(\\\\.[A-Z]{3}(\\\\.X){0,1}){0,1}","type":"string","description":"OTA code used to describe the room amenity. This is optional in the Properties Search request but mandatory in the response."}},"description":"Room amenity name and description."}},"components/schemas/RateCandidates":{"id":"components/schemas/RateCandidates","kind":"json-schema","title":"RateCandidates","data":{"required":["@type","RateCandidate"],"properties":{"@type":{"type":"string","description":"Discriminator classes RateCandidates and RateCandidatesDetail","example":"RateCandidates"},"RateCandidate":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/RateCandidate"}},"prePayRatesOnlyInd":{"type":"boolean","description":"A prepay rate charges the full amount on the credit card immediately on booking. If true, returns only pre-paid rates. If false, allows the return of all rates."},"postPayRatesOnlyInd":{"type":"boolean","description":"A postpay rate (most common in the US) charges the credit card at the property when the guest checks in. If true, returns only post-paid rates. If false, allows the return of all rates."},"removeSpecialRatesInd":{"type":"boolean","description":"Used to request the removal of rate category (Promotional/Package/etc.) rates that may have been returned by the supplier as typical published rates. If true, removes all rate category type rates (except for negotiated rates). If true but one or more specific rate categories are requested, then this indicator is ignored and the rate category is applied. If false, allows the return of all rates returned by the supplier with no filtering. Default behavior is false."}},"description":"For a Hotel Search request: up to eight negotiated rate codes and/or one frequent guest number. For a Hotel Availability request: rate plans, access codes, and rate categories - send only if requesting rate plans.","discriminator":{"propertyName":"@type"}}},"components/schemas/RateCandidate":{"id":"components/schemas/RateCandidate","kind":"json-schema","title":"RateCandidate","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes RateCandidate and RateCandidateDetail","example":"RateCandidateDetail"},"priority":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"A rate candidate priority","format":"int32"},"rateCode":{"maxLength":6,"minLength":3,"type":"string","description":"\"The negotiated rateCode to be applied to the request. \nFor Hotel Availability, each rateCode must be associated with a chainCode, propertyCode, and a rateCategory of 'Multi-level/Negotiated/Secure'. \nFor Hotel Rules, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/value.\"","example":"HL123"},"rateCategory":{"$ref":"#/components/schemas/RateCategoryEnum"},"chainCode":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string","description":"Code for the hotel chain (typically 2 characters)","example":"UR"},"propertyCode":{"maxLength":32,"type":"string","description":"The property code of the requested property (typically 5 characters).","example":"G3375"},"masterRateCode":{"maxLength":6,"minLength":6,"type":"string","description":"An agency-created rate code that can be translated into up to 12 negotiated rate codes. If masterRateCode is sent, any additional rateCodes will be ignored.","example":"1ABC23"}},"description":"Rate plan details and/or frequent guest number, if requesting. \nFor Hotel Availability, the values required differ according to whether you are sending a negotiated rate code or a rate category. Send one instance of RateCandidate for each rate plan to request. To include CustomerLoyalty, use RateCandidateDetail.\n \nFor Hotel Rules, include the values for the offer you want to request rules on, if returned in the Availability response. May include rateCode, rateID, rateCategory, chainCode, and propertyCode","discriminator":{"propertyName":"@type"}}},"components/schemas/RateCategoryEnum":{"id":"components/schemas/RateCategoryEnum","kind":"json-schema","title":"RateCategoryEnum","data":{"type":"string","description":"For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested.\nFor a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory.","example":"Discount","enum":["All","Association","Business","BusinessStandard","Club","Convention","Corporate","Consortiums","Discount","Credential","Employee","FamilyPlan","FullInclusive","Government","Inclusive","Industry/TravelAgentRate","Leisure","Military","Monthly","Multi-DayPackage","MultLevel/Negotiated/Secure","Other","Package","PrePaid","Promotional","RackGeneral","SeniorCitizen","Standard","Tour","VIP","Weekend","Weekly"],"x-enumDescriptions":{"All":"Includes all available rate categories.","Association":"Rates offered to members of specific associations or organizations.","Business":"Deprecated.","BusinessStandard":"Deprecated.","Club":"Rates for members of exclusive clubs or loyalty programs.","Convention":"Special rates for attendees of a specific convention or event.","Corporate":"Rates negotiated by companies for their employees.","Consortiums":"Deprecated.","Discount":"Deprecated.","Credential":"Deprecated.","Employee":"Deprecated.","FamilyPlan":"Rates for employees of the hotel or affiliated companies.","FullInclusive":"Deprecated.","Government":"Rates available to government employees or officials.","Inclusive":"Deprecated.","Industry/TravelAgentRate":"Special rates for travel industry professionals.","Leisure":"Deprecated.","Military":"Rates for active duty or retired military personnel.","Monthly":"Deprecated.","Multi-DayPackage":"Rates bundled with multi-day activities or services.","MultiLevel/Negotiated/Secure":"Special negotiated or tiered rates, often requiring authentication.","Other":"Deprecated.","Package":"Rates bundled with other services like tours or meals.","PrePaid":"Deprecated.","Promotional":"Limited-time or marketing-driven discounted rates.","RackGeneral":"Deprecated.","SeniorCitizen":"Discounted rates for senior travelers.","Standard":"Deprecated.","Tour":"Rates for travelers booking as part of a tour group.","VIP":"Deprecated.","Weekend":"Special rates for weekend stays.","Weekly":"Deprecated."}}},"components/schemas/SearchBy":{"id":"components/schemas/SearchBy","kind":"json-schema","title":"SearchBy","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes SearchByGeoLocation, SearchByAddress, SearchByAirport, and SearchByCity","example":"SearchByAirport"},"SearchRadius":{"$ref":"#/components/schemas/Distance"}},"description":"Search for Hotels, based on the type of location: 1) geographic coordinates, 2) address, 3) IATA airport code, or 4) IATA city code.","discriminator":{"propertyName":"@type"}}},"components/schemas/HotelAggregatorCodeEnum":{"id":"components/schemas/HotelAggregatorCodeEnum","kind":"json-schema","title":"HotelAggregatorCodeEnum","data":{"type":"string","description":"Restrict the search to a specific aggregator. You must be authorized for any aggregator selected.","enum":["TVPT","BKNG","ETGR","EXPE","BNTL"],"x-enumDescriptions":{"TVPT":"Travelport","BKNG":"Booking.com","ETGR":"EmergingTravel","EXPE":"not supported","BNTL":"not supported"}}},"components/schemas/PropertiesQuerySpecificPropertyListWrapper":{"id":"components/schemas/PropertiesQuerySpecificPropertyListWrapper","kind":"json-schema","title":"PropertiesQuerySpecificPropertyListWrapper","data":{"properties":{"PropertiesQuerySpecificPropertyList":{"$ref":"#/components/schemas/PropertiesQuerySpecificPropertyList"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/PropertiesQuerySpecificPropertyList":{"id":"components/schemas/PropertiesQuerySpecificPropertyList","kind":"json-schema","title":"PropertiesQuerySpecificPropertyList","data":{"required":["@type","PropertyKey","checkinDate","checkoutDate","numberOfGuests"],"properties":{"@type":{"type":"string","description":"Discriminator class PropertiesQuerySpecificPropertyList only","example":"PropertiesQuerySpecificPropertyList"},"checkinDate":{"type":"string","description":"Check-in date in YYYY-MM-DD format.","format":"date"},"checkoutDate":{"type":"string","description":"Check-out date in YYYY-MM-DD format.","format":"date"},"numberOfGuests":{"type":"integer","description":"Number of travelers. Must be a numeric value between 1 and 9. Send the total number of guests across all counts in RoomStayCandidate/GuestCount.","format":"int32"},"requestedCurrency":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Send a currency code to request conversion rate information for converting to that currency from the hotel location's currency. The response then returns the CurrencyRateConversion object, which provides the conversion rate of the specified currency that can be used to calculate, independently of the API, the conversion of the rates returned in the response."},"minimumRate":{"type":"number","description":"Minimum rate","format":"float"},"maximumRate":{"type":"number","description":"Maximum rate","format":"float"},"numberOfRooms":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"Number of rooms","format":"int32"},"PropertyKey":{"maxItems":250,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PropertyKey"}},"RateCandidates":{"$ref":"#/components/schemas/RateCandidates"},"imageSize":{"$ref":"#/components/schemas/ImageSizeEnum"},"RoomStayCandidates":{"$ref":"#/components/schemas/RoomStayCandidates"},"returnAllImagesInd":{"type":"boolean","description":"If true, returns all property images of the requested ImageSize. If false, returns the best single image. Default behavior is false."},"AggregatorList":{"type":"array","items":{"$ref":"#/components/schemas/HotelAggregatorCodeEnum"}},"recommendedPropertyAmenitiesInd":{"type":"boolean","description":"if true, a limited set of property amenities will be returned in the response. if false, or omitted a full set of property amenities will be returned in the response."}},"description":"Used for a Hotel Search by ID request. Defines a request to search for specific hotel properties by their property IDs on given stay dates. This request typically starts the hotel shopping workflow when the property IDs are already known and is usually followed by a Hotel Availability request or optionally a Hotel Details request."}},"components/schemas/RoomStayCandidates":{"id":"components/schemas/RoomStayCandidates","kind":"json-schema","title":"RoomStayCandidates","data":{"required":["RoomStayCandidate"],"properties":{"RoomStayCandidate":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/RoomStayCandidate"}}},"description":"Includes traveler information."}},"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper":{"id":"components/schemas/CatalogOfferingsQueryRequestHospitalityWrapper","kind":"json-schema","title":"CatalogOfferingsQueryRequestHospitalityWrapper","data":{"properties":{"CatalogOfferingsQueryRequest":{"$ref":"#/components/schemas/CatalogOfferingsQueryRequest"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/CatalogOfferingsQueryRequest":{"id":"components/schemas/CatalogOfferingsQueryRequest","kind":"json-schema","title":"CatalogOfferingsQueryRequest","data":{"required":["@type","CatalogOfferingsRequest"],"properties":{"@type":{"type":"string","description":"Discriminator class CatalogOfferingsRequestHospitality","example":"CatalogOfferingsRequestHospitality"},"CatalogOfferingsRequest":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CatalogOfferingsRequestHospitality"}}},"description":"Used for a Hotel Availability request. Defines a request to retrieve available room types and rates for one or more specified hotel properties on given stay dates. This request typically follows a Hotel Search request and is sent before booking."}},"components/schemas/CatalogOfferingsRequestHospitality":{"id":"components/schemas/CatalogOfferingsRequestHospitality","kind":"json-schema","title":"CatalogOfferingsRequestHospitality","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOfferingsRequest"},{"required":["StayDates"],"properties":{"requestedCurrency":{"pattern":"[a-zA-Z]{3}","type":"string","description":"If sent, the response includes a currency rate conversion value from the local currency to the currency specified. This value can be applied to the hotel's local pricing to convert rates; the API does not convert any amounts."},"maxResponseWaitTime":{"type":"integer","description":"Supports a timeout in milliseconds when requesting availability for multiple properties. If sent, the request times out at the specified time and returns all properties retrieved at that point.","format":"int32"},"StayDates":{"$ref":"#/components/schemas/DateOrDateWindows"},"HotelSearchCriterion":{"$ref":"#/components/schemas/HotelSearchCriterion"},"MinimumAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"MaximumAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"verboseResponseInd":{"type":"boolean","description":"Used to indicate whether to group common property details. If true, disables the grouping of common property details in the response's ReferenceList object and instead returns them for each property in Offer/Products/Product. In this case ProductHospitality is returned. If false, returns common details across properties in a ReferenceList object with a cross-reference for each offer. For this case ProductHospitalityOffer will be returned. Default behavior is false."},"recommendedRoomAmenitiesInd":{"type":"boolean","description":"if true, a limited set of room amenities will be returned in the response. if false, or omitted a full set of room amenities will be returned in the response."}}}]}},"components/schemas/CatalogOfferingsRequest":{"id":"components/schemas/CatalogOfferingsRequest","kind":"json-schema","title":"CatalogOfferingsRequest","data":{"properties":{"@type":{"type":"string","example":"CatalogOfferingsRequestHospitality"},"SearchControlConsoleChannelID":{"$ref":"#/components/schemas/SearchControlConsoleChannelID"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/SearchControlConsoleChannelID":{"id":"components/schemas/SearchControlConsoleChannelID","kind":"json-schema","title":"SearchControlConsoleChannelID","data":{"properties":{"value":{"maxLength":32,"type":"string","description":"String for the Content Optimizer channel ID.","example":"IBM"},"sccType":{"maxLength":32,"type":"string","description":"String for the Content Optimizer type.","example":"999"}},"description":"The Search API supports the Travelport Content Optimizer (formerly known as Search Control Console/SCC) for GDS content only.  \nSend either the value or the sccType. If both values are sent, the sccType is applied.  \nTravel agency administrators use Content Optimizer to create business rules for filtering certain air shopping results. If your client's application does not use Content Optimizer, do not use these attributes.  \nContact your Travelport representative if you would like additional information.   "}},"components/schemas/DateOrDateWindows":{"id":"components/schemas/DateOrDateWindows","kind":"json-schema","title":"DateOrDateWindows","data":{"properties":{"specific":{"type":"string","description":"A specific date in YYYY-MM-DD format. When used within a window, must fall between start and end.","format":"date","example":"2026-03-03"},"start":{"type":"string","description":"For Air, the earliest date acceptable for the start date.  \nFor Hotel, the check-in, cancellation, or penalty deadline date. Format YYYY-MM-DD. Used with end to designate a range of dates.","format":"date","example":"2026-03-03"},"end":{"type":"string","description":"For Air, the latest date acceptable for the end date.  \nFor Hotel, the check-out, cancellation, or penalty deadline date. Format YYYY-MM-DD.","format":"date","example":"2026-03-03"},"duration":{"type":"string","description":"Duration from start date.","example":"P1D"},"durationUnit":{"$ref":"#/components/schemas/DurationUnitEnum"}},"description":"Indicates a date, such as check-in, check-out, deadline, or expiry date."}},"components/schemas/DurationUnitEnum":{"id":"components/schemas/DurationUnitEnum","kind":"json-schema","title":"DurationUnitEnum","data":{"type":"string","description":"Defines the Units that can be applied to Stay restrictions.","example":"Months","enum":["Minutes","Hours","Days","Months","MON","TUES","WED","THU","FRI","SAT","SUN"]}},"components/schemas/HotelSearchCriterion":{"id":"components/schemas/HotelSearchCriterion","kind":"json-schema","title":"HotelSearchCriterion","data":{"required":["PropertyRequest"],"properties":{"@type":{"type":"string","example":"HotelSearchCriterion"},"numberOfRooms":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"Number of rooms requested at a single property. Supports values 1-9 inclusive.","format":"int32"},"PropertyRequest":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PropertyRequest"}},"RoomStayCandidates":{"$ref":"#/components/schemas/RoomStayCandidates"},"RateCandidates":{"$ref":"#/components/schemas/RateCandidates"},"AggregatorList":{"type":"array","items":{"$ref":"#/components/schemas/HotelAggregatorCodeEnum"}},"ExtraAccommodation":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ExtraAccommodation"}}}}},"components/schemas/PropertyRequest":{"id":"components/schemas/PropertyRequest","kind":"json-schema","title":"PropertyRequest","data":{"required":["PropertyKey"],"properties":{"@type":{"type":"string","example":"PropertyRequest"},"moreRatesToken":{"maxLength":512,"type":"string","description":"More rates token"},"PropertyKey":{"$ref":"#/components/schemas/PropertyKey"}},"description":"Property details for each property requested, up to 10 properties. Send a separate instance of PropertyRequest for each property."}},"components/schemas/ExtraAccommodation":{"id":"components/schemas/ExtraAccommodation","kind":"json-schema","title":"ExtraAccommodation","data":{"required":["@type","AccommodationType","quantity"],"properties":{"@type":{"type":"string","example":"ExtraAccommodation"},"quantity":{"type":"integer","description":"The quantity.","format":"int32"},"AccommodationType":{"$ref":"#/components/schemas/ExtraAccomodationENUM"}}}},"components/schemas/ExtraAccomodationENUM":{"id":"components/schemas/ExtraAccomodationENUM","kind":"json-schema","title":"ExtraAccomodationENUM","data":{"type":"string","enum":["Crib","ExtraAdult","ExtraChild","RollawayAdult","RollawayChild"]}},"components/schemas/CatalogOfferingsHospitalityResponseWrapper":{"id":"components/schemas/CatalogOfferingsHospitalityResponseWrapper","kind":"json-schema","title":"CatalogOfferingsHospitalityResponseWrapper","data":{"properties":{"CatalogOfferingsHospitalityResponse":{"$ref":"#/components/schemas/CatalogOfferingsHospitalityResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/CatalogOfferingsHospitalityResponse":{"id":"components/schemas/CatalogOfferingsHospitalityResponse","kind":"json-schema","title":"CatalogOfferingsHospitalityResponse","data":{"properties":{"@type":{"type":"string","default":"CatalogOfferingsHospitalityResponse"},"CatalogOfferings":{"$ref":"#/components/schemas/CatalogOfferings"}},"description":"The response of a Catalog Offerings hospitality endpoint request. By default, common information from each room offer is consolidated into the single object ReferenceList. If the optional verboseResponseInd indicator is sent in the request, ReferenceList is not returned and common property details are not grouped.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/CatalogOfferings":{"id":"components/schemas/CatalogOfferings","kind":"json-schema","title":"CatalogOfferings","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOfferingsID"},{"required":["CatalogOffering"],"properties":{"totalCatalogOffering":{"type":"integer","description":"Total number of rates available for this request.","format":"int32"},"catalogOfferingPerPage":{"type":"integer","description":"Total number of rates returned per page.","format":"int32"},"numberOfPages":{"type":"integer","description":"Total number of pages created by this request.","format":"int32","example":5},"CatalogOffering":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CatalogOffering"}},"AncillaryOffering":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AncillaryOfferingID"}}}}]}},"components/schemas/CatalogOfferingsID":{"id":"components/schemas/CatalogOfferingsID","kind":"json-schema","title":"CatalogOfferingsID","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"CatalogOfferings"},"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"CatalogOfferings_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/CatalogOffering":{"id":"components/schemas/CatalogOffering","kind":"json-schema","title":"CatalogOffering","data":{"description":"For Hotels, each instance returns information related to one bookable room, at a unique rate. A response returns a maximum of 100 rates. The first rate in the list is the single lowest rate returned no matter how many aggregators respond. The remaining rates are grouped in the order of rates returned from Travelport, followed by rates returned from Booking.com.","allOf":[{"$ref":"#/components/schemas/CatalogOfferingID"},{"required":["Price","ProductOptions"],"properties":{"ProductOptions":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductOptions"}},"Price":{"$ref":"#/components/schemas/PriceDetail"},"TermsAndConditions":{"$ref":"#/components/schemas/TermsAndConditions"}}}]}},"components/schemas/CatalogOfferingID":{"id":"components/schemas/CatalogOfferingID","kind":"json-schema","title":"CatalogOfferingID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Availability child class is CatalogOfferingHospitality."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExchangeSearch child class is CatalogOfferingModify."},"children":[]}]}]}]}],"example":"CatalogOffering"},"id":{"type":"string","description":"Unique offer identifier that can be sent in subsequent payload requests to reference this offer. \nFor Hotel Availability, offers are cached for 30 minutes. If a Rules request or Reservation is not created within 30 minutes, a new Availability request must be sent.","example":"108c5875-c822-4d2e-bb9f-c96368100f4a:a709ffcdc1f681c5cf3f1d7da1a8ebfc"},"CatalogOfferingRef":{"type":"string","description":"Used to reference another instance of this object in the same message","example":"co1"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"ContentSource":{"$ref":"#/components/schemas/ContentSourceEnum"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ContentSourceEnum":{"id":"components/schemas/ContentSourceEnum","kind":"json-schema","title":"ContentSourceEnum","data":{"type":"string","description":"Indicates the owner the offer or document.","example":"GDS","enum":["GDS","NDC","LCC","API"],"x-enumDescriptions":{"GDS":"Use for GDS sourced transactions","NDC":"Use for NDC sourced transactions","LCC":"Do not use - replaced by API","API":"Use for all other API sourced transactions including low cost carriers"}}},"components/schemas/ProductOptions":{"id":"components/schemas/ProductOptions","kind":"json-schema","title":"ProductOptions","data":{"allOf":[{"$ref":"#/components/schemas/ProductOptionsID"},{"required":["Product"],"properties":{"sequence":{"type":"integer","description":"NonnegativeInteger","format":"int32","example":1},"Product":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductID"}}}}]}},"components/schemas/ProductOptionsID":{"id":"components/schemas/ProductOptionsID","kind":"json-schema","title":"ProductOptionsID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ProductOptionsID and ProductOptions.","example":"ProductOptions"},"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"ProductOptions_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"ProductOptionsRef":{"type":"string","description":"Used to reference another instance of this object in the same message","example":"ProductOptions_1"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ProductID":{"id":"components/schemas/ProductID","kind":"json-schema","title":"ProductID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search child classes are ProductAir and ProductAncillary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Search child class is ProductAir."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary Search child class is ProductAncillary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seat Map child class is ProductSeatAvailability."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Price child classes are ProductAir and ProductAncillary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Availability child classes are ProductHospitality and ProductHospitalityOffer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Rules and HotelReservation child classes are ProductHospitality."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All Vehicle APIs child classes are ProductVehicle and ProductAncillaryVehicle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation and Reservation Workbench child classes are ProductAir, ProductAncillary, ProductHospitality, ProductVehicle, and ProductAncillaryVehicle."},"children":[]}]}]}]}],"example":"ProductAir"},"id":{"type":"string","description":"Local id within a given message to support referencing this object.","example":"product_1"},"productRef":{"type":"string","description":"Reference id that corresponds to the product 'id' in ReferenceListProduct.Product. To find flight details for a product, use the ProductRef id to identify the product in ReferenceListProduct.Product, and use the Flight id's (e.g., s3, s4) to match to flight information in ReferenceListFlight.Flight.","example":"product_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Parent class for Product information. One instance is given for each product.","discriminator":{"propertyName":"@type"}}},"components/schemas/PriceDetail":{"id":"components/schemas/PriceDetail","kind":"json-schema","title":"PriceDetail","data":{"description":"Child class of Price. This includes all of the Price object plus the Pricebreakdown which gives detailed Price information per PTC or Hotel offering.  \nFor a Hotels Create Reservation (Full Payload) request, find the values to send in the Price objects from either Availability (returned in CatalogOffering/Price) or Rules (returned in Offer/Price). Although you can send the price returned in either API, the Rules pricing may be more accurate. If you sent a Rules request, send the value from that response. You must include CurrencyCode, Base, TotalTaxes, and TotalPrice. When returned from the previous steps, additionally send TermsAndConditionsFull, ProductRateCodeInfo, and RateCodeInfo.","allOf":[{"$ref":"#/components/schemas/Price"},{"properties":{"FlightPassCredits":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the number of flight pass credits the offer “costs” for all passengers. Air Canada NDC only."},"children":[]}]}]}],"format":"int32","example":2},"PriceBreakdown":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Price or PriceDetail","example":"PriceDetail"},"id":{"type":"string","description":"Internally referenced id","example":"2"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"Base price before taxes and fees.  \nFor Hotel, may not be returned by all suppliers.","format":"float","example":20.2},"TotalTaxes":{"type":"number","description":"Total taxes applied to the base price.  \nFor Hotel, may not be returned by all suppliers.","format":"float","example":34.4},"TotalFees":{"type":"number","description":"Total fees included in Total Price.","format":"float","example":201},"TotalPrice":{"type":"number","description":"Total price of this offer including the base price and all taxes and fees.","format":"float","example":34},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"description":"Price includes a summary of the Base, Taxes, and Fees applicable to the offer in the currency indicated.  \nThe amounts in Base, TotalTaxes, TotalFees, and TotalPrice are inclusive of all travelers across all PTCs. The amounts in PriceBreakdown apply to one traveler with the PTC returned in that instance.  ","discriminator":{"propertyName":"@type"}}},"components/schemas/VendorCurrencyTotal":{"id":"components/schemas/VendorCurrencyTotal","kind":"json-schema","title":"VendorCurrencyTotal","data":{"properties":{"@type":{"type":"string","default":"VendorCurrencyTotal"},"currencySource":{"$ref":"#/components/schemas/CurrencySourceEnum"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight.","format":"float","example":120.2},"Taxes":{"$ref":"#/components/schemas/Taxes"},"Fees":{"$ref":"#/components/schemas/Fees"},"Total":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the total price including base + taxes + fees"},"children":[]}]}]}],"format":"float","example":30.13},"approximateInd":{"type":"boolean","description":"True if this amount has been converted from the original amount","example":true}},"description":"No longer used. Previously used to expose the local vendor currency when it is different to the purchased currency","deprecated":true}},"components/schemas/Taxes":{"id":"components/schemas/Taxes","kind":"json-schema","title":"Taxes","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class is TaxesDetail","example":"TaxesDetail"},"TotalTaxes":{"type":"number","description":"A monetary amount, representing the total of all taxes included in this offer. Supports up to 4 decimal places; decimal place must be included.","format":"float","example":330.1},"TaxInfo":{"maxItems":10,"type":"array","description":"Returned for TripChange APIS only.","items":{"$ref":"#/components/schemas/TaxInfo"}}},"description":"Summary of all individual taxes. Child class TaxesDetail provides the breakdown of individual taxes.","discriminator":{"propertyName":"@type"}}},"components/schemas/TaxInfo":{"id":"components/schemas/TaxInfo","kind":"json-schema","title":"TaxInfo","data":{"required":["Amount","TaxBreakdown","TaxCode"],"properties":{"@type":{"type":"string","example":"TaxInfo"},"TaxCode":{"type":"string","description":"The tax code","example":"XF"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Amount":{"type":"number","description":"The amount of the tax applied","format":"float"},"TaxBreakdown":{"maxItems":20,"type":"array","description":"The breakdown of the tax for this tax code","items":{"$ref":"#/components/schemas/TaxBreakdown"}}},"description":"Provides detailed information on tax breakdown when the tax code is common and is made up of multiple amounts. Used in TripChange APIS only."}},"components/schemas/TaxBreakdown":{"id":"components/schemas/TaxBreakdown","kind":"json-schema","title":"TaxBreakdown","data":{"required":["AirportCode"],"properties":{"@type":{"type":"string","example":"TaxInfo"},"AirportCode":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The airport location the tax applies to","example":"MIA"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Amount":{"type":"number","description":"The amount of the tax applied","format":"float"}},"description":"The tax breakdown of XF style taxes"}},"components/schemas/Fees":{"id":"components/schemas/Fees","kind":"json-schema","title":"Fees","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child class FeesDetail","example":"FeesDetail"},"TotalFees":{"type":"number","description":"Total fees included in the TotalPrice. Supports up to 4 decimal places; decimal place needs to be included.","format":"float","example":111.11},"TotalAdditionalFeesPayableLocally":{"type":"number","description":"Fees due separately at the property. Expected to be paid in local currency. These fees are not included in the Offer TotalPrice.","format":"float","example":2.1}},"description":"Includes TotalFees object to return the sum total of any fees.  \nMay include array of Fee objects to break down individual fees.  \nChild class FeesDetail may also include a breakdown of the individual fees.","discriminator":{"propertyName":"@type"}}},"components/schemas/PriceBreakdown":{"id":"components/schemas/PriceBreakdown","kind":"json-schema","title":"PriceBreakdown","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search and Air Price APIs child classes are PriceBreakdownAir and PriceBreakdownAncillary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Ancillaries and Seat Availabilities child classes are PriceBreakdown, PriceBreakdownAncillary, and PriceBreakdownAncillaryAir."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All Hotel API child classes are PriceBreakdownHospitality."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vehicle API child classes are PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation and Reservation Workbench APIs are PriceBreakdownAir, PriceBreakdownAncillary, PriceBreakdownHospitality, PriceBreakdownVehicleCharges, PriceBreakdownVehicleDeposit, PriceBreakdownVehiclePrice, and PriceBreakdownAncillaryVehicle."},"children":[]}]}]}]}],"example":"PriceBreakdownAir"},"Amount":{"$ref":"#/components/schemas/Amount"},"Commission":{"$ref":"#/components/schemas/Commission"}},"description":"Contains a detailed breakdown of the Price provided for each PTC or each Traveler. The information returned may vary by provider and location.","discriminator":{"propertyName":"@type"}}},"components/schemas/Amount":{"id":"components/schemas/Amount","kind":"json-schema","title":"Amount","data":{"properties":{"@type":{"type":"string","default":"Amount"},"currencySource":{"$ref":"#/components/schemas/CurrencySourceEnum"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"The base price prior to all applicable taxes or fees of a product, such as the amount for a room or fare for a flight (one passenger).","format":"float","example":120.2},"Taxes":{"$ref":"#/components/schemas/Taxes"},"Fees":{"$ref":"#/components/schemas/Fees"},"Total":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the total price including base + taxes + fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In PriceBreakdownHospitality, this total is for a given group of nights."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In PriceBreakdownAir this is the total of base cost and all fees and taxes for one passenger of this PTC type."},"children":[]}]}]}],"format":"float","example":230.13},"approximateInd":{"type":"boolean","description":"if true this amount has been converted from the original amount","example":true}},"description":"Amount represents the cost applied"}},"components/schemas/Commission":{"id":"components/schemas/Commission","kind":"json-schema","title":"Commission","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes CommissionAmount or CommissionPercent","example":"CommissionAmount"},"application":{"$ref":"#/components/schemas/CommissionEnum"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDS only; not supported for NDC."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commission information."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount and the Amount object)."},"children":[]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/CommissionEnum":{"id":"components/schemas/CommissionEnum","kind":"json-schema","title":"CommissionEnum","data":{"type":"string","description":"Type of commission","example":"Full","enum":["Full","Partial","Non-paying","No-show","Adjustment","Commissionable"],"x-enumDescriptions":{"Commissionable":"Indicates the rate pays commission.","Non-paying":"Indicates no commission."}}},"components/schemas/TermsAndConditions":{"id":"components/schemas/TermsAndConditions","kind":"json-schema","title":"TermsAndConditions","data":{"description":"Terms And Conditions that apply to an offer.","allOf":[{"$ref":"#/components/schemas/TermsAndConditionsID"},{"properties":{"ExpiryDate":{"type":"string","description":"The date and time in UTC the offer will expire. Not returned in GDS Search. NDC generally allows 20 to 30 minutes to create a booking (the offer time limit). That time limit varies by airline and is returned here in the Search response.","format":"date-time","example":"2022-08-07T12:12:00Z"},"CustomerLoyalty":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyalty"}}}}]}},"components/schemas/TermsAndConditionsID":{"id":"components/schemas/TermsAndConditionsID","kind":"json-schema","title":"TermsAndConditionsID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search child classes are TermsAndConditionsAir and TermsAndConditionsAncillary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Search child class is TermsAndConditionsAirChange."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Ancillaries and Seat Availabilities child classes are TermsAndConditions, TermsAndConditionsAncillary, and TermsAndConditionsAncillaryAir."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Availability child class is TermsAndConditionsHospitality."},"children":[]}]}]}]}],"example":"TermsAndConditionsAir"},"id":{"type":"string","description":"Local id within a given message to support referencing this object. For Air Search APIs, matches to the reference value in ProductBrandOffering/TermsAndConditions/termsAndConditionsRef in instances of ProductBrandOptions.","example":"TC_1"},"termsAndConditionsRef":{"type":"string","description":"Reference id that corresponds to the TermsAndConditions 'id' in ReferenceListTermsAndConditions.TermsAndConditions.","example":"TC_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/CustomerLoyalty":{"id":"components/schemas/CustomerLoyalty","kind":"json-schema","title":"CustomerLoyalty","data":{"required":["value"],"properties":{"value":{"maxLength":1000,"minLength":1,"type":"string","description":"Number on loyalty card.","example":"132456"},"id":{"type":"string","description":"Optional Customer Loyalty Id. Not saved","example":"Loyalty_1"},"priority":{"type":"integer","description":"Optional Numeric Priority Code","format":"int32","example":2},"programId":{"maxLength":128,"type":"string","description":"Specifies an identifier to indicate the company owner of the loyalty program. Typically two characters.  \nFor frequent guest number, the hotel supplier or brand code.  \nFor frequent flyer number, the air supplier code of the loyalty program.","example":"HY"},"programName":{"maxLength":128,"type":"string","description":"Supplier's loyalty program name.","example":"Frontier-EarlyReturns"},"supplierType":{"maxLength":32,"type":"string","description":"The type of supplier of a loyalty program. Uses 'hotel' for frequent guest number or 'air' for frequent flyer number.","example":"Hotel"},"supplier":{"maxLength":128,"type":"string","description":"Supplier of a loyalty program (typically 2 characters representing the hotel, brand, or airline).","example":"UA"},"tier":{"maxLength":32,"type":"string","description":"Customer Loyalty tier","example":"Silver"},"shareWithSupplier":{"type":"array","description":"The list of suppliers that the CustomerLoyalty number is shared. Used for cross accrual programs.  \nIf valid carrier codes are not sent, the response returns the message NO CROSS ACCRUAL AGREEMENT EXISTS.","items":{"maxLength":32,"type":"string","example":"[\"AF\",\"KL\"]"}},"cardHolderName":{"maxLength":128,"type":"string","description":"Customer loyalty member name; up to 128 characters are supported. In Air Search, for discounted offers to be returned, the name must be sent as LAST FIRST; e.g., if SMITH is the last name and JORDAN the first name, send as SMITH JORDAN","example":"John Smith"},"validatedInd":{"type":"boolean","description":"Customer loyalty number has been validated by the supplier","example":true},"prefix":{"maxLength":10,"type":"string","description":"The cardholder name prefix title like Mr, Mrs, Dr","example":"Dr"},"given":{"maxLength":30,"type":"string","description":"The First Name of the Cardholder","example":"John"},"middle":{"maxLength":30,"type":"string","description":"Middle Name of the Cardholder","example":"Wilkinson"},"surname":{"maxLength":30,"minLength":1,"type":"string","description":"Last Name of the Cardholder","example":"Smith"}},"description":"Specifies the ID for the membership program. Object for sending customer loyalty information, such as for a frequent flyer program.  \nFor Hotel send the loyalty card number in the value field, followed by programID with the hotel chain code, and supplierType: Hotel.  \nFor Air send the loyalty card number in the value field, followed by airline code in \"supplier\".  For cross accrual use the \"shareWithSupplier\" field to submit to partner airlines.  \nIf CustomerLoyalty is sent in the AirSearch request, it must also be sent in the AirPrice request and the Add Traveler request. Because some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure.  \nIf an invalid number is sent, the response returns a warning message that the FQTV (frequent traveler) is invalid, and the invalid number is cached to prevent a potential booking failure."}},"components/schemas/AncillaryOfferingID":{"id":"components/schemas/AncillaryOfferingID","kind":"json-schema","title":"AncillaryOfferingID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AncillaryOfferingID and AncillaryOffering","example":"AncillaryOffering"},"id":{"type":"string","description":"Local identifier within a given message for this object."},"CatalogOfferingRef":{"type":"string","description":"Used to reference another instance of this object in the same message"},"AncillaryOfferingRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}}}},"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper":{"id":"components/schemas/OfferQueryBuildFromCatalogOfferingWrapper","kind":"json-schema","title":"OfferQueryBuildFromCatalogOfferingWrapper","data":{"properties":{"OfferQueryBuildFromCatalogOffering":{"$ref":"#/components/schemas/OfferQueryBuildFromCatalogOffering"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/OfferQueryBuildFromCatalogOffering":{"id":"components/schemas/OfferQueryBuildFromCatalogOffering","kind":"json-schema","title":"OfferQueryBuildFromCatalogOffering","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryBuildFromCatalogOffering only","example":"OfferQueryBuildFromCatalogOffering"},"BuildFromCatalogOfferingHospitality":{"$ref":"#/components/schemas/BuildFromCatalogOfferingHospitality"}},"description":"Used for a Hotel Rules (Reference Payload) request. Defines a request to retrieve the rules associated with a specific rate by referencing a selected offer from a preceding Hotel Availability response. This request is typically sent directly after Hotel Availability and before booking. If the cached offer expires, a new Hotel Availability request must be sent."}},"components/schemas/BuildFromCatalogOfferingHospitality":{"id":"components/schemas/BuildFromCatalogOfferingHospitality","kind":"json-schema","title":"BuildFromCatalogOfferingHospitality","data":{"properties":{"@type":{"type":"string","example":"BuildFromCatalogOfferingHospitality"},"CatalogOfferingIdentifier":{"$ref":"#/components/schemas/Identifier"},"SpecialInstruction":{"maxLength":50,"type":"string","description":"Customer generated special instructions transmitted to the hotel.","example":"Guest prefers room on first floor."},"NumberOfRooms":{"type":"integer","description":"Not supported.","format":"int32","example":1,"deprecated":true},"RoomPerTravelerInd":{"type":"boolean","description":"Not implemented.","deprecated":true}},"description":"For a Rules (Reference Payload) or a Create Reservation (Reference Payload) call, reference the value returned in the Availability response at CatalogOffering/id for the specific offer you want to request. Send this value in CatalogOfferingIdentifier. Offers from an Availability response are stored in cache for 30 minutes. If the offers expire you must send a new Availability request."}},"components/schemas/OfferHospitalityResponseWrapper":{"id":"components/schemas/OfferHospitalityResponseWrapper","kind":"json-schema","title":"OfferHospitalityResponseWrapper","data":{"properties":{"OfferHospitalityResponse":{"$ref":"#/components/schemas/OfferHospitalityResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/OfferHospitalityResponse":{"id":"components/schemas/OfferHospitalityResponse","kind":"json-schema","title":"OfferHospitalityResponse","data":{"properties":{"Offer":{"$ref":"#/components/schemas/Offer"}},"description":"The response of a Hotel Rules (Reference Payload) or Hotel Rules (Full Payload) endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/Offer":{"id":"components/schemas/Offer","kind":"json-schema","title":"Offer","data":{"description":"Contains all of the returned offer details.","allOf":[{"$ref":"#/components/schemas/OfferID"},{"required":["Price","Product"],"properties":{"parentOfferRef":{"type":"string","description":"A reference to the Offer this offer is sold in conjunction with","example":"offer_1"},"offerModifyRef":{"type":"string","description":"Reference to the new Offer created as a result of this Offer being subject to a schedule change."},"Product":{"maxItems":100,"minItems":1,"type":"array","description":"Lists the flight or flights for one leg of the itinerary. Repeats for additional leg or legs.","items":{"$ref":"#/components/schemas/ProductID"}},"Price":{"$ref":"#/components/schemas/Price"},"TermsAndConditionsFull":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TermsAndConditionsFullID"}},"passiveOfferInd":{"type":"boolean","description":"Indicates aggregator segment built into PNR. Always send with true when using in a request. If returned true in a response, the Offer is passive for booking purposes.","example":true},"scheduleChangeInd":{"type":"boolean","description":"If true, this Offer is subject to a schedule change."}}}]}},"components/schemas/OfferID":{"id":"components/schemas/OfferID","kind":"json-schema","title":"OfferID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Price child classes OfferID, Offer, and OfferUpsell."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation and ReservationWorkbench child classes OfferID, Offer, OfferModify, and OfferUpsell."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Rules child classes OfferID and Offer."},"children":[]}]}]}]}],"example":"Offer"},"id":{"type":"string","description":"Offer identifier sent in the reference payload request to book that offer. Not returned in the full payload response; this is the only difference in the two responses.","example":"offer_1"},"offerRef":{"type":"string","description":"Used to reference another instance of this object in the same message","example":"offer_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"ContentSource":{"$ref":"#/components/schemas/ContentSourceEnum"}},"description":"Used in Air pricing and Add Offer responses. Defines the top-level identifier details for an offer returned by the API, including the system-generated offer identifier used in subsequent booking, payment, and ticketing steps. This object is part of the standard response structure for both reference and full-payload responses.","discriminator":{"propertyName":"@type"}}},"components/schemas/TermsAndConditionsFullID":{"id":"components/schemas/TermsAndConditionsFullID","kind":"json-schema","title":"TermsAndConditionsFullID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Price child classes are TermsAndConditionsFullAir and TermsAndConditionsFullAncillary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Rules and Reservation class is TermsAndConditionsFullHospitality."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vehicle Rules and Reservation class is TermsAndConditionsFullVehicle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation and Reservation Workbench APIs child classes are TermsAndConditionsFullAir, TermsAndConditionsFullAncillary, TermsAndConditionsFullHospitality, TermsAndConditionsFullVehicle, TermsAndConditionsFullVehicle, and TermsAndConditionsFullScheduleChange."},"children":[]}]}]}]}],"example":"TermsAndConditionsFullAir"},"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"TC_1"},"termsAndConditionsRef":{"type":"string","description":"Used to reference another instance of this object in the same message.","example":"TC_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/OfferQueryHospitalityRequestWrapper":{"id":"components/schemas/OfferQueryHospitalityRequestWrapper","kind":"json-schema","title":"OfferQueryHospitalityRequestWrapper","data":{"properties":{"OfferQueryHospitalityRequest":{"$ref":"#/components/schemas/OfferQueryHospitalityRequest"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/OfferQueryHospitalityRequest":{"id":"components/schemas/OfferQueryHospitalityRequest","kind":"json-schema","title":"OfferQueryHospitalityRequest","data":{"required":["@type","PropertyKey","checkinDate","checkoutDate","numberOfGuests"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryHospitalityRequest only","example":"OfferQueryHospitalityRequest"},"checkinDate":{"type":"string","description":"Check-in date in YYYY-MM-DD format.","format":"date"},"checkoutDate":{"type":"string","description":"Check-out date in YYYY-MM-DD format.","format":"date"},"numberOfGuests":{"type":"integer","description":"Total number of travelers. Must be a numeric value between 1 and 9. Required; send with same value as the total across all counts in RoomStayCandidate/GuestCount/count","format":"int32"},"bookingCode":{"maxLength":32,"type":"string","description":"For the offer you want to request rules on, send the value found for that offer in CatalogOffering/ProductOptions/Product/bookingCode from the Availability response."},"storedCurrency":{"pattern":"[a-zA-Z]{3}","type":"string","description":"For the offer you want to request rules on, send the value found for that offer in CatalogOffering/Price/CurrencyCode/value from the Availability response."},"storedAmount":{"type":"number","description":"For the offer you want to request rules on, send the value found for that offer in CatalogOffering/Price/TotalPrice from the Availability response.","format":"float"},"requestedCurrency":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Send the currency code to return a conversion rate for. The response returns the currency conversion rate of the local currency to the requested currency. This can be used to calculate, independently of the API, conversion for the rates returned in the response. The response does not convert any amounts."},"ExtraAccommodation":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ExtraAccommodation"}},"RoomStayCandidates":{"$ref":"#/components/schemas/RoomStayCandidates"},"PropertyKey":{"$ref":"#/components/schemas/PropertyKey"},"HotelAggregator":{"$ref":"#/components/schemas/HotelAggregatorEnum"},"RateCandidate":{"$ref":"#/components/schemas/RateCandidate"}},"description":"Used for a Hotel Rules (Full Payload) request. Defines a request to retrieve the rules associated with a specific rate by sending the required rate details directly instead of referencing a preceding Hotel Availability response. This request is typically sent after Hotel Availability and before booking."}},"components/schemas/HotelAggregatorEnum":{"id":"components/schemas/HotelAggregatorEnum","kind":"json-schema","title":"HotelAggregatorEnum","data":{"type":"string","description":"\"Identifies the source of the rate.  Send the value for the abbreviation returned for the offer in the Availability response in CatalogOffering/Identifier/authority.  Access to Booking.com rates requires additional provisioning and a direct agreement with the supplier. Contact your Travelport Account Manager for details.\"","enum":["Travelport","Agoda","Booking","EmergingTravel","Expedia","Bonotel"],"x-enumDescriptions":{"Travelport":"TVPT","Agoda":"not supported","Booking":"BKNG","EmergingTravel":"ETGR","Expedia":"not supported","Bonotel":"not supported"}}},"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper":{"id":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitalityWrapper","kind":"json-schema","title":"OfferQueryBuildFromCatalogOfferingsHospitalityWrapper","data":{"properties":{"OfferQueryBuildFromCatalogOfferingsHospitality":{"$ref":"#/components/schemas/OfferQueryBuildFromCatalogOfferingsHospitality"}},"description":"Wrapper schema to expose the root element in the JSON example"}},"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitality":{"id":"components/schemas/OfferQueryBuildFromCatalogOfferingsHospitality","kind":"json-schema","title":"OfferQueryBuildFromCatalogOfferingsHospitality","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryBuildFromCatalogOfferingsHospitality only","example":"OfferQueryBuildFromCatalogOfferingsHospitality"},"BuildFromCatalogOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"}}}},"components/schemas/BuildFromCatalogOfferingsRequest":{"id":"components/schemas/BuildFromCatalogOfferingsRequest","kind":"json-schema","title":"BuildFromCatalogOfferingsRequest","data":{"required":["@type","CatalogOfferingIdentifier","CatalogOfferingsIdentifier"],"properties":{"@type":{"type":"string","description":"Discriminator classes BuildFromCatalogOfferingsRequest, BuildFromCatalogOfferingsRequestAir, and BuildFromCatalogOfferingsRequestAirChange","example":"BuildFromCatalogOfferingsRequestAir"},"CatalogOfferingsIdentifier":{"$ref":"#/components/schemas/CatalogOfferingsIdentifier"},"CatalogOfferingIdentifier":{"$ref":"#/components/schemas/CatalogOfferingIdentifier"},"ProductIdentifier":{"maxItems":10,"minItems":1,"type":"array","example":["p1","p2"],"items":{"$ref":"#/components/schemas/ProductIdentifier"}},"AncillaryOfferingIdentifier":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AncillaryOfferingIdentifier"}}}}},"components/schemas/CatalogOfferingsIdentifier":{"id":"components/schemas/CatalogOfferingsIdentifier","kind":"json-schema","title":"CatalogOfferingsIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"CatalogOfferings_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Catalog offerings Identifier class."}},"components/schemas/CatalogOfferingIdentifier":{"id":"components/schemas/CatalogOfferingIdentifier","kind":"json-schema","title":"CatalogOfferingIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"co1"},"CatalogOfferingRef":{"type":"string","description":"Used to reference another instance of this object in the same message","example":"co1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Catalog Offering Identifier class."}},"components/schemas/ProductIdentifier":{"id":"components/schemas/ProductIdentifier","kind":"json-schema","title":"ProductIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"product_1"},"productRef":{"type":"string","description":"Used to reference another instance of this object in the same payload.","example":"product_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Product Identifier class. In next leg search Value from CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef in the Search response for the product to select for the first leg of the itinerary. When sending a second Next Leg Search request in a multi-city search, this value should be the offer for the second leg of the itinerary, and so on for additional O&D pairs."},"children":[]}]}]}]}},"components/schemas/AncillaryOfferingIdentifier":{"id":"components/schemas/AncillaryOfferingIdentifier","kind":"json-schema","title":"AncillaryOfferingIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"AN1"},"CatalogOfferingRef":{"type":"string","description":"Used to reference another instance of this object in the same message","example":"CO1"},"AncillaryOfferingRef":{"type":"string","example":"AN1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Ancillary Offering Identifier class."}},"components/schemas/ReservationResponseWrapper":{"id":"components/schemas/ReservationResponseWrapper","kind":"json-schema","title":"ReservationResponseWrapper","data":{"properties":{"ReservationResponse":{"$ref":"#/components/schemas/ReservationResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReservationResponse":{"id":"components/schemas/ReservationResponse","kind":"json-schema","title":"ReservationResponse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response of a Create Reservation (Reference or Full Payload), Sync Reservation, Modify/Add Reservation, Create/Modify Passive Reservation, Retrieve Reservation, or Cancel Reservation endpoint.   The structure detailed here is the same as for all of these API responses. For Post-Commit Workbench Create and Workbench Retrieve, the response is structured the same plus a workbench identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information returned in the Reservation Retrieve response varies depending on the information that has been added to the reservation at the time of retrieve, whether the reservation has been ticketed, and whether the reservation was created using the Travelport TripServices APIs or another program."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the requests for Workbench Commit (Create Reservation), Post-Commit Workbench Create, and Workbench Retrieve do not support the query parameters available in Reservation Retrieve and do not return the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any document override, accounting, historical, and DOCI remarks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"any custom rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"brand attributes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baggage dimension and fee details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fare rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ATPCO RouteHappy flight amenities"},"children":[]}]}]}]}],"allOf":[{"properties":{"Reservation":{"$ref":"#/components/schemas/ReservationID"}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ReservationID":{"id":"components/schemas/ReservationID","kind":"json-schema","title":"ReservationID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ReservationID, Reservation, or ReservationDetail","example":"Reservation"},"id":{"type":"string","description":"Internal identifier for the response.","example":"REF12873"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Empty container to request workbench ID.","discriminator":{"propertyName":"@type"}}},"components/schemas/ReservationQueryBuildWrapper":{"id":"components/schemas/ReservationQueryBuildWrapper","kind":"json-schema","title":"ReservationQueryBuildWrapper","data":{"properties":{"ReservationQueryBuild":{"$ref":"#/components/schemas/ReservationQueryBuild"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReservationQueryBuild":{"id":"components/schemas/ReservationQueryBuild","kind":"json-schema","title":"ReservationQueryBuild","data":{"required":["@type","ReservationBuild"],"properties":{"@type":{"type":"string","description":"Discriminator class ReservationQueryBuild only","example":"ReservationQueryBuild"},"ReservationBuild":{"$ref":"#/components/schemas/ReservationBuild"}},"description":"Used for a Create Hotel Reservation (Reference Payload) request. Defines a request to create a hotel reservation using selected hotel offer data together with traveler and payment details. This request typically follows Hotel Availability, Rules, or SearchComplete and is sent to finalize a booking. If the price or guarantee type changes from the preceding response, the request may need to be sent again with the applicable acceptance indicator."}},"components/schemas/ReservationBuild":{"id":"components/schemas/ReservationBuild","kind":"json-schema","title":"ReservationBuild","data":{"required":["@type","Traveler"],"properties":{"@type":{"type":"string","description":"Discriminator classes ReservationBuildFromCatalogOffering, ReservationBuildFromCatalogOfferings, ReservationBuildfromCatalogOfferingsAir,  ReservationBuildFromCatalogProductOfferings, ReservationBuildFromProducts, ReservationBuildVehicle","example":"ReservationBuildFromProducts"},"autoDeleteDate":{"type":"string","description":"Creates a retention segment to keep the host PNR alive until this date.","format":"date","example":"2011-01-24"},"receivedFrom":{"maxLength":128,"type":"string","description":"Allows the user to specify who the request was received from.","example":"TW"},"issuance":{"$ref":"#/components/schemas/IssuanceEnum"},"Traveler":{"maxItems":9,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TravelerID"}},"FormOfPayment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/FormOfPaymentID"}},"Payment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/PaymentID"}},"ReservationComment":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ReservationCommentID"}},"PrimaryContact":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PrimaryContactID"}},"SpecialService":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/SpecialServiceID"}},"Accounting":{"$ref":"#/components/schemas/AccountingID"},"DocumentOverrides":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/DocumentOverridesID"}},"Notification":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"CustomAuxiliarySegment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/CustomAuxiliarySegmentID"}},"Preference":{"maxItems":100,"type":"array","description":"Preference not supported.","deprecated":true,"items":{"$ref":"#/components/schemas/PreferenceID"}},"ReceiptConfirmation":{"$ref":"#/components/schemas/ReceiptConfirmation"},"TravelAgency":{"$ref":"#/components/schemas/TravelAgency"},"scheduleChangeAcceptedInd":{"type":"boolean","description":"If true, the schedule change has been accepted.","example":true},"overrideMCTInd":{"type":"boolean","description":"If true, the minimum connection time warning will be ignored and the Reservation created.","example":true},"errorWhenScheduleChangesInd":{"type":"boolean","description":"If true, an error will be returned when the flight schedule changes during commit processing","example":true},"errorWhenOfferPriceChangesInd":{"type":"boolean","description":"If true, an error will be returned when the flight price changes during commit processing.","example":true}},"description":"Defines the reservation build details used to create a single payload reservation, including traveler, payment, and related booking details. For Hotel use ReservationBuildFromCatalogOffering schema. For Air use ReservationBuildFromCatalogProductOfferings (reference payload) or ReservationBuildFromProducts (FullPayload).","discriminator":{"propertyName":"@type"}}},"components/schemas/IssuanceEnum":{"id":"components/schemas/IssuanceEnum","kind":"json-schema","title":"IssuanceEnum","data":{"type":"string","description":"Mid/BackOffice instructions.","example":"Ticket","enum":["Ticket","BackOffice","All","Invoice"]}},"components/schemas/TravelerID":{"id":"components/schemas/TravelerID","kind":"json-schema","title":"TravelerID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelerID or Traveler","example":"Traveler"},"id":{"type":"string"},"TravelerRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/FormOfPaymentID":{"id":"components/schemas/FormOfPaymentID","kind":"json-schema","title":"FormOfPaymentID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes FormOfPaymentID, FormOfPaymentBSP, FormOfPaymentCash, FormOfPaymentCheck, FormOfPaymentDocument, FormOfPaymentFlightPass, FormOfPaymentForfeit, FormOfPaymentInvoice, FormOfPaymentPaymentCard, FormOfPaymentVirtualPaymentAccount, FormOfPaymentWaiverCode","example":"FormOfPaymentPaymentCard"},"id":{"type":"string","description":"Form of Payment reference ID."},"FormOfPaymentRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"reservationFOPInd":{"type":"boolean","description":"If true, this form of payment is the primary form of payment stored in the Reservation and will be used as the default payment unless alternate form of payment is referenced during the payment process."},"activeInd":{"type":"boolean","description":"Deprecated. Will not implement.","example":true,"deprecated":true}},"description":"Parent class of Form of Payment.","discriminator":{"propertyName":"@type"}}},"components/schemas/PaymentID":{"id":"components/schemas/PaymentID","kind":"json-schema","title":"PaymentID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes PaymentID or Payment","example":"Payment"},"id":{"type":"string","description":"Customer-assigned identifier for the payment."},"PaymentRef":{"type":"string","description":"Customer-assigned name for the payment."},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ReservationCommentID":{"id":"components/schemas/ReservationCommentID","kind":"json-schema","title":"ReservationCommentID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ReservationCommentID or ReservationComment","example":"ReservationComment"},"id":{"type":"string","description":"Local identifier within a given message for this object."}},"discriminator":{"propertyName":"@type"}}},"components/schemas/PrimaryContactID":{"id":"components/schemas/PrimaryContactID","kind":"json-schema","title":"PrimaryContactID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes PrimaryContactID or PrimaryContact","example":"PrimaryContact"},"id":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/SpecialServiceID":{"id":"components/schemas/SpecialServiceID","kind":"json-schema","title":"SpecialServiceID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes SpecialServiceID, SpecialServiceBassinet, SpecialServiceBlind, SpecialServiceDeaf, SpecialServiceDPNA, SpecialServiceMeal, SpecialServiceUnaccompaniedMinor, SpecialServiceWheelchairAirlineSupplied, SpecialServiceWheelchairTravelerSupplied","example":"SpecialService"},"id":{"type":"string","description":"Internal Id"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/AccountingID":{"id":"components/schemas/AccountingID","kind":"json-schema","title":"AccountingID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AccountingID or Accounting","example":"Accounting"},"id":{"type":"string"},"AccountingRef":{"type":"string","description":"Accounting reference"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/DocumentOverridesID":{"id":"components/schemas/DocumentOverridesID","kind":"json-schema","title":"DocumentOverridesID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes DocumentOverridesID or DocumentOverrides","example":"DocumentOverrides"},"id":{"type":"string","description":"The reporting number.","example":"documentoverrides_001"},"DocumentOverridesRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Notification":{"id":"components/schemas/Notification","kind":"json-schema","title":"Notification","data":{"properties":{"QueueNumber":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/QueueNumber"}},"Date":{"type":"string","description":"The notification date is equivalent to ticket time limit and will place the Reservation on the defined queue for the date specified. Sending a new notification date at commit step will update the existing notificationDate. Sending 000/00/00 will delete an existing notificationDate.","format":"date"},"Comment":{"maxLength":69,"type":"string","description":"Optional ticket time limit text string.","example":"Optional free text"}}}},"components/schemas/QueueNumber":{"id":"components/schemas/QueueNumber","kind":"json-schema","title":"QueueNumber","data":{"properties":{"value":{"type":"integer","format":"int32","example":10},"category":{"maxLength":3,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"The Queue Category","example":"CAE"},"subCategory":{"maxLength":32,"type":"string","description":"Date range subCategory","example":"Date Range sub-category"},"overridePCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"Use PCC to override to queue the Reservation to another PCC","example":"0XS4"}},"description":"The queue number"}},"components/schemas/CustomAuxiliarySegmentID":{"id":"components/schemas/CustomAuxiliarySegmentID","kind":"json-schema","title":"CustomAuxiliarySegmentID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes CustomAuxiliarySegmentID or CustomAuxiliarySegment","example":"CustomAuxiliarySegment"},"id":{"type":"string","description":"Custom Auxiliary segment reference ID.","example":"aux_001"},"customAuxiliarySegmentRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/PreferenceID":{"id":"components/schemas/PreferenceID","kind":"json-schema","title":"PreferenceID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes PreferenceID, Preference, PreferenceAirSeat, or PreferenceRailSeat","example":"Preference"},"id":{"type":"string"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ReceiptConfirmation":{"id":"components/schemas/ReceiptConfirmation","kind":"json-schema","title":"ReceiptConfirmation","data":{"allOf":[{"$ref":"#/components/schemas/Receipt"},{"properties":{"Confirmation":{"$ref":"#/components/schemas/Confirmation"},"SegmentSequenceList":{"type":"array","description":"The segmentSequenceList the ReceiptConfirmation applies to","items":{"type":"integer","format":"int32"}}}}]}},"components/schemas/Receipt":{"id":"components/schemas/Receipt","kind":"json-schema","title":"Receipt","data":{"description":"Specifies the payment or guarantee information for a reservation. If zero dollars and in the amount then the payment information acts as a guarantee.","allOf":[{"$ref":"#/components/schemas/ReceiptID"},{"properties":{"dateTime":{"type":"string","description":"Receipt date time","format":"date-time","example":"2022-08-07T12:12:00Z"},"OfferRef":{"type":"array","description":"List of offer reference ids for the offer(s) returned in the Reservation response.","items":{"type":"string"}},"ProductRef":{"type":"string","description":"Reference of product"}}}]}},"components/schemas/ReceiptID":{"id":"components/schemas/ReceiptID","kind":"json-schema","title":"ReceiptID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ReceiptID, ReceiptConfirmation, ReceiptConfirmationDivide, ReceiptCancellation, ReceiptPayment","example":"ReceiptConfirmation"},"id":{"type":"string","description":"The verification number.","example":"3493289238"},"ReceiptRef":{"type":"string","example":"6773 2389 2239 2832"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Confirmation":{"id":"components/schemas/Confirmation","kind":"json-schema","title":"Confirmation","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ConfirmationHold or ConfirmationVehicle","example":"ConfirmationHold"}},"description":"Confirmation details, such as those found in a Receipt.","discriminator":{"propertyName":"@type"}}},"components/schemas/TravelAgency":{"id":"components/schemas/TravelAgency","kind":"json-schema","title":"TravelAgency","data":{"description":"An optional object to define travel agency information.","allOf":[{"$ref":"#/components/schemas/TravelAgencyID"},{"required":["OrganizationName"],"properties":{"organizationType":{"$ref":"#/components/schemas/OrganizationTypeEnum"},"OrganizationName":{"$ref":"#/components/schemas/CompanyName"},"CorporateCode":{"maxLength":32,"type":"string","description":"A reference assigned by the Travel Agency to identify the corporate organization","example":"Air Agency"},"ProfileName":{"maxItems":200,"type":"array","items":{"maxLength":64,"type":"string"}}}}]}},"components/schemas/TravelAgencyID":{"id":"components/schemas/TravelAgencyID","kind":"json-schema","title":"TravelAgencyID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelAgency, TravelAgencyID, or TravelAgencyDetail","example":"TravelAgencyDetail"},"id":{"type":"string","description":"Simple xsd id, not for external use","example":"2"},"TravelOrganizationRef":{"type":"string","description":"An organization that has a name and a structure and members and directly works in the travel industry","example":"TravelAgency_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/OrganizationTypeEnum":{"id":"components/schemas/OrganizationTypeEnum","kind":"json-schema","title":"OrganizationTypeEnum","data":{"type":"string","description":"The type of organization such as an Agency, Branch, Company, Supplier, Provider","enum":["TravelAgency","AgencyBranch","LoyaltyProgram","IdDocumentIssuer","TravelSupplier","TravelProvider","Regulatory"]}},"components/schemas/CompanyName":{"id":"components/schemas/CompanyName","kind":"json-schema","title":"CompanyName","data":{"properties":{"value":{"maxLength":128,"type":"string"},"id":{"type":"string","description":"Use this id to internally identify this company in NextSteps","example":"2"},"division":{"maxLength":32,"type":"string","description":"The division name or ID with which the contact is associated","example":"Travel Division"},"department":{"maxLength":32,"type":"string","description":"The department name or ID with which the contact is associated","example":"Adventure department"},"shortName":{"maxLength":32,"type":"string","description":"Used to provide the company common name","example":"Adventure Inc"},"code":{"maxLength":32,"type":"string","description":"Identifies a company by the company code","example":"AI"},"codeContext":{"maxLength":32,"type":"string","description":"Identifies the context of the identifying code, such as DUNS, IATA, or internal code","example":"ISO"},"systemOfRecord":{"type":"array","description":"The system(s) that maintain the data","items":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string","example":"MB"}}},"description":"Identifies a company by name"}},"components/schemas/ReservationDetailMultipleWrapper":{"id":"components/schemas/ReservationDetailMultipleWrapper","kind":"json-schema","title":"ReservationDetailMultipleWrapper","data":{"properties":{"ReservationDetailMultiple":{"$ref":"#/components/schemas/ReservationDetailMultiple"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReservationDetailMultiple":{"id":"components/schemas/ReservationDetailMultiple","kind":"json-schema","title":"ReservationDetailMultiple","data":{"properties":{"ReservationDetails":{"type":"array","items":{"$ref":"#/components/schemas/ReservationDetail"}}},"description":"Used for a Create Hotel Reservation (Multiple, Full Payload) request. Defines a request to create multiple individual hotel reservations in a single payload using full reservation details. This request typically follows Hotel Availability, Rules, or SearchComplete and is sent to finalize a booking."}},"components/schemas/ReservationDetail":{"id":"components/schemas/ReservationDetail","kind":"json-schema","title":"ReservationDetail","data":{"description":"Used for Hotel Reservation (Full Payload), Sync Reservation, and Passive Reservation requests. Defines the reservation details sent to create, add, modify, synchronize, or passively store a hotel booking segment.  In standard booking workflows, this request is typically sent after Hotel Availability, Rules, or SearchComplete.  In passive or sync workflows, it is used to store or synchronize hotel reservation information without performing a standard hotel sell. Additionally used for the response of Create Reservation (Reference Payload), Create Reservation (Full Payload), or Sync endpoint calls.","allOf":[{"$ref":"#/components/schemas/Reservation"},{"properties":{"Accounting":{"$ref":"#/components/schemas/Accounting"},"DocumentOverrides":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/DocumentOverrides"}},"CustomRule":{"$ref":"#/components/schemas/CustomRule"}}}]}},"components/schemas/Reservation":{"id":"components/schemas/Reservation","kind":"json-schema","title":"Reservation","data":{"allOf":[{"$ref":"#/components/schemas/ReservationID"},{"properties":{"Offer":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Offer"}},"Traveler":{"maxItems":300,"type":"array","items":{"$ref":"#/components/schemas/Traveler"}},"TravelerProduct":{"maxItems":3000,"type":"array","items":{"$ref":"#/components/schemas/TravelerProduct"}},"FormOfPayment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/FormOfPaymentID"}},"Payment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"Receipt":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/Receipt"}},"OfferLink":{"type":"array","items":{"$ref":"#/components/schemas/OfferLink"}},"ReservationComment":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ReservationComment"}},"PrimaryContact":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PrimaryContact"}},"TravelAgency":{"$ref":"#/components/schemas/TravelAgency"},"GroupName":{"maxLength":64,"type":"string","description":"Group name will be passed in the new Group object","deprecated":true},"SpecialService":{"type":"array","items":{"$ref":"#/components/schemas/SpecialService"}},"Preference":{"$ref":"#/components/schemas/Preference"},"OrganizationLoyaltyProgram":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/OrganizationLoyaltyProgram"}},"ShoppingCart":{"$ref":"#/components/schemas/ShoppingCart"},"ReservationDisplaySequence":{"$ref":"#/components/schemas/ReservationDisplaySequence"},"AgencyServiceFee":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AgencyServiceFee"}},"autoDeleteDate":{"type":"string","description":"The auto delete date represents the date that the Reservation will be kept active. Also known as retention segment or retention date.","format":"date"},"notificationDate":{"type":"string","description":"The notification date represents the date that the Reservation should be reviewed. Also known as ticket time limit date.","format":"date"},"CustomAuxiliarySegment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/CustomAuxiliarySegmentID"}},"Group":{"$ref":"#/components/schemas/Group"},"UnpricedSegments":{"$ref":"#/components/schemas/UnpricedSegments"}}}]}},"components/schemas/Traveler":{"id":"components/schemas/Traveler","kind":"json-schema","title":"Traveler","data":{"description":"Information regarding one traveler; may include name, contact information, documents, and loyalty details.  \nWhen sent with TravelerListRequest each instance sends details for one traveler. When sent without TravelerListRequest, only one instance of Traveler is supported in a single request.  \nAny traveler sent without a PTC (passenger type code) value is defaulted to ADT. PTC can be sent or omitted for ADT travelers.  \nAn INF (infant) cannot be added without an ADT (adult) PTC.  ","allOf":[{"$ref":"#/components/schemas/TravelerID"},{"required":["PersonName"],"properties":{"birthDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of birth in YYYY-MM-DD format."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TripServices APIs require this object only for infant and child PTC types (e.g., INF, INS, CHD, UNN)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minimum secure flight information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is required by some carriers, this object is required for all PTCs."},"children":[]}]}]}],"format":"date","example":"2021-06-05"},"gender":{"$ref":"#/components/schemas/GenderEnum"},"PersonName":{"$ref":"#/components/schemas/PersonName"},"Address":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Telephone":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Telephone"}},"Email":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Email"}},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"Passenger type code (PTC) for this traveler.","example":"CHD"},"nationality":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Nationality on country code ISO","example":"AL"},"age":{"type":"integer","description":"The age of the traveller at the time of travel","format":"int32","example":13},"CustomerLoyalty":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyalty"}},"AlternateContact":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/AlternateContact"}},"TravelDocument":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TravelDocument"}},"Comments":{"$ref":"#/components/schemas/Comments"},"RailDiscountCard":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/RailDiscountCard"}},"accompaniedByInfantInd":{"type":"boolean","example":true}}}]}},"components/schemas/GenderEnum":{"id":"components/schemas/GenderEnum","kind":"json-schema","title":"GenderEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gender Type Male, Female etc."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When sending "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#minimum-secure-flight-information-ssr-docs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"minimum secure flight information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Traveler object, which is required by some carriers, this object is required for all PTCs."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is not used by Hotel APIs and will be ignored."},"children":[]}]}]}],"example":"Female","enum":["Male","Female","Unknown","Undisclosed"]}},"components/schemas/PersonName":{"id":"components/schemas/PersonName","kind":"json-schema","title":"PersonName","data":{"required":["@type","Surname"],"properties":{"@type":{"type":"string","description":"Discriminator classes PersonName or PersonNameDetail","example":"PersonNameDetail"},"Prefix":{"maxLength":10,"type":"string","description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","example":"Mr"},"Given":{"maxLength":30,"type":"string","description":"Traveler first or given name.","example":"John"},"Middle":{"maxLength":30,"type":"string","description":"Traveler middle name.","example":"Erick"},"Surname":{"maxLength":30,"minLength":1,"type":"string","description":"Traveler last name or surname.","example":"Smith"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response."},"children":[]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/Telephone":{"id":"components/schemas/Telephone","kind":"json-schema","title":"Telephone","data":{"required":["@type","phoneNumber"],"properties":{"@type":{"type":"string","description":"Discriminator classes Telephone or TelephoneDetail","example":"Telephone"},"countryAccessCode":{"pattern":"[0-9]{1,3}","type":"string","description":"Phone country code","example":"1"},"areaCityCode":{"pattern":"[0-9]{1,8}","type":"string","description":"Phone local area code","example":"972"},"phoneNumber":{"maxLength":32,"type":"string","description":"Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.","example":"972-000-787"},"extension":{"pattern":"[0-9]{0,5}","type":"string","description":"Telephone extension number","example":"234"},"id":{"type":"string","description":"Optional custom user-assigned identifier for a phone number.","example":"3"},"cityCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"IATA city code if referenced by phone number.","example":"DEN"},"role":{"$ref":"#/components/schemas/Enum_TelephoneRole"}},"description":"Phone information for contacting the relevant individual or agency.  \nFor Flights Add Traveler, NDC carriers typically require either an email address or phone number for booking. Recommended best practice is to provide both Email and Telephone for NDC.","discriminator":{"propertyName":"@type"}}},"components/schemas/Enum_TelephoneRole":{"id":"components/schemas/Enum_TelephoneRole","kind":"json-schema","title":"Enum_TelephoneRole","data":{"type":"string","description":"Defines the type of location the Telephone is assigned to. For Travel Agency telephone select \"Other\" or leave blank.","example":"Mobile","enum":["Mobile","Home","Work","Office","Fax","Other"]}},"components/schemas/AlternateContact":{"id":"components/schemas/AlternateContact","kind":"json-schema","title":"AlternateContact","data":{"required":["PersonName"],"properties":{"@type":{"type":"string","example":"AlternateContact"},"id":{"type":"string"},"contactType":{"maxLength":128,"type":"string","description":"Contact type value","example":"Relative"},"relation":{"maxLength":128,"type":"string","description":"Relation value","example":"Mother"},"PersonName":{"$ref":"#/components/schemas/PersonName"},"Address":{"maxItems":3,"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Telephone":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Telephone"}},"Email":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Email"}},"emergencyInd":{"type":"boolean","description":"This is the contact in case of an emergency","example":true},"defaultInd":{"type":"boolean","description":"This is the default contact","example":true}}}},"components/schemas/TravelDocument":{"id":"components/schemas/TravelDocument","kind":"json-schema","title":"TravelDocument","data":{"required":["@type","Gender","PersonName"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelDocument or TravelDocumentDetail","example":"TravelDocumentDetail"},"docNumber":{"maxLength":128,"type":"string","description":"Travel document number.","example":"B37201"},"docType":{"$ref":"#/components/schemas/DocTypeCodeEnum"},"issueDate":{"type":"string","description":"Issue date of document. Required for a visa","format":"date","example":"2002-10-13"},"expireDate":{"type":"string","description":"Expiration date of document. Required for a visa.","format":"date","example":"2002-11-13"},"stateProvCode":{"maxLength":8,"minLength":2,"type":"string","description":"State Province Code value","example":"44"},"placeOfIssue":{"maxLength":32,"type":"string","description":"Place of issue value","example":"Birmingham"},"issueCountry":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Issuing country of document; ISO3166 standard format.","example":"CA"},"birthDate":{"type":"string","description":"The date of birth of the document holder in YYYY-MM-DD format.","format":"date","example":"1995-04-22"},"birthCountry":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Country of birth of the document holder in ISO3166 standard format.","example":"AR"},"birthPlace":{"maxLength":128,"type":"string","description":"Birth place value","example":"Ontario"},"residence":{"maxLength":512,"type":"string","description":"Residence value","example":"1st section 8th st"},"id":{"type":"string","description":"Locally referenced id","example":"34"},"Gender":{"$ref":"#/components/schemas/GenderEnum"},"Nationality":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Birth country as noted on document; specifies a 2 character country code as defined in ISO3166.","example":"BR"},"PersonName":{"$ref":"#/components/schemas/PersonName"}},"description":"Optional details about traveler identification documents such as a passport or drivers license.","discriminator":{"propertyName":"@type"}}},"components/schemas/DocTypeCodeEnum":{"id":"components/schemas/DocTypeCodeEnum","kind":"json-schema","title":"DocTypeCodeEnum","data":{"type":"string","description":"Supported Travel Document types","example":"Passport","enum":["Visa","Passport","MilitaryIdentification","DriversLicense","NationalIdentityDocument","VaccinationCertificate","AlienRegistrationNumber","InsurancePolicyNumber","TaxExemptionNumber","VehicleRegistrationLicenseNumber","BoderCrossingCard","RefugeeTravelDocument","PilotsLicense","PermanentResidentCard","RedressNumber","KnownTravelerNumber","Non-Standard","MerchantNumber","AirNexusCard","CrewMemberCertificate","PassportCard","NaturalizationCertificate","TicketNumber","LargeFamilyDiscountCard","IdentityCardTypeA","IdentityCardTypeC","IdentityCardTypeI"],"x-enumDescriptions":{"PassportCard":"GDS only, not supported for NDC.","NationalIdentityDocument":"NDC only, IB carrier only; used for Spanish residency and large family discount fares."}}},"components/schemas/Comments":{"id":"components/schemas/Comments","kind":"json-schema","title":"Comments","data":{"properties":{"@type":{"type":"string","example":"Comments"},"Comment":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Comment"}}},"description":"Comments object to relay free text information  \nIn ProductAncillary.Ancillary this is used to expose when additional comments are required to book the ancillary.  \nIn BuildAncillaryOffersFromCatalogOfferings this is used to pass additional ancillary text required to book the ancillary.  \nIn Traveler this is used to send custom freeform traveler name remarks, such as a unique identifier for a given traveler. Not supported for addition/deletion in Traveler Modify."}},"components/schemas/Comment":{"id":"components/schemas/Comment","kind":"json-schema","title":"Comment","data":{"properties":{"value":{"maxLength":4096,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Actual text."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be restricted based on the type of comment. Ex:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notepad remarks: limited to 87 characters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Traveler name remarks: limited to 33 characters, only spaces and hyphens allowed for special characters."},"children":[]}]}]}]}]}],"example":"Additional comments"},"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"comment_1"},"name":{"maxLength":128,"type":"string","description":"Title of comment or type of remark.","example":"Comment name"},"language":{"type":"string","description":"Language code using ISO-639 standard","example":"EN"}},"description":"Textual information."}},"components/schemas/RailDiscountCard":{"id":"components/schemas/RailDiscountCard","kind":"json-schema","title":"RailDiscountCard","data":{"required":["supplierCode"],"properties":{"value":{"maxLength":128,"type":"string","example":"Rail1234546"},"supplierCode":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string","description":"Code of the Supplier","example":"Enco"},"referenceNumber":{"maxLength":128,"type":"string","description":"ReferenceNumber","example":"134256"}},"description":"Rail discount card information"}},"components/schemas/TravelerProduct":{"id":"components/schemas/TravelerProduct","kind":"json-schema","title":"TravelerProduct","data":{"description":"The relationship mapping a traveler to a specific product. Used for SSR, OSI and other specific offerings (such as a hotel segment). Each offer has a linked traveler.","allOf":[{"$ref":"#/components/schemas/TravelerProductID"},{"properties":{"TravelerRef":{"type":"string","description":"Traveler reference number associated with offer in OfferRef."},"OfferRef":{"type":"string","description":"Offer reference number associated with traveler in TravelerRef."},"ProductRef":{"type":"string","description":"A pointer to the product id"},"ConfirmationStatusEnum":{"$ref":"#/components/schemas/ConfirmationStatusEnum"},"UnpricedFlightSegmentRefs":{"type":"array","description":"References the flight segment/s within UnpricedSegments that are associated to this Traveler.","example":["unpricedFlightSegment_001","unpricedFlightSegment_002"],"items":{"type":"string"}}}}]}},"components/schemas/TravelerProductID":{"id":"components/schemas/TravelerProductID","kind":"json-schema","title":"TravelerProductID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelerProductID or TravelerProduct","example":"TravelerProduct"},"id":{"type":"string"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ConfirmationStatusEnum":{"id":"components/schemas/ConfirmationStatusEnum","kind":"json-schema","title":"ConfirmationStatusEnum","data":{"type":"string","description":"Status returned in a response for a two or more phase commitment process","example":"Confirmed","enum":["Pending","Confirmed","Cancelled","Rejected","Requested"]}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A monetary payment for one or more product offers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Hotels, the amount to be charged for the Hotel Reservation as follows: For Prepay Required rates, the full total amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false. For Deposit Required rates, the deposit amount is used. This amount will be charged to the credit card on this transaction. Indicators should be set as: depositInd = true; guaranteeInd = false. For Guarantee Required rates, the full total amount is used. This amount is expected to be charged to the credit card at check in. Indicators should be set as: depositInd = false; guaranteeInd = true."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PaymentID"},{"required":["Amount"],"properties":{"Amount":{"$ref":"#/components/schemas/CurrencyAmount"},"FormOfPaymentIdentifier":{"$ref":"#/components/schemas/FormOfPaymentIdentifier"},"OfferIdentifier":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/OfferIdentifier"}},"Fees":{"$ref":"#/components/schemas/Fees"},"Taxes":{"$ref":"#/components/schemas/Taxes"},"TravelerIdentifierRef":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"BaseAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"depositInd":{"type":"boolean","description":"If true, the payment is a deposit on the referenced Offer; at booking the provided card is charged for deposit or prepay rate."},"ExtendedPayment":{"$ref":"#/components/schemas/ExtendedPayment"},"AgencyServiceFeeIdentifier":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AgencyServiceFeeIdentifier"}},"guaranteeInd":{"type":"boolean","description":"If true, the payment is a guarantee for the referenced Offer; no amounts are charged at booking; the customer is to make payment in person upon arrival."}}}]}},"components/schemas/FormOfPaymentIdentifier":{"id":"components/schemas/FormOfPaymentIdentifier","kind":"json-schema","title":"FormOfPaymentIdentifier","data":{"properties":{"@type":{"type":"string","example":"FormOfPaymentPaymentCash"},"id":{"type":"string","description":"Form of payment identifier reference ID."},"FormOfPaymentRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"activeInd":{"type":"boolean","description":"If true, this form of payment will be used for document issuance and override any other form of payment in the reservation.","example":true}},"description":"The Travelport-assigned identifier for the FOP used for purchase."}},"components/schemas/OfferIdentifier":{"id":"components/schemas/OfferIdentifier","kind":"json-schema","title":"OfferIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"offer_1"},"offerRef":{"type":"string","description":"Used to reference another instance of this object in the same message","example":"offer_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Travelport-generated offer identifier number."}},"components/schemas/TravelerIdentifierRef":{"id":"components/schemas/TravelerIdentifierRef","kind":"json-schema","title":"TravelerIdentifierRef","data":{"properties":{"name":{"maxLength":512,"type":"string","description":"Traveler identifier"},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"Passenger Type code","example":"ADT"},"ages":{"type":"array","description":"The ages of the travelers associated to a particular ptc. For NDC, this value will be returned in PriceBreakdownAir if sent as part of the PassengerCriteria in the Air Search request.","items":{"type":"integer","format":"int32","example":15}},"age":{"type":"integer","description":"Replaced with ages array. The age of the traveler.","format":"int32","example":11,"deprecated":true},"passengerCriteriaRef":{"maxLength":32,"type":"string","description":"Allows the user to associate passenger criteria information.  \nFor FlightPass, this is the id of the flight pass owner in PassengerCriteria.  ","example":"passengerCriteria_1"}},"description":"Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows.  \nReturned for NDC in the Price response if age was sent for this traveler in the previous workflow requests.","allOf":[{"$ref":"#/components/schemas/IdentifierRef"}]}},"components/schemas/IdentifierRef":{"id":"components/schemas/IdentifierRef","kind":"json-schema","title":"IdentifierRef","data":{"properties":{"value":{"maxLength":128,"type":"string"},"id":{"type":"string","description":"A locally referenced ID"},"description":{"type":"string","description":"Descriptive text used to identify the contents of a target object"},"uris":{"type":"array","description":"Uniform Resource Identifier","items":{"type":"string","example":"google.com"}}},"description":"Identifier references as object both within a message payload or an object held in cache that may be used for subsequent workflows. FareRuleIdentifierRef is deprecated and not in use. Use Fare Rule end points directly for detailed fare rules."}},"components/schemas/ExtendedPayment":{"id":"components/schemas/ExtendedPayment","kind":"json-schema","title":"ExtendedPayment","data":{"required":["NumberOfInstallments"],"properties":{"NumberOfInstallments":{"type":"integer","description":"The number of installment payments to be charged by the payment card provider","format":"int32","example":6},"FirstInstallment":{"type":"number","description":"For Pagos Parceledos, specify the first installment amount. This will be the same currency as the payment","format":"float","example":100},"RemainingAmount":{"type":"number","description":"For Pagos Parceledos, specify the remaining amount to be charged that will be spread across the number of installments. This will be the same currency as the payment","format":"float","example":50},"OTATOCode":{"maxLength":32,"type":"string","description":"For Pagos Parceledos the OTATOCode"}},"description":"Note this field is deprecated in Payment schema and should be passed in FormOfPaymentPaymentCardExtendPayment schema"}},"components/schemas/AgencyServiceFeeIdentifier":{"id":"components/schemas/AgencyServiceFeeIdentifier","kind":"json-schema","title":"AgencyServiceFeeIdentifier","data":{"properties":{"id":{"type":"string","description":"Unique id for this object within a message"}},"description":"Agency Service Fee Identifier object."}},"components/schemas/OfferLink":{"id":"components/schemas/OfferLink","kind":"json-schema","title":"OfferLink","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"OfferLink"},"OfferRef":{"type":"string"},"ParentOffer":{"$ref":"#/components/schemas/ParentOffer"}}}},"components/schemas/ParentOffer":{"id":"components/schemas/ParentOffer","kind":"json-schema","title":"ParentOffer","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class ParentOffer only","example":"ParentOffer"},"OfferRef":{"type":"string"},"ProductRef":{"type":"string"}}}},"components/schemas/ReservationComment":{"id":"components/schemas/ReservationComment","kind":"json-schema","title":"ReservationComment","data":{"description":"An optional object used to define certain remarks. \nCreate Reservation supports Notepad remarks (general, historical, and confidential), Unassociated remarks, Special Instruction remarks, and Accounting remarks.","allOf":[{"$ref":"#/components/schemas/ReservationCommentID"},{"properties":{"commentSource":{"$ref":"#/components/schemas/CommentSourceEnum"},"shareWith":{"$ref":"#/components/schemas/ShareWithEnum"},"shareWithSupplier":{"type":"array","description":"Reservation comment shared with supplier","items":{"maxLength":32,"type":"string"}},"Comment":{"maxItems":1000,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the type of remark (name) and the remark itself (value)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the following in 'name' for each type of remark: Notepad remarks: Two-character code. Use asterisk for any placeholder. (HS, CR, R*, **) Unassociated remarks: ITIN COMMENTS Special instruction remarks: SI"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For remark text 'value', please note character limits for each type of remark: Notepad remarks: 87 Unassociated remarks: 70 Special instruction remarks: 50"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Comment"}},"AppliesTo":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AppliesTo"}}}}]}},"components/schemas/CommentSourceEnum":{"id":"components/schemas/CommentSourceEnum","kind":"json-schema","title":"CommentSourceEnum","data":{"type":"string","description":"Originator of a comment.","example":"Agency","enum":["Agency","Supplier","Traveler"],"x-enumDescriptions":{"Agency":"For Hotel Create Reservation (Full Payload) ReservationComment/commentSource 'Agency' is the only supported value."}}},"components/schemas/ShareWithEnum":{"id":"components/schemas/ShareWithEnum","kind":"json-schema","title":"ShareWithEnum","data":{"type":"string","description":"Designates the visibility of a remark.","example":"Supplier","enum":["Supplier","Agency","Traveler"],"x-enumDescriptions":{"Supplier":"For Hotel Create Reservation (Full Payload) ReservationComment/shareWith 'Supplier' is used for Special instructions.","Agency":"For Hotel Create Reservation (Full Payload) ReservationComment/shareWith 'Agency' is used for Notepad remarks.","Traveler":"For Hotel Create Reservation (Full Payload) ReservationComment/shareWith 'Traveler' is used for Unassociated remarks."}}},"components/schemas/AppliesTo":{"id":"components/schemas/AppliesTo","kind":"json-schema","title":"AppliesTo","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AppliesToOffer, AppliesToOfferProduct, and AppliesToOfferProductSegment","example":"AppliesToOffer"}},"description":"In a request, used to apply a feature to a specific Offer, Product, or Segment. In a response, returned for Special Instruction and Associated Remarks.","discriminator":{"propertyName":"@type"}}},"components/schemas/PrimaryContact":{"id":"components/schemas/PrimaryContact","kind":"json-schema","title":"PrimaryContact","data":{"description":"Primary contact details.","allOf":[{"$ref":"#/components/schemas/PrimaryContactID"},{"properties":{"shareWith":{"$ref":"#/components/schemas/ShareWithEnum"},"shareWithSupplier":{"type":"array","description":"Primary contact shared with supplier","items":{"maxLength":32,"type":"string"}},"Email":{"$ref":"#/components/schemas/Email"},"Telephone":{"$ref":"#/components/schemas/Telephone"},"TravelerIdentifier":{"$ref":"#/components/schemas/TravelerIdentifier"},"contactInformationRefusedInd":{"type":"boolean","description":"If true, the passenger has refused to provide emergency contact details","example":true}}}]}},"components/schemas/TravelerIdentifier":{"id":"components/schemas/TravelerIdentifier","kind":"json-schema","title":"TravelerIdentifier","data":{"properties":{"@type":{"type":"string","example":"TravelerIdentifier"},"id":{"type":"string"},"TravelerRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Returns the system-generated traveler identifier in key value pairs; authority, if returned, is Travelport."}},"components/schemas/SpecialService":{"id":"components/schemas/SpecialService","kind":"json-schema","title":"SpecialService","data":{"description":"Traveler Special Assistance","example":"SpecialServiceMeal","allOf":[{"$ref":"#/components/schemas/SpecialServiceID"},{"properties":{"AppliesTo":{"$ref":"#/components/schemas/AppliesTo"},"Status":{"$ref":"#/components/schemas/Status"},"ServiceAnimalType":{"maxLength":32,"type":"string","description":"The type of service animal accompanying the Traveler. If no service animal leave blank.","example":"Horse"},"TravelerIdentifier":{"$ref":"#/components/schemas/TravelerIdentifier"},"Quantity":{"type":"integer","format":"int32","example":1},"FreeText":{"type":"string","example":"NO SEAFOOD"},"SSRCode":{"maxLength":4096,"pattern":"([A-Z]+)?","type":"string","example":"SPML"},"Carrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"For unassociated SSRs use carrier to instruct which airline to send the service information to","example":"BA"}}}]}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"properties":{"value":{"$ref":"#/components/schemas/ConfirmationStatusEnum"},"supplierText":{"maxLength":128,"type":"string","description":"Supplier status text","example":"Active/In-active"},"code":{"maxLength":32,"type":"string","description":"Special service status code","example":"NN"}}}},"components/schemas/Preference":{"id":"components/schemas/Preference","kind":"json-schema","title":"Preference","data":{"allOf":[{"$ref":"#/components/schemas/PreferenceID"},{"properties":{"AppliesTo":{"$ref":"#/components/schemas/AppliesTo"},"TravelerIdentifier":{"$ref":"#/components/schemas/TravelerIdentifier"}}}]}},"components/schemas/OrganizationLoyaltyProgram":{"id":"components/schemas/OrganizationLoyaltyProgram","kind":"json-schema","title":"OrganizationLoyaltyProgram","data":{"allOf":[{"$ref":"#/components/schemas/OrganizationLoyaltyProgramID"},{"required":["LoyaltyIdentifier","Supplier"],"properties":{"Supplier":{"maxLength":32,"type":"string","description":"The supplier of the loyalty program","example":"Air Canada"},"LoyaltyIdentifier":{"maxLength":1000,"minLength":1,"type":"string","description":"Loyalty Identifier","example":"LP029381"}}}]}},"components/schemas/OrganizationLoyaltyProgramID":{"id":"components/schemas/OrganizationLoyaltyProgramID","kind":"json-schema","title":"OrganizationLoyaltyProgramID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes OrganizationLoyaltyProgramID or OrganizationLoyaltyProgram","example":"OrganizationLoyaltyProgramID"},"id":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ShoppingCart":{"id":"components/schemas/ShoppingCart","kind":"json-schema","title":"ShoppingCart","data":{"properties":{"@type":{"type":"string","example":"ShoppingCart"},"Product":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ProductAir"}}},"description":"This object is deprecated and no longer in use.","deprecated":true}},"components/schemas/ProductAir":{"id":"components/schemas/ProductAir","kind":"json-schema","title":"ProductAir","data":{"description":"Detailed information of the Air product","allOf":[{"$ref":"#/components/schemas/Product"},{"required":["FlightSegment","PassengerFlight"],"properties":{"totalDuration":{"type":"string","description":"Total duration of the combined segments in hours (H) and minutes (M). ISO 8601 format.","example":"PT2H40M"},"FlightSegment":{"maxItems":99,"minItems":1,"type":"array","description":"One instance for each flight segment in the product.","items":{"$ref":"#/components/schemas/FlightSegment"}},"PassengerFlight":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PassengerFlight"}}}}]}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"description":"Summary Product information inherited by all Product child classes.","allOf":[{"$ref":"#/components/schemas/ProductID"},{"properties":{"Quantity":{"type":"integer","description":"The quantity of the product. \nFor Hotel Create Reservation (Full Payload) request, the number of rooms requested; 1-9 inclusive supported. If not provided, default is 1. For Hotel responses, the number of rooms currently available matching this rate.\nIn Air Search quantity represents the number of seats available for that Product. If the Product has connecting flights, Quantity returns the lowest number available. For example, if the first flight has 9 seats in Y class and the connecting flight has 4 seats in Y class, Quantity returns a value of 4.","format":"int32","example":2}}}]}},"components/schemas/FlightSegment":{"id":"components/schemas/FlightSegment","kind":"json-schema","title":"FlightSegment","data":{"required":["Flight","sequence"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"FlightSegment"},"id":{"type":"string","description":"Local identifier within a given message for this object.  \nFor AirPrice this identifier starts with s as in s1, s2, etc.","example":"flightSegment_01"},"sequence":{"type":"integer","description":"Order of the flight segment. e.g. 1 for the first segment on the leg.","format":"int32","example":1},"connectionDuration":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a flight connection exists, this is the lapsed time between the connecting flights in the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}M is the number of minutes for the connection."},"children":[]}]}]}],"example":"PT1H3M"},"amenityRefs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If RouteHappy flight amenities were requested (includeFlightAmenitiesInd=true), amenityRefs is returned to cross-reference the amenities available on this flight and listed in ReferenceList/ReferenceListAmenity."},"children":[]}]}]}],"items":{"type":"string","example":"[\"amenity_1\",\"amenity_2\"]"}},"universalProductAttributeRefs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If universal product attributes (UPAs) for RouteHappy data were requested (includeUniversalProductAttributesInd=true) along with RouteHappy flight amenities, universalProductAttributeRefs is returned. Cross-reference the universalProductAttributeRef with the universalProductAttribute 'id' in ReferenceListUniversalProductAttribute.UniversalProductAttribute. UPAs provide images, icons, and URLs as provided by ATPCO. RouteHappy data must have also been requested per amenityRefs above."},"children":[]}]}]}],"items":{"type":"string","example":"[\"upa_1\",\"upa_2\"]"}},"Flight":{"$ref":"#/components/schemas/FlightID"},"IntermediateStopAmenities":{"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/IntermediateStopAmenities"}},"OperationalStatus":{"$ref":"#/components/schemas/OperationalStatusENUM"},"boundFlightsInd":{"type":"boolean","description":"GDS only; not supported for NDC.  \nIndicates flight segments are married/bound.  \nWhen 'true', indicates the flight segments in a single or double connection must be sold together. When true, the indicator is returned for all leading segments on one leg of the flight, and not returned for the last segment of the bound flight leg journey, indicating where the bound flights end. For example, if an origin and destination pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg.  \nIf the segments are not bound, boundFlightsInd is false and not returned.  ","example":true},"CO2Actual":{"$ref":"#/components/schemas/Measurement"}},"description":"Groups the flight into sequence and contains connecting flight information.  \nCo2 Actual is returned if requested 'includCo2EmissionsDataInd' and represents the actual carbon emissions for this specific flight. CO2 emissions are measured as a weight in kilograms."}},"components/schemas/FlightID":{"id":"components/schemas/FlightID","kind":"json-schema","title":"FlightID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes Flight and FlightDetail.","example":"FlightDetail"},"id":{"type":"string","description":"Local id within a given message to support referencing this object - an internal flight identifier.","example":"126"},"FlightRef":{"type":"string","description":"Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight.","example":"s1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Flight common schema. Used across Air workflow.  \nOne instance for each flight in the FlightSegment. A direct flight option has one Flight object while connecting flights have a Flight object for each flight on the leg.","discriminator":{"propertyName":"@type"}}},"components/schemas/IntermediateStopAmenities":{"id":"components/schemas/IntermediateStopAmenities","kind":"json-schema","title":"IntermediateStopAmenities","data":{"required":["@type","arrivalLocation","departureLocation"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"IntermediateStopAmenities"},"departureLocation":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The departure location.","example":"NYC"},"arrivalLocation":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The arrival location.","example":"DEN"},"amenityRefs":{"type":"array","description":"List of amenity references for this portion of the flight.","items":{"type":"string","example":"amenity_1"}},"universalProductAttributeRefs":{"type":"array","description":"List of UPA references for this portion of the flight.","items":{"type":"string","example":"upa_1"}}},"description":"Amenities available on this flight with intermediate stops."}},"components/schemas/OperationalStatusENUM":{"id":"components/schemas/OperationalStatusENUM","kind":"json-schema","title":"OperationalStatusENUM","data":{"properties":{"value":{"$ref":"#/components/schemas/OperationalStatusENUM_Base"}},"description":"The operational status of the flight"}},"components/schemas/OperationalStatusENUM_Base":{"id":"components/schemas/OperationalStatusENUM_Base","kind":"json-schema","title":"OperationalStatusENUM_Base","data":{"type":"string","description":"List of operational flight status","example":"FlightBoarding","enum":["FlightBoarding","FlightCancelled","FlightDeparted","FlightPastScheduledDeparture","NotAvailableUseSearch"]}},"components/schemas/Measurement":{"id":"components/schemas/Measurement","kind":"json-schema","title":"Measurement","data":{"properties":{"value":{"type":"number","format":"float","example":2.22},"measurementType":{"$ref":"#/components/schemas/MeasurementTypeEnum"},"unit":{"$ref":"#/components/schemas/UnitOfMeasureEnum"}},"description":"Used for dimensional units (width, height, depth) or weight"}},"components/schemas/MeasurementTypeEnum":{"id":"components/schemas/MeasurementTypeEnum","kind":"json-schema","title":"MeasurementTypeEnum","data":{"type":"string","description":"The type of measurement such as width, height, weight","enum":["Width","Height","Depth","Weight","OverallDimension"]}},"components/schemas/UnitOfMeasureEnum":{"id":"components/schemas/UnitOfMeasureEnum","kind":"json-schema","title":"UnitOfMeasureEnum","data":{"type":"string","description":"The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).","example":"Kilograms","enum":["Miles","Kilometers","Meters","Millimeters","Centimeters","Yards","Feet","Inches","Pixels","Block","Megabytes","Gigabytes","Square feet","Square meters","Pounds","Kilograms","Square inch","Square yard","Acre","Square millimeter","Square centimeter","Hectare","Ounce","Gram","Gallons","Liters","Kilowatts","Cubic meters"]}},"components/schemas/PassengerFlight":{"id":"components/schemas/PassengerFlight","kind":"json-schema","title":"PassengerFlight","data":{"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"PassengerFlight"},"passengerQuantity":{"type":"integer","description":"Number of passengers of the specified passenger type code.","format":"int32","example":26},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"Passenger type code applicable to the offer/offering. This may be different to the requested passenger type code sent in PassengerCriteria.","example":"ADT"},"requestedPassengerTypeCodes":{"type":"array","description":"The requested passenger type code for this product as opposed to the priced passenger type code. Multiple passenger type codes may have been requested with the response resulting in only one passenger type code available for the offer/offering.","items":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","example":"[\"ADT\",\"MIL\"]"}},"FlightProduct":{"maxItems":99,"type":"array","items":{"$ref":"#/components/schemas/FlightProduct"}}},"description":"Returns PTC and class/fare information for each PTC requested. One instance of Passenger Flight is returned for each PTC requested."}},"components/schemas/FlightProduct":{"id":"components/schemas/FlightProduct","kind":"json-schema","title":"FlightProduct","data":{"required":["segmentSequence"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"FlightProduct"},"segmentSequence":{"type":"array","description":"Order of the corresponding flight in the sequence. Note that the segmentSequence value for connecting flights is the same; for example, for two connecting flights on the outbound or first leg of the itinerary, both flights have the segmentSequence value 1.  ","example":[1],"items":{"type":"integer","format":"int32"}},"classOfService":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","description":"The class of service code.","example":"F"},"cabin":{"$ref":"#/components/schemas/CabinAirEnum"},"fareBasisCode":{"maxLength":32,"type":"string","description":"Fare basis code for the flight.  \nFor NDC, also returns the ticket designator after a slash (/) following the fare basis code.  \nGDS ticket designators are returned in ticketDesignator.","example":"YEE1Y"},"fareType":{"$ref":"#/components/schemas/FareTypeEnum"},"carCode":{"maxLength":32,"type":"string","description":"The car code or deal code. Net remit. May be a Commercial Airline Agreement number.  \nAirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC.","example":"P1234"},"valueCode":{"maxLength":32,"type":"string","description":"The value code for the fare. Net remit.  \nAirPrice returns the net ticket data (NTD) if a fare returned has a private fare component and private fares were requested (fareType of AgencyPrivateFare). GDS only; not supported for NDC.","example":"365"},"Brand":{"$ref":"#/components/schemas/BrandID"},"CustomerLoyaltyCredit":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyaltyCredit"}},"ClassOfServiceAvailability":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ClassOfServiceAvailability"}},"FareQualifier":{"$ref":"#/components/schemas/FareQualifierENUM"},"stopoverPriced":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"ticketDesignator":{"maxLength":32,"type":"string","description":"GDS only; not supported for NDC. (NDC ticket designators are returned in fareBasisCode after a slash (/), following the fare basis code.)  \nReturns the ticket designator for GDS. The ticket designator is a code used by airlines to indicate the type of discount applied to a fare. An airline may have a specific ticket designator used to differentiate its fares, which may also signify anything from private fares, wholesale, promotion, or discounted fares.","example":"BB5662Y"},"fareTypeCode":{"maxLength":32,"type":"string","description":"GDS only; not supported for NDC.  \nIdentifies whether the fare is bundled or unbundled by providing the ATPCO defined fare type code when the coresponding response includes unbundled fares.","example":"ERU"},"FareQualifierString":{"maxLength":32,"type":"string","description":"NDC only. Not supported for GDS. Fare qualifier of a private leisure fares.","example":"[\"Tour\"]"}},"description":"Fare related attributes of the Offer/Offering."}},"components/schemas/CabinAirEnum":{"id":"components/schemas/CabinAirEnum","kind":"json-schema","title":"CabinAirEnum","data":{"type":"string","description":"Specifies the cabin type.  \nIf sent for Flight Specific Search, this field is ignored.  \nMany carriers use Business and First as the same cabin. If the request is for Business and only First is available, the response returns only First and returns a message that the cabin class may differ from the class requested.  \nSome carriers do not support lowFareFinderInd with Premium First cabin class.","example":"Economy","enum":["PremiumFirst","First","Business","PremiumEconomy","Economy"]}},"components/schemas/FareTypeEnum":{"id":"components/schemas/FareTypeEnum","kind":"json-schema","title":"FareTypeEnum","data":{"type":"string","description":"Indicates the type of fare that applies to this Offer/Offering.  \nNetFare is not supported for NDC.","example":"PublicFare","enum":["PublicFare","AgencyPrivateFare","AirlinePrivateFare","NetFare"],"x-enumDescription":{"PublicFare":"This portion of the product is a public fare.","AgencyPrivateFare":"This portion of the product is an agency private fare.","AirlinePrivateFare":"This portion of the product is an airline private fare.","NetFare":"This portion of the product is a net fare. Not supported for NDC."}}},"components/schemas/BrandID":{"id":"components/schemas/BrandID","kind":"json-schema","title":"BrandID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes BrandID and Brand. BrandCompleteInfo is no longer in use.","example":"BrandID"},"id":{"type":"string","description":"Local id within a given message to support referencing this object.","example":"brand_001"},"BrandRef":{"type":"string","description":"Reference id that corresponds to the brand 'id' in ReferenceListBrand.Brand.","example":"brandRef_001"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Brand ID parent class, returned for branded fares.","discriminator":{"propertyName":"@type"}}},"components/schemas/CustomerLoyaltyCredit":{"id":"components/schemas/CustomerLoyaltyCredit","kind":"json-schema","title":"CustomerLoyaltyCredit","data":{"required":["CustomerLoyalty","Earned","Status"],"properties":{"@type":{"type":"string","example":"CustomerLoyaltyCredit"},"CustomerLoyalty":{"$ref":"#/components/schemas/CustomerLoyalty"},"Earned":{"maxLength":32,"type":"string","description":"Represents the amount of award credit awarded for this offer/offering. Award credit can be used for purchasing goods and services through a customer loyalty program","example":"500"},"Status":{"maxLength":32,"type":"string","description":"Represents the amount of status credit awarded for this offer/offering. Status credit allow a customer to move up the ladder of a customer loyalty program.","example":"gold"}},"description":"NDC only; not supported for GDS.  \nReturned only if CustomerLoyalty sent in the request. Returns information sent in the request and other details including the miles earned for this flight."}},"components/schemas/ClassOfServiceAvailability":{"id":"components/schemas/ClassOfServiceAvailability","kind":"json-schema","title":"ClassOfServiceAvailability","data":{"properties":{"value":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","description":"The class of service code. (RBD)","example":"F"},"number":{"type":"integer","description":"The amount of seats available on this class of service.","format":"int32","example":2},"status":{"$ref":"#/components/schemas/AvailabilityStatusENUM_Base"}},"description":"Returned in Air Availability API only. Defines the class of service, the number of seats available for the class of service, and the status of the class of service (E.g., Available)."}},"components/schemas/AvailabilityStatusENUM_Base":{"id":"components/schemas/AvailabilityStatusENUM_Base","kind":"json-schema","title":"AvailabilityStatusENUM_Base","data":{"type":"string","description":"List of availability status","example":"Available","enum":["Available","NotAvailable","Request","Waitlist","WaitlistClosed"]}},"components/schemas/FareQualifierENUM":{"id":"components/schemas/FareQualifierENUM","kind":"json-schema","title":"FareQualifierENUM","data":{"properties":{"value":{"$ref":"#/components/schemas/FareQualifierENUM_Base"}},"description":"deprecated - do not use","deprecated":true}},"components/schemas/FareQualifierENUM_Base":{"id":"components/schemas/FareQualifierENUM_Base","kind":"json-schema","title":"FareQualifierENUM_Base","data":{"type":"string","description":"Deprecated - do not use. Replaced by FareQualiferString","example":"Consolidator","deprecated":true,"enum":["Consolidator","Government","Marine","Military","Reward","StandBy","Staff","Student","Tour","Youth","VistFriendsAndRelatives"]}},"components/schemas/ReservationDisplaySequence":{"id":"components/schemas/ReservationDisplaySequence","kind":"json-schema","title":"ReservationDisplaySequence","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class ReservationDisplaySequence only","example":"ReservationDisplaySequence"},"DisplaySequence":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/DisplaySequence"}},"autoDeleteDateSequence":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The sequence of the autoDeleteDate (retention segment) within the Reservation","format":"int32"},"AuxiliaryDisplaySequence":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AuxiliaryDisplaySequence"}},"UnpricedSegmentDisplaySequence":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/UnpricedSegmentDisplaySequence"}}}}},"components/schemas/DisplaySequence":{"id":"components/schemas/DisplaySequence","kind":"json-schema","title":"DisplaySequence","data":{"required":["@type","OfferRef","displaySequence"],"properties":{"@type":{"type":"string","description":"Discriminator","example":"DisplaySequence"},"displaySequence":{"type":"integer","description":"The sequence the products are to be displayed for sequential date ordering. Data type has been corrected from string to integer in v11.24","format":"int32","example":1},"OfferRef":{"type":"string","description":"Offer reference"},"ProductRef":{"type":"string","description":"Product reference. If blank, display sequence applies to all products within the Offer."},"Sequence":{"type":"integer","description":"Segment sequence, if blank, display sequence applies to all segments within the product","format":"int32","example":1}}}},"components/schemas/AuxiliaryDisplaySequence":{"id":"components/schemas/AuxiliaryDisplaySequence","kind":"json-schema","title":"AuxiliaryDisplaySequence","data":{"required":["@type","displaySequence"],"properties":{"@type":{"type":"string","description":"Discriminator class AuxillaryDisplaySequence only","example":"AuxiliaryDisplaySequence"},"displaySequence":{"type":"integer","format":"int32","example":3},"CustomAuxiliarySegmentRef":{"type":"string","example":"aux_1"}}}},"components/schemas/UnpricedSegmentDisplaySequence":{"id":"components/schemas/UnpricedSegmentDisplaySequence","kind":"json-schema","title":"UnpricedSegmentDisplaySequence","data":{"required":["@type","UnpricedFlightSegmentRef","displaySequence"],"properties":{"@type":{"type":"string","description":"Discriminator class UnpricedSegmentDisplaySequence only","example":"UnpricedSegmentDisplaySequence"},"displaySequence":{"type":"integer","description":"The order for this segment to be displayed","format":"int32","example":2},"UnpricedFlightSegmentRef":{"type":"string","description":"Reference to the Unpriced Flight Segment","example":"s1"}},"description":"The sequence of the segment in date order."}},"components/schemas/AgencyServiceFee":{"id":"components/schemas/AgencyServiceFee","kind":"json-schema","title":"AgencyServiceFee","data":{"allOf":[{"$ref":"#/components/schemas/AgencyServiceFeeID"},{"required":["Amount"],"properties":{"ExpiryDate":{"type":"string","description":"The service fee expiry date. Once expiry date has been reached, the service fee information will only be stored in the ReservationReceipt","format":"date-time","example":"2022-08-07T12:12:00Z"},"Description":{"maxLength":512,"type":"string","description":"The description of the service fee","example":"Flight reservation service fee"},"Amount":{"$ref":"#/components/schemas/CurrencyAmount"},"Tax":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"RelatedDocumentNumber":{"$ref":"#/components/schemas/DocumentNumber"},"TravelerRef":{"type":"string","description":"Reference to a Traveler within the Reservation that this service fee applies to"},"OfferRef":{"type":"string","description":"Reference to an Offer within the Reservation that this service fee applies to"}}}]}},"components/schemas/AgencyServiceFeeID":{"id":"components/schemas/AgencyServiceFeeID","kind":"json-schema","title":"AgencyServiceFeeID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AgencyServiceFeeID or AgencyServiceFee","example":"AgencyServiceFee"},"id":{"type":"string","description":"Unique id for this object within a message","example":"AgencyServiceFee_1"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Tax":{"id":"components/schemas/Tax","kind":"json-schema","title":"Tax","data":{"properties":{"value":{"type":"number","description":"Amount of the tax. Returned as 0 if a tax was marked as exempt with TaxExemption.","format":"float","example":12.2},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"A ISO 4217 currency code associated to the value.","example":"USD"},"taxCode":{"maxLength":512,"type":"string","description":"Code for the tax.  \nFor Hotels this is the OTA code.","example":"XF2"},"reportingAuthority":{"maxLength":512,"type":"string","description":"Identifies the reporting authority such as airport code for XF taxes","example":"JFK1"},"purpose":{"maxLength":512,"type":"string","description":"Supplier returned description of tax.","example":"Fuel surcharge"},"description":{"maxLength":4096,"type":"string","description":"Short summary of the tax.  \nIn Air workflows this is returned only for NDC.  \nNote that descriptions are not returned for tax codes YQ and YR, which are fees charged by airlines and not government-imposed taxes.  \nFor Hotels this is the OTA tax description.","example":"Lodging tax"},"includedInBase":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"codeAuthority":{"maxLength":32,"type":"string","description":"Not used. Currency Code Authority","example":"ISO"},"decimalPlace":{"type":"integer","description":"Permitted number of decimals. Associated to the currency value.","format":"int32","example":2},"decimalAuthority":{"maxLength":32,"type":"string","description":"Not used. Currency decimal authority","example":"ISO"},"exemptInd":{"type":"boolean","description":"GDS only; not supported for NDC.  \nReturned if a tax was marked exempt in a prior request with the TaxExemption pricing modifer.  \nIf true, this tax is exempt\"","example":true},"nonRefundableInd":{"type":"boolean","description":"If true, the tax is non refundable. This indicator is only supported for exchange search and exchange price quote transactions.","example":true},"excludedFromTotalPriceInd":{"type":"boolean","description":"Returned in Hotel APIs when a tax is not included in the TotalPrice. Default behavior is for taxes to be included in TotalPrice.","example":true}},"description":"Breakdown of the individual Tax information"}},"components/schemas/DocumentNumber":{"id":"components/schemas/DocumentNumber","kind":"json-schema","title":"DocumentNumber","data":{"properties":{"value":{"maxLength":13,"pattern":"([0-9]+)?","type":"string","example":"1259900123456"},"documentIssuer":{"maxLength":2,"type":"string","description":"Document issuer","example":"BA"},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"},"travelerIdentifierRef":{"maxLength":128,"type":"string","description":"traveler identifier reference"},"name":{"maxLength":512,"type":"string","description":"The name of the Traveler being referenced."},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"The passenger type code of the Traveler being referenced.","example":"ADT"},"id":{"type":"string","description":"A locally referenced ID"},"description":{"type":"string","description":"Descriptive text used to identify the contents of a target object"},"uris":{"type":"array","description":"The URI used to GET the target object in another domain.","items":{"type":"string"}}},"description":"Document Number with additional attributes that the document represents"}},"components/schemas/DocumentTypeEnum":{"id":"components/schemas/DocumentTypeEnum","kind":"json-schema","title":"DocumentTypeEnum","data":{"type":"string","description":"Document type like EMD, MCO","example":"Ticket","enum":["EMD","MCO","Ticket","TASF","Invoice"],"x-enumDescriptions":{"EMD":"Electronic Miscellaneous document","MCO":"Miscellaneous Charge order","Ticket":"Ticket","TASF":"Travel Agency Service Fee","Invoice":"Invoice"}}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"allOf":[{"$ref":"#/components/schemas/GroupID"},{"required":["GroupName","totalGroupPlaces","unallocatedPlaces"],"properties":{"unallocatedPlaces":{"type":"integer","description":"The amount of unallocated places available which is the difference between the group size and the number of Travelers associated","format":"int32","example":5},"totalGroupPlaces":{"type":"integer","description":"The total number of passenger places available for this group booking","format":"int32","example":15},"GroupName":{"maxLength":128,"type":"string","example":"EUROPAGLOBALCONFERENCE"}}}]}},"components/schemas/GroupID":{"id":"components/schemas/GroupID","kind":"json-schema","title":"GroupID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"Group"},"id":{"type":"string","example":"group_001"},"GroupRef":{"type":"string","example":"groupRef_001"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/UnpricedSegments":{"id":"components/schemas/UnpricedSegments","kind":"json-schema","title":"UnpricedSegments","data":{"required":["@type","UnpricedFlightSegment"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"UnpricedSegments"},"UnpricedFlightSegment":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/UnpricedFlightSegment"}}},"description":"Top level object for request. Top level container object for response."}},"components/schemas/UnpricedFlightSegment":{"id":"components/schemas/UnpricedFlightSegment","kind":"json-schema","title":"UnpricedFlightSegment","data":{"required":["@type","Flight","sequence"],"properties":{"@type":{"type":"string","example":"UnpricedFlightsegment"},"id":{"type":"string","description":"Local identifier within a given message for this FlightSegment","example":"unpricedSegment_1"},"sequence":{"type":"integer","description":"Sequence of the leg of the segment.","format":"int32","example":1},"connectionDuration":{"type":"string","description":"The actual duration of the connecting FlightSegment","example":"PT2H30M"},"passengerQuantity":{"type":"integer","description":"Number of passengers on this segment.","format":"int32","example":2},"cabin":{"$ref":"#/components/schemas/CabinAirEnum"},"classOfService":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","description":"Class of service of the segment.","example":"Y"},"amenityRefs":{"type":"array","description":"List of amenity references for this flight","items":{"type":"string","example":"amenity_1"}},"universalProductAttributeRefs":{"type":"array","description":"List of universal product attributes for this flight.","example":"upa_1","items":{"type":"string"}},"passiveSegmentStatus":{"maxLength":2,"type":"string","description":"If the segment is to be sold as passive enter the passive segment status. AK supplier message sent upon cancel only, BK supplier message sent on book and cancel, YK Information only, no supplier message sent, segment cannot be priced or ticketed.","example":"AK"},"IntermediateStopAmenities":{"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/IntermediateStopAmenities"}},"OperationalStatus":{"$ref":"#/components/schemas/OperationalStatusENUM"},"Flight":{"$ref":"#/components/schemas/FlightID"},"Co2Actual":{"description":"The actual CO2 emissions of this flight. Measured in kilograms.","allOf":[{"$ref":"#/components/schemas/Measurement"}]},"boundFlightInd":{"type":"boolean","description":"If present and true, the Segments in this Connection are married."}},"description":"Flight segment information"}},"components/schemas/Accounting":{"id":"components/schemas/Accounting","kind":"json-schema","title":"Accounting","data":{"description":"Defines Accounting information. Used for all DOCI remarks.","allOf":[{"$ref":"#/components/schemas/AccountingID"},{"properties":{"dataType":{"maxLength":32,"type":"string","description":"Accounting data type. When used as Accounting remark designator the accepted value is DOCI.","example":"DateTime"},"template":{"maxLength":512,"type":"string","description":"Accounting template","example":"Internal Finance template"},"NameValuePair":{"maxItems":50,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Defines the type of accounting-specific remark (name) and the remark itself (value)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the following in \"name\" for each type of remark: DYO - Design Your Own Itinerary FS - Fare Saver CR - Canned Remarks TK - Ticket Number Details AC - Agent, Account, or Branch Details AR - Replace Sign On Code X* - Back Office Accounting Details FT - Free Text"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For remark text \"value\", please note character limits for each type of remark:  DYO - 2 digit, numeric FS - 9 characters total limit in format 1 (all numeric) or format 2 (numeric “–“ two alpha) CR - 42 characters total limit in format (two numeric \".\" two numeric \".\" etc) TK - 8 to 12 characters in format 1 (all numeric) or format 2 (numeric “-“ three numeric) AC - 42 characters, alphanumeric and some special characters AR - 10 characters, alphanumeric X* - 84 characters, alphanumeric and some special characters FT - 84 characters, alphanumeric and some special characters'"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/NameValuePair"}}}}]}},"components/schemas/DocumentOverrides":{"id":"components/schemas/DocumentOverrides","kind":"json-schema","title":"DocumentOverrides","data":{"allOf":[{"$ref":"#/components/schemas/DocumentOverridesID"},{"properties":{"OfferIdentifier":{"$ref":"#/components/schemas/OfferIdentifier"},"ProductIdentifier":{"$ref":"#/components/schemas/ProductIdentifier"},"Commissions":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Commissions"}},"DestinationPurpose":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DestinationPurpose"}},"Restrictions":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Restrictions"}},"TourCodes":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TourCodes"}},"ChangeFeeCollectionMethod":{"$ref":"#/components/schemas/ChangeFeeCollectionMethod"},"NetRemitInfo":{"$ref":"#/components/schemas/NetRemitInfo"},"TicketDesignators":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TicketDesignators"}},"InvoiceFareAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"residualValueAsEvenExchangeMIRInd":{"type":"boolean","description":"Report an exchange with residual value transaction as an Even exchange in the MIR.","example":true},"obFeeExemptInd":{"type":"boolean","description":"If true, the associated Offer is exempt from OB Payment Card Fees.","example":true}}}]}},"components/schemas/Commissions":{"id":"components/schemas/Commissions","kind":"json-schema","title":"Commissions","data":{"required":["Commission"],"properties":{"@type":{"type":"string","default":"Commissions"},"TravelerIdentifierRef":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"Commission":{"$ref":"#/components/schemas/Commission"},"ApplyTo":{"$ref":"#/components/schemas/CommissionApplyEnum"}},"description":"Commissions override"}},"components/schemas/CommissionApplyEnum":{"id":"components/schemas/CommissionApplyEnum","kind":"json-schema","title":"CommissionApplyEnum","data":{"type":"string","description":"List of commission Apply","example":"Base","enum":["Base","Fee"]}},"components/schemas/DestinationPurpose":{"id":"components/schemas/DestinationPurpose","kind":"json-schema","title":"DestinationPurpose","data":{"required":["destination","purpose"],"properties":{"@type":{"type":"string","example":"DestinationPurpose"},"destination":{"$ref":"#/components/schemas/DestinationEnum"},"purpose":{"$ref":"#/components/schemas/PurposeEnum"}}}},"components/schemas/DestinationEnum":{"id":"components/schemas/DestinationEnum","kind":"json-schema","title":"DestinationEnum","data":{"type":"string","description":"List of destinations","example":"Africa","enum":["United States of America","Mexico / Central America / Canal Zone/ Costa Rica","Islands and Countries of the Caribbean","South America","Europe","Africa","Middle East / Western Asia","Asia","Australia / New Zealand / Pacific Islands","Canada and Greenland"]}},"components/schemas/PurposeEnum":{"id":"components/schemas/PurposeEnum","kind":"json-schema","title":"PurposeEnum","data":{"type":"string","description":"The purpose exposed.","example":"Business","enum":["Business","Pleasure","Charter Service"]}},"components/schemas/Restrictions":{"id":"components/schemas/Restrictions","kind":"json-schema","title":"Restrictions","data":{"required":["Restriction"],"properties":{"@type":{"type":"string","default":"Restrictions"},"TravelerIdentifierRef":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"Restriction":{"maxItems":10,"minItems":1,"type":"array","items":{"maxLength":29,"type":"string","description":"The restriction/endorsement text. Maximum 29 characters per line.","example":"NON REFUNDABLE/NON ENDORSEABLE"}},"DocumentType":{"$ref":"#/components/schemas/DocumentTypeEnum"}},"description":"A list of restrictions applied to the document"}},"components/schemas/TourCodes":{"id":"components/schemas/TourCodes","kind":"json-schema","title":"TourCodes","data":{"required":["TourCode"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"TourCodes"},"TravelerIdentifierRef":{"maxItems":10,"type":"array","description":"Reference the traveler if the tour code is traveler specific. Leave blank to apply to all travelers.","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"TourCode":{"$ref":"#/components/schemas/TourCode"}},"description":"A tour code is a carrier specified and agreed code for a negotiated fare. It is used by the BSP or ARC data processing center to perform a series of calculations that may be based on the itinerary, agency code, dates, and other transaction attributes. The tour code can help identify airline-specific incentive payments such as commissions for fares that offer the most revenue."}},"components/schemas/TourCode":{"id":"components/schemas/TourCode","kind":"json-schema","title":"TourCode","data":{"properties":{"value":{"maxLength":32,"type":"string","description":"The actual value of the tour code."},"tourCodeType":{"$ref":"#/components/schemas/TourCodeTypeEnum"}},"description":"Tour code"}},"components/schemas/TourCodeTypeEnum":{"id":"components/schemas/TourCodeTypeEnum","kind":"json-schema","title":"TourCodeTypeEnum","data":{"type":"string","description":"List of tour code types.","example":"Inclusive Tour","enum":["Bulk Tour","Inclusive Tour"]}},"components/schemas/ChangeFeeCollectionMethod":{"id":"components/schemas/ChangeFeeCollectionMethod","kind":"json-schema","title":"ChangeFeeCollectionMethod","data":{"required":["code"],"properties":{"value":{"$ref":"#/components/schemas/ChangeFeeMethodEnum"},"code":{"maxLength":32,"type":"string","description":"The code value","example":"f2142"},"subCode":{"maxLength":32,"type":"string","description":"The subcode value","example":"631b"},"description":{"maxLength":128,"type":"string","description":"The description value","example":"Change fee collection method"},"changeFeeIssuedSeparatelyInd":{"type":"boolean","description":"if true, the change fee will be issued as a separate transaction to the residual amount","example":true},"taxIncludedInBaseAmountInd":{"type":"boolean","description":"If true, the tax  on the fee will be included in the base fee amount and sent as a single value to the supplier for fulfilment","example":true}}}},"components/schemas/ChangeFeeMethodEnum":{"id":"components/schemas/ChangeFeeMethodEnum","kind":"json-schema","title":"ChangeFeeMethodEnum","data":{"type":"string","description":"List of change fee method","example":"EMD","enum":["EMD","MCO","Tax","Unknown"]}},"components/schemas/NetRemitInfo":{"id":"components/schemas/NetRemitInfo","kind":"json-schema","title":"NetRemitInfo","data":{"properties":{"@type":{"type":"string","example":"NetRemitInfo"},"CarCode":{"maxLength":32,"type":"string","description":"The CAR code or deal code applied to this product for use in net remit.","example":"ACAR"},"ValueCode":{"maxLength":32,"type":"string","description":"The Value code applied to this product for use in net remit","example":"D1000"},"ActualSellingFare":{"type":"number","description":"The actual selling fare which will override the Offer base fare on the document","format":"float","example":100.5},"NetBaseAmount":{"$ref":"#/components/schemas/FiledAmount"},"ClientDiscountCode":{"maxLength":32,"type":"string","description":"The client discount code applied to this product for net remit.","example":"DEF456"}}}},"components/schemas/FiledAmount":{"id":"components/schemas/FiledAmount","kind":"json-schema","title":"FiledAmount","data":{"required":["decimalPlace"],"properties":{"value":{"type":"number","description":"Filed amount value","format":"float","example":43.3422},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Code for the currency in which the base fare was filed.","example":"USD"},"codeAuthority":{"maxLength":32,"type":"string","description":"Filed amount currency code authority","example":"Australian Dollar"},"decimalPlace":{"type":"integer","description":"Number of decimal places in the currency in ISO 4217 standard format.","format":"int32","example":3},"decimalAuthority":{"maxLength":32,"type":"string","description":"ISO 4217 standard decimal authority","example":"ISO 4217"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned only in the Price APIs. GDS only; not supported for NDC."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The base amount of a ticket price or net price that is filed in local currency."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when the origin currency is not the same as the PCC currency to show the currency in which the base fare has been filed."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When used for NetBaseAmount: Net ticket data (NTD) is returned in the AirPrice, AirReservation, Exchange Search, and Reservation Retrieve responses for any GDS fare that has a private fare component (fareType=AgencyPrivateFare). When NTD is returned, TermsAndConditionsFuill includes FareGuaranteePolicy to return the fare calculation indicator for the fare.   When NTD is returned, PriceBreakdown may include NetBaseAmount."},"children":[]}]}]}]}},"components/schemas/TicketDesignators":{"id":"components/schemas/TicketDesignators","kind":"json-schema","title":"TicketDesignators","data":{"required":["@type","TicketDesignator"],"properties":{"@type":{"type":"string","description":"Discriminator class TicketDesignators only"},"TravelerIdentifierRef":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"TicketDesignator":{"maxLength":32,"type":"string"}}}},"components/schemas/CustomRule":{"id":"components/schemas/CustomRule","kind":"json-schema","title":"CustomRule","data":{"properties":{"PseudoCityCode":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"The PCC that the custom rule belongs to"},"RuleRecord":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/RuleRecord"}}},"allOf":[{"$ref":"#/components/schemas/CustomRuleID"}]}},"components/schemas/CustomRuleID":{"id":"components/schemas/CustomRuleID","kind":"json-schema","title":"CustomRuleID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes CustomRuleID or CustomRule"},"id":{"type":"string","description":"Custom rule id reference ID."},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/RuleRecord":{"id":"components/schemas/RuleRecord","kind":"json-schema","title":"RuleRecord","data":{"required":["@type","RuleRecordName","sequence"],"properties":{"@type":{"type":"string","description":"Discriminator class RuleRecord only"},"sequence":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The sequence of the RuleRecord line","format":"int32"},"RuleRecordName":{"maxLength":32,"type":"string","description":"The name of the rule record","example":"CTCM"},"RuleText":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/RuleText"}}}}},"components/schemas/RuleText":{"id":"components/schemas/RuleText","kind":"json-schema","title":"RuleText","data":{"required":["@type","StringText","sequence"],"properties":{"@type":{"type":"string","description":"Discriminator class RuleText only"},"sequence":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The sequence of the RuleText line","format":"int32"},"StringText":{"maxLength":512,"type":"string"}}}},"components/schemas/ReservationDetailListResponseWrapper":{"id":"components/schemas/ReservationDetailListResponseWrapper","kind":"json-schema","title":"ReservationDetailListResponseWrapper","data":{"properties":{"ReservationDetailMultipleResponse":{"$ref":"#/components/schemas/ReservationDetailMultipleResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReservationDetailMultipleResponse":{"id":"components/schemas/ReservationDetailMultipleResponse","kind":"json-schema","title":"ReservationDetailMultipleResponse","data":{"description":"An array of ReservationResponse objects to support multiple individual hotel reservations within a single payload.","allOf":[{"properties":{"ReservationResponses":{"type":"array","items":{"$ref":"#/components/schemas/ReservationResponse"}}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ReservationQueryBuildMultipleWrapper":{"id":"components/schemas/ReservationQueryBuildMultipleWrapper","kind":"json-schema","title":"ReservationQueryBuildMultipleWrapper","data":{"properties":{"ReservationQueryBuildMultiple":{"$ref":"#/components/schemas/ReservationQueryBuildMultiple"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReservationQueryBuildMultiple":{"id":"components/schemas/ReservationQueryBuildMultiple","kind":"json-schema","title":"ReservationQueryBuildMultiple","data":{"properties":{"ReservationBuildsFromCatalogOffering":{"type":"array","items":{"$ref":"#/components/schemas/ReservationBuildFromCatalogOffering"}}},"description":"Used for a Create Hotel Reservation (Multiple, Reference Payload) request. Defines a request to create multiple individual hotel reservations in a single payload by referencing cached offer data from a preceding Hotel Availability or SearchComplete response. If the cached offers expire before booking, a new request must be sent to refresh them. This request typically follows Hotel Availability, Rules, or SearchComplete and is sent to finalize a booking."}},"components/schemas/ReservationBuildFromCatalogOffering":{"id":"components/schemas/ReservationBuildFromCatalogOffering","kind":"json-schema","title":"ReservationBuildFromCatalogOffering","data":{"description":"Defines the reservation build details used to create a hotel reservation from a cached hotel availability (catalog offering), including traveler, payment, and related booking details.","allOf":[{"$ref":"#/components/schemas/ReservationBuild"},{"properties":{"id":{"type":"string","description":"Sequence of the reservation when part of build multiple reservations","example":"ref_001"},"BuildFromCatalogOfferingHospitality":{"$ref":"#/components/schemas/BuildFromCatalogOfferingHospitality"}}}]}},"components/schemas/IdentifierTypeENUM":{"id":"components/schemas/IdentifierTypeENUM","kind":"json-schema","title":"IdentifierTypeENUM","data":{"type":"string","example":"Locator","enum":["Reservation","Locator","SupplierLocator","DocumentNumber"]}},"components/schemas/ErrorResponseWrapper":{"id":"components/schemas/ErrorResponseWrapper","kind":"json-schema","title":"ErrorResponseWrapper","data":{"properties":{"ErrorResponse":{"$ref":"#/components/schemas/ErrorResponse"}},"description":"Wrapper object"}},"components/schemas/ReservationQueryCommitReservation":{"id":"components/schemas/ReservationQueryCommitReservation","kind":"json-schema","title":"ReservationQueryCommitReservation","data":{"properties":{"Notification":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"scheduleChangeAcceptedInd":{"type":"boolean","description":"If true, the schedule change is accepted by the consumer."},"errorWhenOfferPriceCancelledInd":{"type":"boolean","deprecated":true},"inhibitResidualDocumentIssuanceInd":{"type":"boolean","description":"If true, any residual value will not be applied to an MCO or EMD.","example":true},"enableTwoStepCommitInd":{"type":"boolean","description":"If true, reservation warnings such as minimum connection time will be returned to the user for review and a second commit will be required to proceed with creating the reservation.","example":true},"overrideMCTInd":{"type":"boolean","description":"If true, the minimum connection time warning will be ignored and the Reservation created.","example":true},"errorWhenScheduleChangesInd":{"type":"boolean","description":"If true, an error will be returned when the flight schedule changes during commit processing","example":true},"scheduleChangeReprice":{"$ref":"#/components/schemas/ScheduleChangeRepriceEnum"},"ReceivedFrom":{"maxLength":61,"type":"string","description":"Override the received from field with custom data. Field is stored in Reservation history.","example":"TW"},"errorWhenOfferPriceChangesInd":{"type":"boolean","description":"If true, an error will be returned when the flight price changes during commit processing.","example":true}}}},"components/schemas/ScheduleChangeRepriceEnum":{"id":"components/schemas/ScheduleChangeRepriceEnum","kind":"json-schema","title":"ScheduleChangeRepriceEnum","data":{"type":"string","example":"AcceptOfferPriceDifference","enum":["RetainOfferPrice","AcceptOfferPriceDifference"]}},"components/schemas/OfferQueryBuildHotelFromCatalogOfferingWrapper":{"id":"components/schemas/OfferQueryBuildHotelFromCatalogOfferingWrapper","kind":"json-schema","title":"OfferQueryBuildHotelFromCatalogOfferingWrapper","data":{"properties":{"OfferQueryBuildHotelFromCatalogOfferingRequest":{"$ref":"#/components/schemas/OfferQueryBuildHotelFromCatalogOfferingRequest"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/OfferQueryBuildHotelFromCatalogOfferingRequest":{"id":"components/schemas/OfferQueryBuildHotelFromCatalogOfferingRequest","kind":"json-schema","title":"OfferQueryBuildHotelFromCatalogOfferingRequest","data":{"properties":{"OfferQueryBuildHotelsFromCatalogOffering":{"type":"array","items":{"$ref":"#/components/schemas/OfferQueryBuildHotelFromCatalogOffering"}}}}},"components/schemas/OfferQueryBuildHotelFromCatalogOffering":{"id":"components/schemas/OfferQueryBuildHotelFromCatalogOffering","kind":"json-schema","title":"OfferQueryBuildHotelFromCatalogOffering","data":{"required":["BuildFromCatalogOfferingHospitality","FormOfPaymentID","TravelerID"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryBuildHotelFromCatalogOffering only","example":"OfferQueryBuildHotelFromCatalogOffering"},"BuildFromCatalogOfferingHospitality":{"$ref":"#/components/schemas/BuildFromCatalogOfferingHospitality"},"TravelerID":{"type":"string","description":"Reference the Traveler ID from the workbench that this hotel is to be booked for. If not sent, the first traveler in the reservation will be allocated to the hotel.","example":"traveler_1"},"FormOfPaymentID":{"type":"string","description":"Reference the Form Of Payment ID from the workbench that will be used for guarantee or deposit of this hotel.","example":"formOfPayment_1"},"DepositInd":{"type":"boolean","description":"If true, the payment is a deposit on the referenced Offer. Default is guarantee."},"SpecialInstruction":{"maxLength":50,"type":"string","description":"Customer generated special instructions transmitted to the hotel.","example":"Guest prefers room on first floor."}}}},"components/schemas/OfferHospitalityWrapper":{"id":"components/schemas/OfferHospitalityWrapper","kind":"json-schema","title":"OfferHospitalityWrapper","data":{"properties":{"OfferHospitalityRequest":{"$ref":"#/components/schemas/OfferHospitalityRequest"}},"description":"Wrapper schema to expose the root element in the JSON example"}},"components/schemas/OfferHospitalityRequest":{"id":"components/schemas/OfferHospitalityRequest","kind":"json-schema","title":"OfferHospitalityRequest","data":{"properties":{"OffersHospitality":{"type":"array","items":{"$ref":"#/components/schemas/OfferHospitality"}}}}},"components/schemas/OfferHospitality":{"id":"components/schemas/OfferHospitality","kind":"json-schema","title":"OfferHospitality","data":{"required":["FormOfPaymentID","Offer","TravelerID"],"properties":{"Offer":{"$ref":"#/components/schemas/Offer"},"TravelerID":{"type":"string","description":"Reference the Traveler ID from the workbench that this hotel is to be booked for. If not sent, the first traveler in the reservation will be allocated to the hotel.","example":"traveler_1"},"FormOfPaymentID":{"type":"string","description":"Reference the Form Of Payment ID from the workbench that will be used for guarantee or deposit of this hotel.","example":"formOfPayment_1"},"DepositInd":{"type":"boolean","description":"If true, the payment is a deposit on the referenced Offer. Default is guarantee."},"SpecialInstruction":{"maxLength":50,"type":"string","description":"Customer generated special instructions transmitted to the hotel.","example":"Guest prefers room on first floor."},"SupplierLocator":{"description":"Pass supplier locator for passive segment bookings.","allOf":[{"$ref":"#/components/schemas/SupplierLocator"}]}},"description":"Create full payload hotel offers (workbench)."}},"components/schemas/SupplierLocator":{"id":"components/schemas/SupplierLocator","kind":"json-schema","title":"SupplierLocator","data":{"properties":{"value":{"maxLength":16,"pattern":"([A-Z0-9]+)?","type":"string","description":"The external or supplier-issued locator.","example":"WTR45G"},"supplierCode":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string","description":"Supplier Code; generally the releated IATA code for the carrier or agency.","example":"AA"},"supplierName":{"maxLength":64,"type":"string","description":"Name of the supplier","example":"American Airlines"}},"description":"The supplier and the supplier's locator code for a product."}},"components/schemas/TravelerListRequest":{"id":"components/schemas/TravelerListRequest","kind":"json-schema","title":"TravelerListRequest","data":{"required":["Traveler"],"properties":{"Traveler":{"maxItems":9,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Traveler"}}},"description":"Supports Traveler as an array. Required for adding multiple travelers in one request; optional for adding a single traveler.  \nYou may send up to nine travelers in a single request. Best practice is to send TravelerListRequest for all Add Traveler requests.  \nNote the different endpoint when adding multiple travelers - appending /list to travelers."}},"components/schemas/TravelerListResponseWrapper":{"id":"components/schemas/TravelerListResponseWrapper","kind":"json-schema","title":"TravelerListResponseWrapper","data":{"properties":{"TravelerListResponse":{"$ref":"#/components/schemas/TravelerListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelerListResponse":{"id":"components/schemas/TravelerListResponse","kind":"json-schema","title":"TravelerListResponse","data":{"properties":{"TravelerID":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TravelerID"}}},"description":"The response of a Add Multiple Travelers endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/FormOfPaymentResponseWrapper":{"id":"components/schemas/FormOfPaymentResponseWrapper","kind":"json-schema","title":"FormOfPaymentResponseWrapper","data":{"properties":{"FormOfPaymentResponse":{"$ref":"#/components/schemas/FormOfPaymentResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/FormOfPaymentResponse":{"id":"components/schemas/FormOfPaymentResponse","kind":"json-schema","title":"FormOfPaymentResponse","data":{"properties":{"FormOfPayment":{"$ref":"#/components/schemas/FormOfPaymentIdentifier"}},"description":"The response of a Form of payment endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ReservationCommentListRequest":{"id":"components/schemas/ReservationCommentListRequest","kind":"json-schema","title":"ReservationCommentListRequest","data":{"required":["ReservationComment"],"properties":{"ReservationComment":{"maxItems":100,"minItems":1,"type":"array","example":["reservation_1","reservation2"],"items":{"$ref":"#/components/schemas/ReservationComment"}}}}},"components/schemas/ReservationCommentListResponseWrapper":{"id":"components/schemas/ReservationCommentListResponseWrapper","kind":"json-schema","title":"ReservationCommentListResponseWrapper","data":{"properties":{"ReservationCommentListResponse":{"$ref":"#/components/schemas/ReservationCommentListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReservationCommentListResponse":{"id":"components/schemas/ReservationCommentListResponse","kind":"json-schema","title":"ReservationCommentListResponse","data":{"properties":{"ReservationCommentID":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ReservationCommentID"}}},"description":"The response of a Reservation comment list endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ReservationQueryClientProfileMove":{"id":"components/schemas/ReservationQueryClientProfileMove","kind":"json-schema","title":"ReservationQueryClientProfileMove","data":{"required":["ClientProfileMoveHeaderModifiers"],"properties":{"ClientProfileMoveHeaderModifiers":{"$ref":"#/components/schemas/ClientProfileMoveHeaderModifiers"},"ClientProfileMoveLineModifiers":{"type":"array","items":{"$ref":"#/components/schemas/ClientProfileMoveLineModifiers"}},"ClientProfileMoveTravelerFlightModifiers":{"type":"array","items":{"$ref":"#/components/schemas/ClientProfileMoveTravelerFlightModifiers"}}}}},"components/schemas/ClientProfileMoveHeaderModifiers":{"id":"components/schemas/ClientProfileMoveHeaderModifiers","kind":"json-schema","title":"ClientProfileMoveHeaderModifiers","data":{"required":["BusinessTitle"],"properties":{"BusinessTitle":{"maxLength":21,"type":"string","description":"The name of the corporation/business account the profile is associated to","example":"ABCCORP"},"PersonalTitle":{"maxLength":21,"type":"string","description":"The name of the Traveler the profile is associated to","example":"SMITH/J"},"MultipleIndicator":{"type":"boolean","description":"If true, Indicates the move is a multiple level Client File  move. For example, you can move only a Personal File (single), or you can move the Personal, Business, and Agency Files (multiple)."},"SelectIndicator":{"type":"boolean","description":"If true, Indicates this is a select line move. If false or blank move all lines"},"MergeIndicator":{"type":"boolean","description":"Indicates how any associated TravelScreen Preferences should be activated at the time of the Client File Move. If true, merged preferences will be moved. If false of blank, normal preferences will be moved."},"RelatedMoveIndicator":{"maxLength":1,"type":"string","description":"Indicates the passenger and segment relation for the related move. Value set to Y indicates relation move required. Value set to P indicates Passenger Number is to be used when moving Secure Flight data.","example":"Y"},"ProfilePCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"If profile PCC is included as a modifier, this will override the requesting PCC"}}}},"components/schemas/ClientProfileMoveLineModifiers":{"id":"components/schemas/ClientProfileMoveLineModifiers","kind":"json-schema","title":"ClientProfileMoveLineModifiers","data":{"required":["LineNumber"],"properties":{"LineNumber":{"type":"integer","description":"Line Number","format":"int32","example":3},"AppendedData":{"maxLength":58,"type":"string","description":"Data to be appended to the above Client File line","example":"15MAY"}}}},"components/schemas/ClientProfileMoveTravelerFlightModifiers":{"id":"components/schemas/ClientProfileMoveTravelerFlightModifiers","kind":"json-schema","title":"ClientProfileMoveTravelerFlightModifiers","data":{"required":["TravelerRef"],"properties":{"TravelerRef":{"type":"string","description":"The Traveler ref to associate related lines of the client profile","example":"t1"},"FlightRef":{"type":"string","description":"The Flight ref to associate the related lines of the client profile","example":"s1"}}}},"components/schemas/ReservationDetailWrapper":{"id":"components/schemas/ReservationDetailWrapper","kind":"json-schema","title":"ReservationDetailWrapper","data":{"properties":{"ReservationDetail":{"$ref":"#/components/schemas/ReservationDetail"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TermsAndConditionsFullHospitality":{"id":"components/schemas/TermsAndConditionsFullHospitality","kind":"json-schema","title":"TermsAndConditionsFullHospitality","data":{"description":"Defines the Terms and Conditions present on a specific hotel offer. For a Hotel Create Reservation (Full Payload) request, be sure to send TermsAndConditionsFull if it was returned in the Availability response.","allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFull"},{"properties":{"Guarantee":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Guarantee"}},"CancelPenalty":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/CancelPenalty"}},"AcceptedCreditCard":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AcceptedCreditCard"}},"Description":{"maxItems":10,"type":"array","description":"Free-form text for a room and rate description.This duplicates the room description in RoomType and the rate description in Price; planned for deprecation.","items":{"type":"string"}},"MealsIncluded":{"$ref":"#/components/schemas/MealsIncluded"},"ProductRateCodeInfo":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ProductRateCodeInfo"}},"CheckInOutPolicy":{"$ref":"#/components/schemas/CheckInOutPolicy"},"DepositPolicy":{"$ref":"#/components/schemas/DepositPolicy"},"RatePaymentInfo":{"$ref":"#/components/schemas/RatePaymentEnum"},"CustomerLoyaltyIDRequiredAtReservation":{"type":"boolean","description":"If true, the rate returned is contingent on a membership number to be included within the sell request, typically associated to frequent guest or frequent flyer loyalty numbers."},"RateQualificationIDRequiredAtCheckIn":{"type":"boolean","description":"If true, the rate returned is contingent on qualification to be presented at check-in at the property; the discounted rate returned may be denied at the property if guest does not show proof of qualifying, typically a government/military/workplace/association/membership ID."}}}]}},"components/schemas/TermsAndConditionsFull":{"id":"components/schemas/TermsAndConditionsFull","kind":"json-schema","title":"TermsAndConditionsFull","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFullID"},{"properties":{"ExpiryDate":{"type":"string","description":"The date and time in UTC the offer will no longer be valid.","format":"date-time","example":"2022-08-07T12:12:00Z"},"CustomerLoyalty":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyalty"}},"TextBlock":{"maxItems":50,"type":"array","description":"A list of free text terms and conditions.","items":{"$ref":"#/components/schemas/TextBlock"}}}}]}},"components/schemas/TextBlock":{"id":"components/schemas/TextBlock","kind":"json-schema","title":"TextBlock","data":{"required":["@type","TextFormatted"],"properties":{"@type":{"type":"string","description":"Discriminator classes TextBlock or TextBlockDetail","example":"TextBlockDetail"},"title":{"maxLength":512,"type":"string","description":"The title of the rule or information. \nFor TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values.","example":"Baggage Details"},"id":{"type":"string","description":"Internally referenced id","example":"2"},"TextFormatted":{"maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TextFormatted"}}},"description":"Each instance is one rule or set of information."}},"components/schemas/TextFormatted":{"id":"components/schemas/TextFormatted","kind":"json-schema","title":"TextFormatted","data":{"properties":{"value":{"maxLength":4096,"type":"string","description":"The actual text of the hotel rule or information.","example":"ID Required Must Guarantee Late Arrival"},"language":{"type":"string","description":"The language in which the text or rule is provided.","example":"English"},"textFormat":{"$ref":"#/components/schemas/TextFormatEnum"}},"description":"Provides text, generally rules or information, and indicates how it is formatted."}},"components/schemas/TextFormatEnum":{"id":"components/schemas/TextFormatEnum","kind":"json-schema","title":"TextFormatEnum","data":{"type":"string","description":"Describes the format of text such as plain text or html","enum":["PlainText","HTML"]}},"components/schemas/Guarantee":{"id":"components/schemas/Guarantee","kind":"json-schema","title":"Guarantee","data":{"properties":{"@type":{"type":"string","default":"Guarantee"},"code":{"maxLength":32,"type":"string","description":"The guarantee code"},"guaranteeType":{"$ref":"#/components/schemas/GuaranteeTypeEnum"},"credentialsRequiredInd":{"type":"boolean"}},"description":"If returned by the provider, Guarantee indicates whether payment is required to hold the room."}},"components/schemas/GuaranteeTypeEnum":{"id":"components/schemas/GuaranteeTypeEnum","kind":"json-schema","title":"GuaranteeTypeEnum","data":{"type":"string","description":"Defines the type of guarantee to be applied to this reservation.","enum":["GuaranteeRequired","CC/DC/Voucher","Profile","NoGuaranteesAccepted","GuaranteesAccepted","DepositRequired","GuaranteesNotRequired","DepositNotRequired","PrepayRequired","PrepayNotRequired","NoDepositsAccepted"]}},"components/schemas/CancelPenalty":{"id":"components/schemas/CancelPenalty","kind":"json-schema","title":"CancelPenalty","data":{"properties":{"@type":{"type":"string","default":"CancelPenalty"},"Description":{"type":"string","description":"A readable text equivalent of the structured Deadline/HotelPenalty combination.","example":"If you cancel, modify, or do not arrive until Dec 01, 2025, you will be charged with a fee of 100% of the total stay."},"Deadline":{"$ref":"#/components/schemas/Deadline"},"HotelPenalty":{"$ref":"#/components/schemas/HotelPenalty"},"Refundable":{"$ref":"#/components/schemas/YesNoUnknownEnum"}},"description":"Defines the cancellation policy of the hotel facility. When there is a refundable period and a non-refundable period for a rate, separate instances of CancelPenalty return the Deadline and HotelPenalty objects for each period."}},"components/schemas/Deadline":{"id":"components/schemas/Deadline","kind":"json-schema","title":"Deadline","data":{"required":["SpecificDate"],"properties":{"@type":{"type":"string","default":"Deadline"},"SpecificDate":{"$ref":"#/components/schemas/DateOrDateWindows"},"Time":{"type":"string","description":"The deadline time in 24-hour HH:MM:SS format, in the local time of the property."}},"description":"The absolute deadline, or amount of offset time prior to a deadline, before a payment or cancel goes into effect."}},"components/schemas/HotelPenalty":{"id":"components/schemas/HotelPenalty","kind":"json-schema","title":"HotelPenalty","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes HotelPenaltyAmount, HotelPenaltyNights, and HotelPenaltyPercent"},"subjectToTax":{"$ref":"#/components/schemas/YesNoUnknownEnum"}},"description":"Cancellation penalty amount. Returns different objects based on penalty type. \nFor HotelPenaltyNights, the Nights and subjectToTax objects may return. \nFor HotelPenaltyPercent, the Percent and appliesTo objects may return. \nFor HotelPenaltyAmount, the Amount and includesTax objects may return.","discriminator":{"propertyName":"@type"}}},"components/schemas/AcceptedCreditCard":{"id":"components/schemas/AcceptedCreditCard","kind":"json-schema","title":"AcceptedCreditCard","data":{"properties":{"value":{"maxLength":2,"pattern":"([A-Z0-9]+)?","type":"string","description":"Two-character code of credit card type.","example":"VI"},"processingCountry":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Country Code ISO"}},"description":"A list of accepted credit cards."}},"components/schemas/MealsIncluded":{"id":"components/schemas/MealsIncluded","kind":"json-schema","title":"MealsIncluded","data":{"properties":{"breakfastInd":{"type":"boolean"},"lunchInd":{"type":"boolean"},"dinnerInd":{"type":"boolean"}},"description":"Meal attributes are returned with a value of true if a meal is included."}},"components/schemas/ProductRateCodeInfo":{"id":"components/schemas/ProductRateCodeInfo","kind":"json-schema","title":"ProductRateCodeInfo","data":{"required":["RateCodeInfo"],"properties":{"@type":{"type":"string","example":"ProductRateCodeInfo"},"ProductRef":{"type":"string","description":"Product reference","example":"product_1"},"RateCodeInfo":{"$ref":"#/components/schemas/RateCodeInfo"},"ExtraAccommodation":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ExtraAccommodation"}}},"description":"Includes any negotiated rate code details if applicable to this offer."}},"components/schemas/RateCodeInfo":{"id":"components/schemas/RateCodeInfo","kind":"json-schema","title":"RateCodeInfo","data":{"properties":{"value":{"maxLength":32,"type":"string","description":"The negotiated rate plan code.","example":"HL12344"},"rateName":{"maxLength":32,"type":"string","description":"Name of the rate plan.","example":"Special"},"rateID":{"maxLength":32,"type":"string","description":"ID of the rate plan associated with the negotiated rate plan code.","example":"2345"},"rateCategory":{"$ref":"#/components/schemas/RateCategoryEnum"}},"description":"Rate code information for this offer, if applicable.  \nFor a Hotel Create Reservation (Full Payload) request, send RateCodeInfo when it's returned in the Availability response. Send the values from ProductRateCodeInfo/RateCodeInfo. You must include value and rateID. When returned from Availability, additionally send rateCategory and rateName."}},"components/schemas/DepositPolicy":{"id":"components/schemas/DepositPolicy","kind":"json-schema","title":"DepositPolicy","data":{"required":["Deposit"],"properties":{"@type":{"type":"string","example":"DepositPolicy"},"Deposit":{"maxItems":3,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Deposit"}}},"description":"If returned by the provider, DepositPolicy indicates whether a deposit is required to hold the room."}},"components/schemas/Deposit":{"id":"components/schemas/Deposit","kind":"json-schema","title":"Deposit","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes DepositAmount or DepositPercent","example":"DepositAmount"},"Date":{"type":"string","description":"The date and time the deposit is due","format":"date-time","example":"2026-08-07T12:12:00Z"},"remainderInd":{"type":"boolean","description":"Indicates if a deposit was part of the TotalPrice. If true, a remainder is due and the related Date object will indicate when that deposit amount is due. If false, the deposit was part of TotalPrice and no remainder is due."}},"description":"Deposit amount in relation to TotalPrice.","discriminator":{"propertyName":"@type"}}},"components/schemas/RatePaymentEnum":{"id":"components/schemas/RatePaymentEnum","kind":"json-schema","title":"RatePaymentEnum","data":{"type":"string","description":"Payment Rate designation","example":"PrePay","enum":["PrePay","PostPay","Unknown"],"x-enumDescriptions":{"PrePay":"Payment must be made at the time of booking.","PostPay":"Payment is made upon arrival. Generally, only credit card details are required to hold the reservation."}}},"components/schemas/ProductHospitality":{"id":"components/schemas/ProductHospitality","kind":"json-schema","title":"ProductHospitality","data":{"allOf":[{"$ref":"#/components/schemas/Product"},{"required":["PropertyKey"],"properties":{"bookingCode":{"maxLength":32,"type":"string","description":"Send the value returned from the Availability response ProductOptions/ProductBooking."},"passiveBookingReasonCode":{"$ref":"#/components/schemas/PassiveBookingReasonCodeENUM"},"guests":{"type":"integer","description":"Total number of guests. Numeric values 1-9 inclusive supported.","format":"int32"},"moreRatesToken":{"maxLength":512,"type":"string","description":"More rates token"},"adaCompliant":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"propertyName":{"maxLength":128,"type":"string","description":"Name of property offering this product.","example":"Hilton Garden Inn Brighton"},"associatedCityCode":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The logistically closest city associated to the property","example":"LON"},"associatedAirportCode":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The logistically closest airport associated to the property","example":"LGW"},"PropertyAddress":{"$ref":"#/components/schemas/Address"},"Telephone":{"$ref":"#/components/schemas/Telephone"},"Email":{"$ref":"#/components/schemas/Email"},"GuestCounts":{"$ref":"#/components/schemas/GuestCounts"},"PropertyKey":{"$ref":"#/components/schemas/PropertyKey"},"TravelerContact":{"$ref":"#/components/schemas/TravelerContact"},"RoomType":{"$ref":"#/components/schemas/RoomType"},"DateRange":{"$ref":"#/components/schemas/DateRange"},"SpecialInstruction":{"maxLength":50,"type":"string","description":"Customer generated special instructions transmitted to the hotel.","example":"Guest prefers room on first floor."}}}]}},"components/schemas/PassiveBookingReasonCodeENUM":{"id":"components/schemas/PassiveBookingReasonCodeENUM","kind":"json-schema","title":"PassiveBookingReasonCodeENUM","data":{"type":"string","example":"I","enum":["G","H","I","N","P","R","U","V"],"x-enumDescriptions":{"G":"Group Booking","H":"Property not listed","I":"Internet only rate","N":"Multi-level rate not offered","P":"Package or Tour rate not offered","R":"Rate not offered","U":"Property sold out","V":"Government rate not offered"}}},"components/schemas/TravelerContact":{"id":"components/schemas/TravelerContact","kind":"json-schema","title":"TravelerContact","data":{"required":["@type"],"type":"object","properties":{"@type":{"type":"string","example":"TravelerContact"},"Email":{"$ref":"#/components/schemas/Email"},"Telephone":{"$ref":"#/components/schemas/Telephone"}},"description":"Identifies the traveler contact information delivered to the hotel supplier for this segment"}},"components/schemas/RoomType":{"id":"components/schemas/RoomType","kind":"json-schema","title":"RoomType","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"RoomType"},"RoomCharacteristics":{"$ref":"#/components/schemas/RoomCharacteristics"},"Description":{"$ref":"#/components/schemas/TextTitleAndDescription"},"RoomAmenity":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/RoomAmenity"}}},"description":"Provides details regarding rooms, such as characteristics, descriptions, and amenities.","discriminator":{"propertyName":"@type"}}},"components/schemas/RoomCharacteristics":{"id":"components/schemas/RoomCharacteristics","kind":"json-schema","title":"RoomCharacteristics","data":{"properties":{"@type":{"type":"string","default":"RoomCharacteristics"},"typeCode":{"maxLength":32,"type":"string","description":"OTA room type code."},"viewCode":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code describing the view."},"viewDescription":{"type":"string","description":"Free text describing the view","example":"Mountain View"},"category":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Category of the room.","deprecated":true},"smokingAllowed":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"wifiIncluded":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"BedConfiguration":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/BedConfiguration"}},"nonSmokingInd":{"type":"boolean"},"shortRoomDescription":{"maxLength":100,"type":"string","description":"Normalized text for grouping rates against similar room types.","example":"2 Queen bed(s) Standard Room Smoking","deprecated":true},"accessibleRoom":{"$ref":"#/components/schemas/YesNoUnknownEnum"}},"description":"Used to define a room (eg. its location, configuration, view)."}},"components/schemas/BedConfiguration":{"id":"components/schemas/BedConfiguration","kind":"json-schema","title":"BedConfiguration","data":{"properties":{"quantity":{"type":"integer","description":"The number of beds of a specified type in the room.","format":"int32"},"bedType":{"maxLength":32,"type":"string","description":"Bed type. Possible values include King Bed(s), Queen Bed(s), Twin Bed(s), Sofa Bed(s), and OTHER Bed(s)."},"size":{"maxLength":32,"type":"string","description":"Approximate measurement/size of the bed(s) in the room."}},"description":"Configuration of bed(s) in room."}},"components/schemas/DateRange":{"id":"components/schemas/DateRange","kind":"json-schema","title":"DateRange","data":{"required":["end","start"],"properties":{"start":{"type":"string","description":"Specifies the start date for an event, such as a booking or check-in date in YYYY-MM-DD format.","format":"date","example":"2026-03-03"},"end":{"type":"string","description":"Specifies the end date an event, such as a booking or check-out date in YYYY-MM-DD format.","format":"date","example":"2026-03-03"}},"description":"Specifies the begin and end date of an event, such as check-in and check-out dates."}},"components/schemas/PriceBreakdownHospitality":{"id":"components/schemas/PriceBreakdownHospitality","kind":"json-schema","title":"PriceBreakdownHospitality","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information returned may vary by provider and location. May include Amount and Commission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If roomPricingType = Per night, PriceBreakdown may include the NightlyRate, AverageNightlyRate, and AmenitySurcharges objects."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If roomPricingType = Per stay, PriceBreakdown may return the Description object with rate description text containing more information."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"properties":{"roomPricingType":{"$ref":"#/components/schemas/PricingEnum"},"Description":{"maxLength":1024,"type":"string","example":"Advance Purchase-Ro-Free WiFi"},"NightlyRate":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NightlyRate"}},"AverageNightlyRate":{"maxItems":2,"type":"array","description":"The average nightly rate for a given offer.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"AmenitySurcharges":{"$ref":"#/components/schemas/AmenitySurchargesDetail"},"priceChangesDuringStayInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"If true, indicates the price changes at least once during requested dates."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If roomPricingType = Per night, multiple instances of priceChangesDuringStayInd are returned.\""},"children":[]}]}]}]},"shortRateDescription":{"type":"string","description":"A normalized rate description for comparing rates across multiple aggregators.","example":"Flexible Rate"}}}]}},"components/schemas/PricingEnum":{"id":"components/schemas/PricingEnum","kind":"json-schema","title":"PricingEnum","data":{"type":"string","description":"A string provided by the hotel to describe how a service is priced, such as per night or per stay.","enum":["Per stay","Per person","Per night","Per person per night","Per use"]}},"components/schemas/NightlyRate":{"id":"components/schemas/NightlyRate","kind":"json-schema","title":"NightlyRate","data":{"required":["Amount","startDate"],"properties":{"@type":{"type":"string","default":"NightlyRate"},"startDate":{"type":"string","description":"Start date for the nightly rate in YYYY-MM-DD format.","format":"date"},"nights":{"type":"integer","description":"Number of nights the nightly rate is valid.","format":"int32"},"Amount":{"$ref":"#/components/schemas/Amount"}},"description":"A monetary amount, representing Rate per night. Supports up to 4 decimal places; decimal place must be included. If the nightly rate changes during the stay, multiple instances of NightlyRate are returned."}},"components/schemas/AmenitySurchargesDetail":{"id":"components/schemas/AmenitySurchargesDetail","kind":"json-schema","title":"AmenitySurchargesDetail","data":{"description":"Amenity Surcharges information.","allOf":[{"$ref":"#/components/schemas/AmenitySurcharges"},{"description":"A detailed breakdown of the amenity surcharges"},{"required":["Surcharge"],"properties":{"Surcharge":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Surcharge"}}}}]}},"components/schemas/AmenitySurcharges":{"id":"components/schemas/AmenitySurcharges","kind":"json-schema","title":"AmenitySurcharges","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AmenitySurcharges or AmenitySurchargesDetail","example":"AmenitySurchargesDetail"},"TotalSurcharges":{"type":"number","description":"A monetary amount, up to 4 decimal places. Decimal place needs to be included.","format":"float","example":211.11},"approximateInd":{"type":"boolean","description":"if true, the surcharge amounts are approximate","example":false}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Surcharge":{"id":"components/schemas/Surcharge","kind":"json-schema","title":"Surcharge","data":{"properties":{"value":{"type":"number","description":"Surcharge amount","format":"float","example":12},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"ISO 4217 currency code for the surcharge.","example":"USD"},"surchargeCode":{"maxLength":512,"type":"string","description":"Surcharge code","example":"ADDITIONAL COSTS"},"reportingAuthority":{"maxLength":512,"type":"string","description":"Not used. Surcharge reporting authority","example":"Federal register"},"purpose":{"maxLength":512,"type":"string","description":"Surcharge purpose. For Air workflows possible values include Weekend Surcharge, Stopover Charge, Multiple Stopover Charges, Other (default value that covers all other surcharges such as fuel surcharges).","example":"Weekend Surcharge"},"description":{"maxLength":4096,"type":"string","description":"Description of the surcharge.","example":"Rollaway Surcharge"},"surchargeApplication":{"$ref":"#/components/schemas/ApplicationEnum"},"surchargeFrequency":{"$ref":"#/components/schemas/FrequencyEnum"},"codeAuthority":{"maxLength":32,"type":"string","description":"Not used. Currency code authority.","example":"ISO 4217"},"decimalPlace":{"type":"integer","description":"Decimal place for the currency unit.","format":"int32","example":4},"decimalAuthority":{"maxLength":32,"type":"string","description":"Not used. Currency code decimal authority.","example":"ISO 4217"}},"description":"Breakdown of the individual surcharge that make up TotalSurcharges. For Hotels, additional charges are usually related to requested amenities."}},"components/schemas/ApplicationEnum":{"id":"components/schemas/ApplicationEnum","kind":"json-schema","title":"ApplicationEnum","data":{"type":"string","description":"Application values (such as the application of a fee) like per person or per room.","example":"PerPerson","enum":["PerPerson","PerRoom","PerAccommodation","PerHouse","PerApartment","PerAdult","PerChild"]}},"components/schemas/FrequencyEnum":{"id":"components/schemas/FrequencyEnum","kind":"json-schema","title":"FrequencyEnum","data":{"type":"string","description":"The frequency of a fee such as per night or per stay.","example":"PerNight","enum":["PerNight","PerDay","PerStay","PerWeek","RoundTrip","OneWay"]}},"components/schemas/DepositNumberOfNights":{"id":"components/schemas/DepositNumberOfNights","kind":"json-schema","title":"DepositNumberOfNights","data":{"allOf":[{"$ref":"#/components/schemas/Deposit"},{"required":["NumberOfNights"],"properties":{"NumberOfNights":{"type":"integer","description":"The number of nights that must be paid for by deposit","format":"int32"}}}]}},"components/schemas/DepositAmount":{"id":"components/schemas/DepositAmount","kind":"json-schema","title":"DepositAmount","data":{"description":"A flat amount that must be paid as a deposit.","allOf":[{"$ref":"#/components/schemas/Deposit"},{"required":["CurrencyAmount"],"properties":{"CurrencyAmount":{"$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/DepositPercent":{"id":"components/schemas/DepositPercent","kind":"json-schema","title":"DepositPercent","data":{"allOf":[{"$ref":"#/components/schemas/Deposit"},{"properties":{"Percent":{"type":"number","description":"The percentage of the TotalPrice that must be paid for as a deposit.","format":"float","example":20}}}]}},"components/schemas/HotelPenaltyAmount":{"id":"components/schemas/HotelPenaltyAmount","kind":"json-schema","title":"HotelPenaltyAmount","data":{"allOf":[{"$ref":"#/components/schemas/HotelPenalty"},{"required":["Amount"],"properties":{"includesTax":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"Amount":{"maxItems":2,"minItems":1,"type":"array","description":"Exact penalty amount.","items":{"$ref":"#/components/schemas/CurrencyAmount"}}}}]}},"components/schemas/HotelPenaltyNights":{"id":"components/schemas/HotelPenaltyNights","kind":"json-schema","title":"HotelPenaltyNights","data":{"allOf":[{"$ref":"#/components/schemas/HotelPenalty"},{"required":["Nights"],"properties":{"Nights":{"type":"integer","description":"The number of nights that will be charged as a penalty, if the provider charges a cancellation fee.","format":"int32"}}}]}},"components/schemas/HotelPenaltyPercent":{"id":"components/schemas/HotelPenaltyPercent","kind":"json-schema","title":"HotelPenaltyPercent","data":{"allOf":[{"$ref":"#/components/schemas/HotelPenalty"},{"required":["Percent","appliesTo"],"properties":{"appliesTo":{"$ref":"#/components/schemas/PercentAppliesTo"},"Percent":{"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Percentage of total amount to be charged as penalty.","format":"float"},"Nights":{"type":"integer","description":"The number of nights the percentage needs to be applied to determine cancel penalty amount","format":"int32"},"Amount":{"maxItems":2,"type":"array","items":{"$ref":"#/components/schemas/CurrencyAmount"}}}}]}},"components/schemas/PercentAppliesTo":{"id":"components/schemas/PercentAppliesTo","kind":"json-schema","title":"PercentAppliesTo","data":{"type":"string","description":"The increment the percent applies to. Default value is Amount","example":"Amount","enum":["Nights","Stay","Amount"]}},"components/schemas/AgeQualifying":{"id":"components/schemas/AgeQualifying","kind":"json-schema","title":"AgeQualifying","data":{"properties":{"@type":{"type":"string","example":"AgeQualifying"},"minAge":{"type":"integer","description":"MinAge: The minimum age to qualify for AgeQualifyingCode.","format":"int32"},"maxAge":{"type":"integer","description":"Max Age: The maximum age to qualify for AgeQualifyingCode.","format":"int32"},"ageBucket":{"maxLength":32,"type":"string","description":"The age bucket"},"count":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The number of age qualifying","format":"int32"},"ageQualifyingCode":{"maxLength":32,"type":"string","description":"Enter 10 for an adult or 08 for a child","example":"10"}},"description":"Base age group of occupants for which this rate is valid."}},"components/schemas/RoomTypeDetail":{"id":"components/schemas/RoomTypeDetail","kind":"json-schema","title":"RoomTypeDetail","data":{"allOf":[{"$ref":"#/components/schemas/RoomType"},{"properties":{"numberOfUnits":{"type":"integer","description":"The number of rooms that have been combined to create this room type.","format":"int32"},"reqdGuaranteeType":{"type":"string","description":"TODO-(Should this be Guarantee?)Denotes the form of guarantee for this room."},"AdditionalDetails":{"$ref":"#/components/schemas/AdditionalDetails"},"RoomOccupancy":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/RoomOccupancy"}},"roomInd":{"type":"boolean","description":"Indicates the room is a sleeping room when true."},"convertedInd":{"type":"boolean","description":"Indicates the room is converted when true."},"alternateInd":{"type":"boolean","description":"Indicates the room is an alternate room type to the requested room type when true."}}}]}},"components/schemas/AdditionalDetails":{"id":"components/schemas/AdditionalDetails","kind":"json-schema","title":"AdditionalDetails","data":{"required":["AdditionalDetail"],"properties":{"@type":{"type":"string","example":"AdditionalDetails"},"AdditionalDetail":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/AdditionalDetail"}}},"description":"A collection of AdditionalDetail."}},"components/schemas/AdditionalDetail":{"id":"components/schemas/AdditionalDetail","kind":"json-schema","title":"AdditionalDetail","data":{"properties":{"@type":{"type":"string","example":"AdditionalDetail"},"detailType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA Code"},"code":{"maxLength":32,"type":"string","description":"Partner code"},"Amount":{"$ref":"#/components/schemas/CurrencyAmount"},"Description":{"$ref":"#/components/schemas/TextTitleAndDescription"}},"description":"Used to send additional information."}},"components/schemas/RoomOccupancy":{"id":"components/schemas/RoomOccupancy","kind":"json-schema","title":"RoomOccupancy","data":{"properties":{"@type":{"type":"string","default":"RoomOccupancy"},"minOccupancy":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The minimum occupancy","format":"int32"},"maxOccupancy":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The maximum number of room occupants.","format":"int32"},"AgeQualifying":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/AgeQualifying"}}},"description":"Room occupancy value."}},"components/schemas/RateCandidateDetail":{"id":"components/schemas/RateCandidateDetail","kind":"json-schema","title":"RateCandidateDetail","data":{"allOf":[{"$ref":"#/components/schemas/RateCandidate"},{"properties":{"rateID":{"maxLength":32,"type":"string","description":"'ID of the rate plan associated with the negotiated rate. \nFor Hotel Availability,Optional; will be added automatically if missing.\nFor Hotel Rules, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateID.'","example":"HL123"},"CustomerLoyalty":{"$ref":"#/components/schemas/CustomerLoyalty"}}}]}},"components/schemas/RateCandidatesDetail":{"id":"components/schemas/RateCandidatesDetail","kind":"json-schema","title":"RateCandidatesDetail","data":{"allOf":[{"$ref":"#/components/schemas/RateCandidates"},{"properties":{"numberOfRatePlans":{"type":"integer","description":"Minimum number rate plans requested in response","format":"int32"}}}]}},"components/schemas/PropertyAddress":{"id":"components/schemas/PropertyAddress","kind":"json-schema","title":"PropertyAddress","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Address"}]}},"components/schemas/ProductHospitalityOffer":{"id":"components/schemas/ProductHospitalityOffer","kind":"json-schema","title":"ProductHospitalityOffer","data":{"allOf":[{"$ref":"#/components/schemas/Product"},{"properties":{"propertyDatesRef":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refers to PropertyDates object in the ReferenceList_PropertyDates"},"children":[]}]}]}]},"bookingCode":{"maxLength":32,"type":"string","description":"Booking code retrieved from the Availability response."},"RoomType":{"$ref":"#/components/schemas/RoomType"}}}]}},"components/schemas/TermsAndConditionsHospitality":{"id":"components/schemas/TermsAndConditionsHospitality","kind":"json-schema","title":"TermsAndConditionsHospitality","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditions"},{"properties":{"Guarantee":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Guarantee"}},"CancelPenalty":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/CancelPenalty"}},"AcceptedCreditCard":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/AcceptedCreditCard"}},"Description":{"maxItems":10,"type":"array","description":"Free-form text for a room and rate description. This duplicates the room description in RoomType","example":"\"Prepay Non-Refundable, Prepay In Full, No Changes, Traditional, Guest Room, 2 Queen\"","items":{"type":"string"}},"MealsIncluded":{"$ref":"#/components/schemas/MealsIncluded"},"ProductRateCodeInfo":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ProductRateCodeInfo"}},"CheckInOutPolicy":{"$ref":"#/components/schemas/CheckInOutPolicy"},"DepositPolicy":{"$ref":"#/components/schemas/DepositPolicy"},"RatePaymentInfo":{"$ref":"#/components/schemas/RatePaymentEnum"},"CustomerLoyaltyIDRequiredAtReservation":{"type":"boolean","description":"If true, the rate returned is contingent on a membership number to be included within the sell request, typically a frequent guest or frequent flyer loyalty number."},"RateQualificationIDRequiredAtCheckIn":{"type":"boolean","description":"If true, indicates the rate returned is contingent on qualification to be presented at check-in at the property; guest must show proof of qualifying, typically an ID for government, military, workplace, association, or membership."}}}]}},"components/schemas/ReferenceListPropertyDates":{"id":"components/schemas/ReferenceListPropertyDates","kind":"json-schema","title":"ReferenceListPropertyDates","data":{"description":"Returned by default to consolidate common property details. Not returned if verboseResponseInd was set to true in the request.","allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"required":["PropertyDates"],"properties":{"PropertyDates":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PropertyDates"}}}}]}},"components/schemas/PropertyDates":{"id":"components/schemas/PropertyDates","kind":"json-schema","title":"PropertyDates","data":{"required":["DateRange","PropertyKey","id"],"properties":{"@type":{"type":"string","default":"PropertyDates"},"availability":{"$ref":"#/components/schemas/AvailabilityStatusEnum"},"adaCompliant":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"id":{"type":"string","description":"Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product."},"moreRatesToken":{"maxLength":512,"type":"string","description":"More rates token"},"propertyName":{"maxLength":128,"type":"string","description":"Name of property offering these products."},"PropertyAddress":{"$ref":"#/components/schemas/Address"},"PropertyKey":{"$ref":"#/components/schemas/PropertyKey"},"DateRange":{"$ref":"#/components/schemas/DateRange"},"GeoLocation":{"$ref":"#/components/schemas/GeoLocation"},"Telephone":{"$ref":"#/components/schemas/Telephone"},"Email":{"$ref":"#/components/schemas/Email"}}}},"components/schemas/CatalogOfferingHospitality":{"id":"components/schemas/CatalogOfferingHospitality","kind":"json-schema","title":"CatalogOfferingHospitality","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOffering"},{"properties":{"Sequence":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"Sequence determines the order in which the offer shall be displayed to the customer","format":"int32"},"NextSteps":{"$ref":"#/components/schemas/NextSteps"},"limitedAvailabilityInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true the offering/Offer has limited availability"},"children":[]}]}]}]}}}]}},"components/schemas/SearchByAddress":{"id":"components/schemas/SearchByAddress","kind":"json-schema","title":"SearchByAddress","data":{"description":"Search by city name, state/province, and country.","allOf":[{"$ref":"#/components/schemas/SearchBy"},{"required":["SearchAddress"],"properties":{"SearchAddress":{"$ref":"#/components/schemas/SearchAddress"}}}]}},"components/schemas/SearchAddress":{"id":"components/schemas/SearchAddress","kind":"json-schema","title":"SearchAddress","data":{"properties":{"City":{"maxLength":128,"type":"string","description":"Full name of a city, town, or postal station (i.e., a postal service territory, often used in a military address).","example":"Denver"},"StateProv":{"$ref":"#/components/schemas/StateProv"},"Country":{"maxLength":128,"type":"string","description":"Country Code (typically 2 characters)."}}}},"components/schemas/SearchByAirport":{"id":"components/schemas/SearchByAirport","kind":"json-schema","title":"SearchByAirport","data":{"description":"Search by airport code.","allOf":[{"$ref":"#/components/schemas/SearchBy"},{"required":["SearchAirport"],"properties":{"SearchAirport":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"An airport IATA code. Must be three alpha characters."}}}]}},"components/schemas/SearchByCity":{"id":"components/schemas/SearchByCity","kind":"json-schema","title":"SearchByCity","data":{"description":"Search by city code.","allOf":[{"$ref":"#/components/schemas/SearchBy"},{"required":["SearchCity"],"properties":{"SearchCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"A city IATA code. Must be three alpha characters. If no matching city code is found, airport search is automatically invoked."}}}]}},"components/schemas/SearchByGeoLocation":{"id":"components/schemas/SearchByGeoLocation","kind":"json-schema","title":"SearchByGeoLocation","data":{"description":"Search by latitude and longitude.","allOf":[{"$ref":"#/components/schemas/SearchBy"},{"required":["Latitude","Longitude"],"properties":{"Latitude":{"type":"number","description":"Numeric value representing latitude of search center point in degrees and decimal minutes.","format":"double","example":39.7392},"Longitude":{"type":"number","description":"Numeric value representing longitude of search center point in degrees and decimal minutes.","format":"double","example":-104.9903}}}]}},"components/schemas/FeesDetail":{"id":"components/schemas/FeesDetail","kind":"json-schema","title":"FeesDetail","data":{"description":"Extended Fees object provides breakdown of individual Fees.","allOf":[{"$ref":"#/components/schemas/Fees"},{"properties":{"Fee":{"maxItems":100,"type":"array","description":"Array of individual fees.","items":{"$ref":"#/components/schemas/Fee"}}}}]}},"components/schemas/Fee":{"id":"components/schemas/Fee","kind":"json-schema","title":"Fee","data":{"required":["FeeAmountOrPercent"],"properties":{"@type":{"type":"string","default":"Fee"},"feeCode":{"maxLength":32,"type":"string","description":"For Hotel, the Hotel provider's explanation of the fee; can be returned either as a code or as text.  \nFor Air, the code for the fee, such as 'OB' for OB fees.","example":"1011"},"reportingAuthority":{"maxLength":32,"type":"string","description":"Not used. Identifies the reporting authority.","example":"OPRA"},"purpose":{"maxLength":32,"type":"string","description":"Not used. Fee purpose","example":"Service charge"},"description":{"maxLength":512,"type":"string","description":"Any description or text explanation of the charge.","example":"Resort Fee"},"feeApplication":{"$ref":"#/components/schemas/ApplicationEnum"},"feeFrequency":{"$ref":"#/components/schemas/FrequencyEnum"},"FeeAmountOrPercent":{"$ref":"#/components/schemas/FeeAmountOrPercent"},"Tax":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"includedinBaseInd":{"type":"boolean","description":"If true, indicates the fee is included in Base Price."},"includedInTotalPriceInd":{"type":"boolean","description":"If true, indicates the fee is included in Total Price. Default behavior is for fees not to be included in TotalPrice."},"collectionMethod":{"$ref":"#/components/schemas/ChangeFeeMethodEnum"}},"description":"Individual Fee object provides detailed information on the fee.  \nIn Air workflow, if OB-T fees are part of the price, those are detailed here. OB-T fees are ticketing fees independent of the form of payment. They are defined by the carrier and can be based on multiple criteria."}},"components/schemas/FeeAmountOrPercent":{"id":"components/schemas/FeeAmountOrPercent","kind":"json-schema","title":"FeeAmountOrPercent","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes FeeAmountOrPercentAmount or FeeAmountOrPercentPercent"},"application":{"$ref":"#/components/schemas/CommissionEnum"}},"description":"Defines whether the fee is charged as an amount or percentage.","discriminator":{"propertyName":"@type"}}},"components/schemas/TaxesDetail":{"id":"components/schemas/TaxesDetail","kind":"json-schema","title":"TaxesDetail","data":{"description":"Taxes Detail contains the breakdown of individual Taxes that make up the summary total","allOf":[{"$ref":"#/components/schemas/Taxes"},{"properties":{"Tax":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"TaxPercent":{"$ref":"#/components/schemas/TaxPercent"}}}]}},"components/schemas/TaxPercent":{"id":"components/schemas/TaxPercent","kind":"json-schema","title":"TaxPercent","data":{"properties":{"value":{"type":"number","description":"The tax percentage amount.","format":"float","example":5.5},"taxCode":{"maxLength":512,"type":"string","description":"Any code for the tax.","example":"971 - IRS Notice"},"reportingAuthority":{"maxLength":512,"type":"string","description":"Tax reporting authority","example":"Georgia Department of Revenue"},"purpose":{"maxLength":512,"type":"string","description":"Purpose of tax","example":"statutory tax"},"description":{"maxLength":4096,"type":"string","description":"Description","example":"1.5% of SGST"},"includedInBase":{"$ref":"#/components/schemas/YesNoUnknownEnum"}},"description":"Returned when the tax is expressed as a percentage of the amount."}},"components/schemas/SurchargesDetail":{"id":"components/schemas/SurchargesDetail","kind":"json-schema","title":"SurchargesDetail","data":{"description":"Extended class of Surcharges","allOf":[{"$ref":"#/components/schemas/Surcharges"},{"description":"A detailed breakdown of the summary surcharges"},{"required":["Surcharge"],"properties":{"Surcharge":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Surcharge"}}}}]}},"components/schemas/Surcharges":{"id":"components/schemas/Surcharges","kind":"json-schema","title":"Surcharges","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class is SurchargesDetail","example":"SurchargesDetail"},"TotalSurcharges":{"type":"number","description":"A monetary amount, up to 4 decimal places.","format":"float","example":211.11},"approximateInd":{"type":"boolean","description":"If true, the surcharge amounts are approximate.","example":false}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In AirSearch workflow this applies to GDS only. Not supported for NDC, which does not return surcharges."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned if surcharges apply to this offer."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a multi-city offer with stopovers (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/flights-search-guide#multi-city-offers-with-stopovers-price-details-in-bestcombinableprice-only"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-city Offers with Stopovers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details), surcharges and commission amounts are for the entire journey. A multi-city offer can be identified by the jc in its CombinabilityCode: jc1, jc2."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For all other offers, the surcharges and commission amounts are for each leg (origin and destination pair)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharges can be omitted from the Search response with excludeSurchargesInd."},"children":[]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/ErrorWarningDetail":{"id":"components/schemas/ErrorWarningDetail","kind":"json-schema","title":"ErrorWarningDetail","data":{"description":"Detailed child class of ErrorWarning","allOf":[{"$ref":"#/components/schemas/ErrorWarning"},{"required":["SourceID"],"properties":{"category":{"maxLength":128,"type":"string","description":"A category to assist in identifying the error","example":"VALIDATION"},"SourceID":{"maxLength":128,"type":"string","description":"The identifier of the source system sending the error or warning"},"SourceCode":{"maxLength":32,"type":"string","description":"The error or warning code returned by the source airline or host system"},"SourceDescription":{"maxLength":4096,"type":"string","description":"The error or warning message as it is returned by the source airline or host system"}}}]}},"components/schemas/ErrorWarning":{"id":"components/schemas/ErrorWarning","kind":"json-schema","title":"ErrorWarning","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ErrorWarning or ErrorWarningDetail","example":"ErrorWarning"},"StatusCode":{"type":"integer","description":"Http standard response code","format":"int32","deprecated":true},"Message":{"maxLength":4096,"type":"string","description":"The Travelport standardized error or warning message"},"NameValuePair":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ErrorDetail":{"id":"components/schemas/ErrorDetail","kind":"json-schema","title":"ErrorDetail","data":{"description":"Detailed child class of Error","allOf":[{"$ref":"#/components/schemas/Error"},{"properties":{"category":{"maxLength":128,"type":"string","description":"A category to assist in identifying the error","example":"VALIDATION"},"SourceID":{"maxLength":128,"type":"string","description":"The identifier of the source system sending the error or warning","example":"1G"},"SourceCode":{"maxLength":32,"type":"string","description":"The error or warning code returned by the source airline or host system","example":"1234"},"SourceDescription":{"maxLength":4096,"type":"string","description":"The error or warning message as it is returned by the source airline or host system"}}}]}},"components/schemas/WarningDetail":{"id":"components/schemas/WarningDetail","kind":"json-schema","title":"WarningDetail","data":{"description":"Detailed child class of Warning","allOf":[{"$ref":"#/components/schemas/Warning"},{"properties":{"category":{"maxLength":128,"type":"string","description":"A category to assist in identifying the error","example":"INFORMATION"},"SourceID":{"maxLength":128,"type":"string","description":"The identifier of the source system sending the error or warning","example":"1G"},"SourceCode":{"maxLength":32,"type":"string","description":"The error or warning code returned by the source airline or host system","example":"1234"},"SourceDescription":{"maxLength":4096,"type":"string","description":"The error or warning message as it is returned by the source airline or host system"}}}]}},"components/schemas/TravelAgencyDetail":{"id":"components/schemas/TravelAgencyDetail","kind":"json-schema","title":"TravelAgencyDetail","data":{"description":"The extended class of Travel Agency.","allOf":[{"$ref":"#/components/schemas/TravelAgency"},{"properties":{"Telephone":{"maxItems":50,"type":"array","description":"Defines agency telephone information.","items":{"$ref":"#/components/schemas/Telephone"}},"Address":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Email":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/Email"}}}}]}},"components/schemas/AmountPercentAmount":{"id":"components/schemas/AmountPercentAmount","kind":"json-schema","title":"AmountPercentAmount","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This charge is applied as a fixed amount."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using for a ManualFareAdjustment: send amount value to either increase or decrease the base fare, up to two decimal places. For example, the value 14.75 for a base fare in the currency USD would increase the base fare by $14.75 when sent in @type ManualFareAdjustmentIncrease, or decrease the base fare by $14.75 when sent in @type ManualFareAdjustmentDiscount."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AmountPercent"},{"properties":{"Amount":{"$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/AmountPercent":{"id":"components/schemas/AmountPercent","kind":"json-schema","title":"AmountPercent","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AmountPercentAmount or AmountPercentPercent","example":"AmountPercentAmount"},"application":{"$ref":"#/components/schemas/CommissionEnum"}},"description":"Parent object when amount is applied as an Amount or a Percent.","discriminator":{"propertyName":"@type"}}},"components/schemas/AmountPercentPercent":{"id":"components/schemas/AmountPercentPercent","kind":"json-schema","title":"AmountPercentPercent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This charge is applied as a percentage."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When using for a ManualFareAdjustment: send percentage of the base fare to be decreased or increased, up to two decimal places. For example, the value 20.5 would increase the base fare by 20.5% when sent in @type ManualFareAdjustmentIncrease, or decrease the base fare by 20.5% when sent in @type ManualFareAdjustmentDiscount."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AmountPercent"},{"properties":{"Percent":{"type":"number","description":"Percent amount of commission","format":"float","example":20}}}]}},"components/schemas/PenaltyAmount":{"id":"components/schemas/PenaltyAmount","kind":"json-schema","title":"PenaltyAmount","data":{"description":"Amount of penalty fee.  \nSome NDC carriers may not return PenaltyAmount when a change is permitted, which means there is no charge for the change.","allOf":[{"$ref":"#/components/schemas/Penalty"},{"properties":{"Amount":{"$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/Penalty":{"id":"components/schemas/Penalty","kind":"json-schema","title":"Penalty","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes PenaltyAmount or PenaltyPercent","example":"PenaltyAmount"},"application":{"$ref":"#/components/schemas/CommissionEnum"}},"description":"Returned in Change and Cancel objects to specify either a percentage or amount for a change or cancel penalty.","discriminator":{"propertyName":"@type"}}},"components/schemas/PenaltyPercent":{"id":"components/schemas/PenaltyPercent","kind":"json-schema","title":"PenaltyPercent","data":{"description":"Percent of fare charged for the penalty.","allOf":[{"$ref":"#/components/schemas/Penalty"},{"properties":{"Percent":{"type":"number","description":"Percent of the fare charges for the penalty","format":"float","example":20}}}]}},"components/schemas/PersonNameDetail":{"id":"components/schemas/PersonNameDetail","kind":"json-schema","title":"PersonNameDetail","data":{"description":"The extended class of Person Name.","allOf":[{"$ref":"#/components/schemas/PersonName"},{"properties":{"personNameType":{"$ref":"#/components/schemas/NameTypeEnum"},"language":{"type":"string","description":"'ISO639 code of the language the name is represented ","example":"EN"},"SurnamePrefix":{"maxLength":32,"type":"string","description":"The surname prefix","example":"Von"},"Suffix":{"maxLength":10,"type":"string","description":"Traveler name suffix such as Jr. or Sr.","example":"Jr."},"Title":{"maxLength":32,"type":"string","description":"Degree or honors","example":"DR"},"Privacy":{"$ref":"#/components/schemas/Privacy"},"defaultInd":{"type":"boolean","description":"If true, this is the default or primary name within a collection of names.","example":true}}}]}},"components/schemas/NameTypeEnum":{"id":"components/schemas/NameTypeEnum","kind":"json-schema","title":"NameTypeEnum","data":{"type":"string","description":"OTA Code","enum":["Former","Nickname","Alternate","Maiden"]}},"components/schemas/Privacy":{"id":"components/schemas/Privacy","kind":"json-schema","title":"Privacy","data":{"properties":{"id":{"type":"string","description":"Optional internally referenced id","example":"2"},"shareMarketing":{"$ref":"#/components/schemas/YesNoInheritEnum"},"shareSync":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optOutInd":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optInStatus":{"$ref":"#/components/schemas/OptInStatusEnum"},"optInDate":{"type":"string","description":"The datetime of receiving the opt in notice","format":"date-time","example":"2026-08-07T12:12:00Z"},"optOutDate":{"type":"string","description":"The datetime the opt out notice was received","format":"date-time","example":"2026-08-07T12:12:00Z"}},"description":"Confidential details for marketing purpose"}},"components/schemas/TelephoneDetail":{"id":"components/schemas/TelephoneDetail","kind":"json-schema","title":"TelephoneDetail","data":{"description":"Extended class of Telephone","allOf":[{"$ref":"#/components/schemas/Telephone"},{"properties":{"phoneLocationType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Location of the phone","example":"Agency"},"phoneTechType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Indicates the type of technology associated with the telephone number","example":"Voice"},"phoneUseType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).","example":"Home"},"pin":{"maxLength":32,"type":"string","description":"Additional codes used for telephone","example":"3456"},"priority":{"type":"integer","description":"Priority","format":"int32","example":1},"Privacy":{"$ref":"#/components/schemas/Privacy"},"Enum_TelephoneRole":{"$ref":"#/components/schemas/Enum_TelephoneRole"},"Comment":{"$ref":"#/components/schemas/Comment"},"defaultInd":{"type":"boolean","description":"When true, indicates a default value should be used.","example":true},"provisionedInd":{"type":"boolean","description":"true indicates this phone number was created through provisioned","example":false}}}]}},"components/schemas/AddressDetail":{"id":"components/schemas/AddressDetail","kind":"json-schema","title":"AddressDetail","data":{"description":"The extended class of Address.","allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"addressType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for address type","example":"CLT"},"use":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for address use","example":"AUT"},"Comment":{"$ref":"#/components/schemas/Comment"},"Privacy":{"$ref":"#/components/schemas/Privacy"},"Priority":{"type":"integer","description":"The priority ranking within the group","format":"int32","example":1},"validInd":{"type":"boolean","description":"If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.","example":false},"provisionedInd":{"type":"boolean","description":"If true, this address came into the system through provisioning","example":false}}}]}},"components/schemas/DepartureDetail":{"id":"components/schemas/DepartureDetail","kind":"json-schema","title":"DepartureDetail","data":{"description":"Extended class of Departure","allOf":[{"$ref":"#/components/schemas/Departure"},{"properties":{"terminal":{"maxLength":4096,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"Departure terminal, returned when available.","example":"Terminal 1"},"country":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Country of to departure or arrival","example":"US"}}}]}},"components/schemas/Departure":{"id":"components/schemas/Departure","kind":"json-schema","title":"Departure","data":{"required":["@type","date","location","time"],"properties":{"@type":{"type":"string","description":"Discriminator classes Departure or DepartureDetail","example":"DepartureDetail"},"location":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"IATA code for departure airport or city for this leg of the itinerary.","example":"AMS"},"date":{"type":"string","description":"Departure date in YYYY-MM-DD format.","format":"date","example":"0011-10-17"},"time":{"type":"string","description":"Departure date in HH:mm:ss (24-hour format).","example":"04:45:00"}},"description":"Departure details for a given leg.","discriminator":{"propertyName":"@type"}}},"components/schemas/ArrivalDetail":{"id":"components/schemas/ArrivalDetail","kind":"json-schema","title":"ArrivalDetail","data":{"description":"Extended class of Arrival.","allOf":[{"$ref":"#/components/schemas/Arrival"},{"properties":{"terminal":{"maxLength":4096,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"Arrival terminal, returned when available.","example":"Terminal 1"},"country":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Country of to departure or arrival","example":"US"}}}]}},"components/schemas/Arrival":{"id":"components/schemas/Arrival","kind":"json-schema","title":"Arrival","data":{"required":["@type","date","location"],"properties":{"@type":{"type":"string","description":"Discriminator classes Arrival or ArrivalDetail","example":"ArrivalDetail"},"location":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"IATA code for arrival airport or city for this leg of the itinerary.","example":"MAD"},"date":{"type":"string","description":"Arrival date in YYYY-MM-DD format.","format":"date","example":"0011-10-17"},"time":{"type":"string","description":"Arrival date in HH:mm:ss (24-hour format).","example":"04:45:00"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/FeeAmountOrPercentAmount":{"id":"components/schemas/FeeAmountOrPercentAmount","kind":"json-schema","title":"FeeAmountOrPercentAmount","data":{"description":"Indicates that this fee is applied as a fixed amount. In this case, the response will return the Amount object.","allOf":[{"$ref":"#/components/schemas/FeeAmountOrPercent"},{"properties":{"Amount":{"$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/FeeAmountOrPercentPercent":{"id":"components/schemas/FeeAmountOrPercentPercent","kind":"json-schema","title":"FeeAmountOrPercentPercent","data":{"description":"Indicates that this fee is applied as a percentage of the base amount. In this case, the response will return the Percent object.","allOf":[{"$ref":"#/components/schemas/FeeAmountOrPercent"},{"properties":{"Percent":{"type":"number","description":"The percentage of a base amount being charged for the fee.","format":"float","example":20}}}]}},"components/schemas/CommissionAmount":{"id":"components/schemas/CommissionAmount","kind":"json-schema","title":"CommissionAmount","data":{"description":"Indicates that this commission is applied as a fixed amount. In this case, the response will return the Amount object.","allOf":[{"$ref":"#/components/schemas/Commission"},{"properties":{"Amount":{"$ref":"#/components/schemas/CurrencyAmount"}}}]}},"components/schemas/CommissionPercent":{"id":"components/schemas/CommissionPercent","kind":"json-schema","title":"CommissionPercent","data":{"description":"Indicates that this fee is applied as a percentage. In this case, the response will return the Percent object.","allOf":[{"$ref":"#/components/schemas/Commission"},{"properties":{"Percent":{"type":"number","description":"Percent amount of commission","format":"float","example":20}}}]}},"components/schemas/ConfirmationHold":{"id":"components/schemas/ConfirmationHold","kind":"json-schema","title":"ConfirmationHold","data":{"allOf":[{"$ref":"#/components/schemas/Confirmation"},{"properties":{"Locator":{"$ref":"#/components/schemas/Locator"},"OfferStatus":{"$ref":"#/components/schemas/OfferStatus"},"UnpricedSegmentsStatus":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/UnpricedSegmentsStatus"}},"ShoppingCartProductStatus":{"$ref":"#/components/schemas/ShoppingCartProductStatusAir"},"OfferDocumentStatus":{"type":"array","items":{"$ref":"#/components/schemas/OfferDocumentStatus"}}}}]}},"components/schemas/Locator":{"id":"components/schemas/Locator","kind":"json-schema","title":"Locator","data":{"properties":{"value":{"maxLength":16,"pattern":"([A-Z0-9]+)?","type":"string","description":"Reference number for locatorType.  \nBooking.com returns a PIN number along with the confirmation number for each sold hotel segment. If the agent/traveler needs to reconcile the booking with Booking.com, Booking.com requires both the PIN number and confirmation number to locate the segment in their system.","example":"ZXG25P"},"locatorType":{"maxLength":32,"type":"string","description":"Specifies the type of reservation ID\nTravelport - Confirmation number; PNR locator Agency - IATA Number Booking.com - Confirmation number; PIN number\nIn Document History, may return the content source (e.g. GDS or NDC)","example":"Confirmation Number"},"source":{"maxLength":128,"type":"string","description":"Content source. Typically a two-character Supplier code that indicates the source system which generated the resid.  \nFor Hotels, if source matches chain code, the offer is directly with the supplier. If source is 'BO', the offer is with Booking.com.","example":"1G"},"sourceContext":{"maxLength":128,"type":"string","description":"Specifies the context of the source. Either Travelport, Agency, or Supplier.","example":"Travelport"},"otaType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Used for codes","example":"14.UIT"},"creationDate":{"type":"string","description":"Date created in Travelport or supplier system in YYYY-MM-DD format.","format":"date","example":"2026-03-01"},"lastUpdated":{"type":"string","description":"The date and time stamp the Reservation was last updated.","format":"date-time","example":"2026-08-07T12:12:00Z"}},"description":"Locator information for the reservation. Contains the locator (PNR or external locator) or cancellation number for the reservation, order, or offer."}},"components/schemas/OfferStatus":{"id":"components/schemas/OfferStatus","kind":"json-schema","title":"OfferStatus","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes OfferStatus, OfferStatusAir, OfferStatusAncillary, OfferStatusHospitality, OfferStatusVehicle","example":"OfferStatus"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/UnpricedSegmentsStatus":{"id":"components/schemas/UnpricedSegmentsStatus","kind":"json-schema","title":"UnpricedSegmentsStatus","data":{"required":["@type","StatusAir"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"UnpricedSegmentsStatus"},"StatusAir":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/StatusAir"}}},"description":"Status of the unpriced flight segment"}},"components/schemas/StatusAir":{"id":"components/schemas/StatusAir","kind":"json-schema","title":"StatusAir","data":{"properties":{"value":{"$ref":"#/components/schemas/OfferStatusEnum"},"flightRefs":{"type":"array","description":"The flightRefs the status is applicable to within the Offer","items":{"type":"string"}},"code":{"maxLength":32,"type":"string","description":"Status code"},"pastDateInd":{"type":"boolean","description":"If true, the flight is considered to be past date","example":true}}}},"components/schemas/OfferStatusEnum":{"id":"components/schemas/OfferStatusEnum","kind":"json-schema","title":"OfferStatusEnum","data":{"type":"string","description":"Status of an offer.","example":"Confirmed","enum":["Confirmed","Cancelled","Pending","Modifed","Rejected","Waitlisted"]}},"components/schemas/ShoppingCartProductStatusAir":{"id":"components/schemas/ShoppingCartProductStatusAir","kind":"json-schema","title":"ShoppingCartProductStatusAir","data":{"allOf":[{"$ref":"#/components/schemas/ShoppingCartProductStatus"},{"properties":{"StatusAir":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/StatusAir"}}}}]}},"components/schemas/ShoppingCartProductStatus":{"id":"components/schemas/ShoppingCartProductStatus","kind":"json-schema","title":"ShoppingCartProductStatus","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ShoppingCartProductStatus or ShoppingCartProductStatusAir","example":"ShoppingCartProductStatusAir"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/OfferDocumentStatus":{"id":"components/schemas/OfferDocumentStatus","kind":"json-schema","title":"OfferDocumentStatus","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Status of Offer completion.","example":"OfferDocumentStatus"},"Status":{"$ref":"#/components/schemas/ReservationOfferStatusEnum"},"TravelerDocumentStatus":{"maxItems":20,"type":"array","description":"Status of Offer completion by Traveler.","items":{"$ref":"#/components/schemas/TravelerDocumentStatus"}}}}},"components/schemas/TravelerDocumentStatus":{"id":"components/schemas/TravelerDocumentStatus","kind":"json-schema","title":"TravelerDocumentStatus","data":{"properties":{"value":{"$ref":"#/components/schemas/ReservationOfferStatusEnum"},"travelerRefs":{"type":"array","description":"The traveler associated to the document status.","example":"traveler_001","items":{"type":"string","example":"traveler_001"}}},"description":"Status of Offer completion by Traveler."}},"components/schemas/ReceiptPayment":{"id":"components/schemas/ReceiptPayment","kind":"json-schema","title":"ReceiptPayment","data":{"allOf":[{"$ref":"#/components/schemas/Receipt"},{"properties":{"PaymentIdentifier":{"$ref":"#/components/schemas/PaymentIdentifier"},"SecondPaymentIdentifier":{"$ref":"#/components/schemas/IdentifierRef"},"ThirdPaymentIdentifier":{"$ref":"#/components/schemas/IdentifierRef"},"Document":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Document"}},"depositInd":{"type":"boolean","description":"if true, the receipt is for a deposit or prepayment"},"guaranteeInd":{"type":"boolean","description":"if true, the receipt is for a guarantee only. Guarantee rules are in accordance with the Offer TermsAndConditions."}}}]}},"components/schemas/PaymentIdentifier":{"id":"components/schemas/PaymentIdentifier","kind":"json-schema","title":"PaymentIdentifier","data":{"properties":{"@type":{"type":"string","example":"Payment"},"id":{"type":"string"},"PaymentRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Payment Identifier object."}},"components/schemas/Document":{"id":"components/schemas/Document","kind":"json-schema","title":"Document","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes DocumentTicket, DocumentTicketExchange, DocumentTicketRefund, DocumentTicketRetained, DocumentTicketVoid, DocumentEMD, DocumentEMDExchange, DocumentEMDRefund, DocumentEMDVoid, DocumentMCO, DocumentMCOExchange, DocumentMCORefund, DocumentMCOVoid, DocumentForfeit, DocumentAgencyServiceFee, DocumentAgencyServiceFeeVoid","example":"DocumentTicket"},"nonTravelportInd":{"type":"boolean","description":"If true, this document was issued outside of Travelport systems."},"Number":{"maxLength":32,"type":"string","description":"The identifying number of the document","example":"1259900123457"},"TravelerIdentifierRef":{"$ref":"#/components/schemas/TravelerIdentifierRef"},"Amount":{"$ref":"#/components/schemas/Amount"},"WaiverCode":{"$ref":"#/components/schemas/WaiverCode"},"Commission":{"$ref":"#/components/schemas/Commission"},"CumulativeValue":{"$ref":"#/components/schemas/CumulativeValue"},"IssuingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"Document issuing pcc","example":"India RPO"},"IssuingIATA":{"pattern":"([0-9]{8})","type":"string","description":"Document issuing IATA","example":"12387498"},"IssuingCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Document issuing city","example":"NYK"},"FiledAmount":{"$ref":"#/components/schemas/FiledAmount"},"contentSource":{"$ref":"#/components/schemas/ContentSourceEnum"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/WaiverCode":{"id":"components/schemas/WaiverCode","kind":"json-schema","title":"WaiverCode","data":{"properties":{"value":{"maxLength":128,"type":"string"},"reasonCode":{"type":"integer","description":"A code assigned to identify the reason for disruption","format":"int32","example":2},"waiverType":{"$ref":"#/components/schemas/WaiverTypeEnum"}},"description":"A code assigned by an airline to support waiver of fees or ticket value as a result of disruption to the passenger. Waiver code can be passed during the refund by document process (BuildFromOfferList). Select the type of fee that is to be waivered in the waiver type field. Also passed as a FormOfPayment."}},"components/schemas/WaiverTypeEnum":{"id":"components/schemas/WaiverTypeEnum","kind":"json-schema","title":"WaiverTypeEnum","data":{"type":"string","description":"List of waiver types.","example":"ChangePenalty","enum":["ChangePenalty","PriceDifference","ChangePenaltyAndPriceDifference","RefundPenalty","NameChangePenalty"]}},"components/schemas/CumulativeValue":{"id":"components/schemas/CumulativeValue","kind":"json-schema","title":"CumulativeValue","data":{"properties":{"@type":{"type":"string","example":"CumulativeValue"},"currencySource":{"$ref":"#/components/schemas/CurrencySourceEnum"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"The price prior to all applicable taxes of a product such as the rate for a room or fare for a flight.","format":"float","example":120.2},"Taxes":{"$ref":"#/components/schemas/Taxes"},"Fees":{"$ref":"#/components/schemas/Fees"},"Total":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the total price including base + taxes + fees"},"children":[]}]}]}],"format":"float","example":30.13},"approximateInd":{"type":"boolean","description":"True if this amount has been converted from the original amount","example":true}},"description":"Used to show the cumulative value of a document when it has been exchanged multiple times"}},"components/schemas/ReceiptCancellation":{"id":"components/schemas/ReceiptCancellation","kind":"json-schema","title":"ReceiptCancellation","data":{"allOf":[{"$ref":"#/components/schemas/Receipt"},{"properties":{"Cancellation":{"$ref":"#/components/schemas/Cancellation"}}}]}},"components/schemas/Cancellation":{"id":"components/schemas/Cancellation","kind":"json-schema","title":"Cancellation","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes CancellationHold or CancellationHospitality","example":"CancellationHold"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/CancellationHold":{"id":"components/schemas/CancellationHold","kind":"json-schema","title":"CancellationHold","data":{"allOf":[{"$ref":"#/components/schemas/Cancellation"},{"properties":{"Locator":{"$ref":"#/components/schemas/Locator"}}}]}},"components/schemas/AppliesToOffer":{"id":"components/schemas/AppliesToOffer","kind":"json-schema","title":"AppliesToOffer","data":{"allOf":[{"$ref":"#/components/schemas/AppliesTo"},{"properties":{"OfferIdentifier":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/OfferIdentifier"}}}}]}},"components/schemas/AppliesToOfferProduct":{"id":"components/schemas/AppliesToOfferProduct","kind":"json-schema","title":"AppliesToOfferProduct","data":{"allOf":[{"$ref":"#/components/schemas/AppliesTo"},{"properties":{"OfferIdentifier":{"$ref":"#/components/schemas/OfferIdentifier"},"ProductIdentifier":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/ProductIdentifier"}}}}]}},"components/schemas/CustomAuxiliarySegment":{"id":"components/schemas/CustomAuxiliarySegment","kind":"json-schema","title":"CustomAuxiliarySegment","data":{"allOf":[{"$ref":"#/components/schemas/CustomAuxiliarySegmentID"},{"required":["Date","Location","Quantity","SegmentType","StatusCode","SupplierCode"],"properties":{"SegmentType":{"maxLength":3,"pattern":"([A-Z]+)?","type":"string","description":"The auxiliary segment type. SUR, TUR","example":"TUR"},"SupplierCode":{"pattern":"([a-zA-Z0-9]{2})","type":"string","description":"The supplier code application to this segment.","example":"YY"},"StatusCode":{"maxLength":2,"pattern":"([A-Z]+)?","type":"string","example":"BK"},"Quantity":{"type":"integer","description":"The quantity of services provided for this auxiliary segment.","format":"int32","example":1},"Location":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Three character IATA location code relevant to the auxiliary segment.","example":"LON"},"Date":{"type":"string","description":"The local date relevant to the auxiliary segment.","format":"date"},"CustomTextQualifier":{"maxLength":3,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"Text qualifier such as DO for drop off.","example":"DO"},"CustomText":{"maxLength":115,"type":"string","description":"Custom text relevant to this auxiliary segment."}}}]}},"components/schemas/DocumentAgencyServiceFee":{"id":"components/schemas/DocumentAgencyServiceFee","kind":"json-schema","title":"DocumentAgencyServiceFee","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"RelatedDocumentNumber":{"$ref":"#/components/schemas/DocumentNumber"}}}]}},"components/schemas/TravelDocumentDetail":{"id":"components/schemas/TravelDocumentDetail","kind":"json-schema","title":"TravelDocumentDetail","data":{"description":"The extended class of Traveler Document.","allOf":[{"$ref":"#/components/schemas/TravelDocument"},{"properties":{"IssuedForGeoPoliticalArea":{"$ref":"#/components/schemas/GeoPoliticalArea"},"Address":{"$ref":"#/components/schemas/Address"}}}]}},"components/schemas/GeoPoliticalArea":{"id":"components/schemas/GeoPoliticalArea","kind":"json-schema","title":"GeoPoliticalArea","data":{"properties":{"value":{"maxLength":32,"type":"string","example":"G"},"level":{"$ref":"#/components/schemas/GeoPoliticalAreaLevelEnum"},"id":{"type":"string","description":"Optional internally referenced id","example":"2"}},"description":"The location code of the geographical location. Codes from Ref Pub"}},"components/schemas/GeoPoliticalAreaLevelEnum":{"id":"components/schemas/GeoPoliticalAreaLevelEnum","kind":"json-schema","title":"GeoPoliticalAreaLevelEnum","data":{"type":"string","description":"Represents the type of geopolitical area (country, Continent, State etc)","example":"Continent","enum":["World","Global Area","Continent Group","Continent","Country","StateProvince","City","Airport"]}},"components/schemas/OfferStatusHospitality":{"id":"components/schemas/OfferStatusHospitality","kind":"json-schema","title":"OfferStatusHospitality","data":{"description":"Status associated to the sold hotel segment.","allOf":[{"$ref":"#/components/schemas/OfferStatus"},{"properties":{"consumedInd":{"type":"boolean","description":"If true, the hotel offer has already been consumed and is for information only.","example":true},"code":{"maxLength":2,"type":"string","description":"The booking status code. HK, MK","example":"MK"},"Status":{"$ref":"#/components/schemas/OfferStatusEnum"}}}]}},"components/schemas/FormOfPaymentCash":{"id":"components/schemas/FormOfPaymentCash","kind":"json-schema","title":"FormOfPaymentCash","data":{"description":"Form Of Payment is by Cash","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"agentNonRefundableInd":{"type":"boolean","description":"This indicates that the Cash payment should not be refunded"},"Comment":{"maxLength":35,"type":"string","deprecated":true},"FreeText":{"maxLength":35,"type":"string"},"miscellaneousInd":{"type":"boolean","description":"If true, the form of payment type is MS, miscellaneous"}}}]}},"components/schemas/FormOfPaymentPaymentCard":{"id":"components/schemas/FormOfPaymentPaymentCard","kind":"json-schema","title":"FormOfPaymentPaymentCard","data":{"description":"Defines the payment details included when the form of payment is by payment card.","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"PaymentCard":{"$ref":"#/components/schemas/PaymentCard"},"inhibitPaymentCardAuthorizationInd":{"type":"boolean","description":"If true, the payment card will not go through card authorization process"},"notValidForPaymentInd":{"type":"boolean","description":"If true, the payment card has been masked and is not valid for making payments"},"ExtendedPayment":{"$ref":"#/components/schemas/ExtendedPayment"}}}]}},"components/schemas/PaymentCard":{"id":"components/schemas/PaymentCard","kind":"json-schema","title":"PaymentCard","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes PaymentCard or PaymentCardDetail","example":"PaymentCard"},"id":{"type":"string","description":"Payment card reference ID.","example":"paymentCard_01"},"effectiveDate":{"type":"string","description":"Indicated starting date.","format":"date"},"expireDate":{"pattern":"(0[1-9]|1[0-2])[0-9][0-9]","type":"string","description":"Card expiration date in MMYY format.","example":"0558"},"approvalCode":{"maxLength":16,"pattern":"([A-Z0-9]+)?","type":"string","description":"The approval code value","example":"C59"},"PrivacyGroup":{"$ref":"#/components/schemas/Privacy"},"CardType":{"$ref":"#/components/schemas/PaymentCardTypeEnum"},"CardCode":{"maxLength":2,"pattern":"([A-Z0-9]+)?","type":"string","description":"Specifies the two character code (MC, VI, AX, etc) for the payment card (open enumeration)","example":"VI"},"CardBrand":{"$ref":"#/components/schemas/PaymentCardTypeIssuer"},"CardIssuer":{"$ref":"#/components/schemas/PaymentCardTypeIssuer"},"CardHolderName":{"maxLength":128,"type":"string","description":"Name as displayed on payment card"},"CardNumber":{"$ref":"#/components/schemas/CardNumber"},"SeriesCode":{"$ref":"#/components/schemas/SeriesCode"},"MagneticStripe":{"maxItems":3,"type":"array","items":{"$ref":"#/components/schemas/MagneticStripe"}},"secureInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implementer: If true, all or a portion of this data is secure, via tokenization, encryption and/or masking."},"children":[]}]}]}]}},"description":"Form of payment details for a payment card.","discriminator":{"propertyName":"@type"}}},"components/schemas/PaymentCardTypeEnum":{"id":"components/schemas/PaymentCardTypeEnum","kind":"json-schema","title":"PaymentCardTypeEnum","data":{"type":"string","description":"Type of card; supported values are Credit, Debit, Gift.","example":"Credit","enum":["Credit","Debit","Gift"]}},"components/schemas/PaymentCardTypeIssuer":{"id":"components/schemas/PaymentCardTypeIssuer","kind":"json-schema","title":"PaymentCardTypeIssuer","data":{"properties":{"paymentCardIssuers":{"$ref":"#/components/schemas/ListPaymentCardIssuerEnum"},"paymentCardIssuersExtension":{"maxLength":128,"minLength":1,"type":"string"},"issueNumber":{"type":"integer","description":"Assigned Type: c-1100:NumberDoubleDigit","format":"int32"}},"description":"This object contains Cards details for Payment"}},"components/schemas/ListPaymentCardIssuerEnum":{"id":"components/schemas/ListPaymentCardIssuerEnum","kind":"json-schema","title":"ListPaymentCardIssuerEnum","data":{"properties":{"value":{"$ref":"#/components/schemas/ListPaymentCardIssuerEnum_Base"}},"description":"An array of Payment Card Issuers"}},"components/schemas/ListPaymentCardIssuerEnum_Base":{"id":"components/schemas/ListPaymentCardIssuerEnum_Base","kind":"json-schema","title":"ListPaymentCardIssuerEnum_Base","data":{"type":"string","description":"Source: OpenTravel","example":"VISA","enum":["VISA","USAirways","UnitedAirlines","StarwoodHotels","SouthwestAirlines","RitzCarlton","Mastercard","Mariott","Hyatt","Hilton","Eurocard","Disney","DiscoverCard","DeltaAirlines","ContinentalAirlines","Citibank","Chase","CapitalOne","BritishAirways","BankOfAmerica","AmericanExpress"]}},"components/schemas/CardNumber":{"id":"components/schemas/CardNumber","kind":"json-schema","title":"CardNumber","data":{"properties":{"@type":{"type":"string","default":"CardNumber"},"encryptionKey":{"type":"string","description":"Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.","example":"secret"},"encryptionKeyMethod":{"type":"string","description":"Developer: This contains a reference to the key generation method being used - this is NOT the key value.","example":"RSA"},"encryptionMethod":{"type":"string","description":"OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.","example":"RSA"},"encryptedValue":{"type":"string","description":"Encrypted value","example":"5dfc52b51bd35553df8592078de921bc"},"mask":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Masked Value","example":"xxxx436"},"token":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Token value","example":"A567GTREWQ"},"tokenProviderID":{"type":"string","description":"Developer: This contains a provider ID if multiple providers are used for secure information exchange.","example":"c1234532"},"authenticationMethod":{"$ref":"#/components/schemas/EncryptionTokenTypeAuthEnum"},"PlainText":{"type":"string","description":"Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value.","example":"un-encrypted data"},"ErrorWarning":{"$ref":"#/components/schemas/ErrorWarning"}},"description":"The payment card number"}},"components/schemas/EncryptionTokenTypeAuthEnum":{"id":"components/schemas/EncryptionTokenTypeAuthEnum","kind":"json-schema","title":"EncryptionTokenTypeAuthEnum","data":{"type":"string","description":"Type of Authentication","example":"SecurityCode","enum":["SecurityCode","MagneticStripe"]}},"components/schemas/SeriesCode":{"id":"components/schemas/SeriesCode","kind":"json-schema","title":"SeriesCode","data":{"properties":{"@type":{"type":"string","default":"SeriesCode"},"encryptionKey":{"type":"string","description":"Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.","example":"secret"},"encryptionKeyMethod":{"type":"string","description":"Developer: This contains a reference to the key generation method being used - this is NOT the key value.","example":"RSA"},"encryptionMethod":{"type":"string","description":"OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.","example":"RSA"},"encryptedValue":{"type":"string","description":"Encrypted value","example":"5dfc52b51bd35553df8592078de921bc"},"mask":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Masked Value","example":"xxxx436"},"token":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Token value","example":"A567GTREWQ"},"tokenProviderID":{"type":"string","description":"Developer: This contains a provider ID if multiple providers are used for secure information exchange.","example":"c1234532"},"authenticationMethod":{"$ref":"#/components/schemas/EncryptionTokenTypeAuthEnum"},"PlainText":{"type":"string","description":"Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value. The credit card three or four digit CVV code. Required by certain suppliers. Booking.com requires the CVV code.","example":"un-encrypted data"},"ErrorWarning":{"$ref":"#/components/schemas/ErrorWarning"}},"description":"The security code of card."}},"components/schemas/MagneticStripe":{"id":"components/schemas/MagneticStripe","kind":"json-schema","title":"MagneticStripe","data":{"properties":{"@type":{"type":"string","default":"MagneticStripe"},"encryptionKey":{"type":"string","description":"Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.","example":"secret"},"encryptionKeyMethod":{"type":"string","description":"Developer: This contains a reference to the key generation method being used - this is NOT the key value.","example":"RSA"},"encryptionMethod":{"type":"string","description":"OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.","example":"RSA"},"encryptedValue":{"type":"string","description":"Encrypted value","example":"5dfc52b51bd35553df8592078de921bc"},"mask":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Masked Value","example":"xxxx436"},"token":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Token value","example":"A567GTREWQ"},"tokenProviderID":{"type":"string","description":"Developer: This contains a provider ID if multiple providers are used for secure information exchange.","example":"c1234532"},"authenticationMethod":{"$ref":"#/components/schemas/EncryptionTokenTypeAuthEnum"},"PlainText":{"type":"string","description":"Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value.","example":"un-encrypted data"},"ErrorWarning":{"$ref":"#/components/schemas/ErrorWarning"}},"description":"The magnetic stripe information from a physical payment card"}},"components/schemas/FormOfPaymentForfeit":{"id":"components/schemas/FormOfPaymentForfeit","kind":"json-schema","title":"FormOfPaymentForfeit","data":{"description":"Form Of Payment has been forfeited during an exchange transaction","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"forfeitInd":{"type":"boolean","description":"If true, this form of payment instruction is to forfeit residual amounts specified in an Offer. Used in conjunction with Payment to specify which amounts to be forfeited"}}}]}},"components/schemas/FormOfPaymentBSP":{"id":"components/schemas/FormOfPaymentBSP","kind":"json-schema","title":"FormOfPaymentBSP","data":{"description":"Form Of Payment is by BSP","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"accountNumber":{"maxLength":32,"type":"string","description":"The account number for the Form of payment BSP","example":"378282246310005"}}}]}},"components/schemas/FormOfPaymentAgencyAccount":{"id":"components/schemas/FormOfPaymentAgencyAccount","kind":"json-schema","title":"FormOfPaymentAgencyAccount","data":{"description":"Form Of Payment is by Agency account","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"agencyId":{"maxLength":32,"type":"string","description":"The agency Id","example":"87654321"}}}]}},"components/schemas/FormOfPaymentInvoice":{"id":"components/schemas/FormOfPaymentInvoice","kind":"json-schema","title":"FormOfPaymentInvoice","data":{"required":["InvoiceNumber"],"description":"Form Of Payment is by Invoice","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"InvoiceNumber":{"maxLength":38,"type":"string","description":"The invoice number applicable to this form of payment. "}}}]}},"components/schemas/FormOfPaymentDocument":{"id":"components/schemas/FormOfPaymentDocument","kind":"json-schema","title":"FormOfPaymentDocument","data":{"description":"Form Of Payment is by Document. Document types could be Ticket, EMD, Voucher, MCO","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"DocumentNumber":{"$ref":"#/components/schemas/DocumentNumber"}}}]}},"components/schemas/FormOfPaymentWaiverCode":{"id":"components/schemas/FormOfPaymentWaiverCode","kind":"json-schema","title":"FormOfPaymentWaiverCode","data":{"description":"Form of Payment is wholly or partially applied using a waiver code","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"WaiverCode":{"$ref":"#/components/schemas/WaiverCode"}}}]}},"components/schemas/PaymentCardDetail":{"id":"components/schemas/PaymentCardDetail","kind":"json-schema","title":"PaymentCardDetail","data":{"description":"Additional detail information associated to a Payment Card","allOf":[{"$ref":"#/components/schemas/PaymentCard"},{"properties":{"countryOfIssue":{"pattern":"[a-zA-Z]{2}","type":"string","description":"The country code ISO","example":"AG"},"companyCardReference":{"maxLength":4096,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"The company card reference","example":"IOR1386861"},"bankName":{"maxLength":64,"type":"string","description":"The bank name value","example":"Bank of America"},"bankCountryCode":{"pattern":"[a-zA-Z]{2}","type":"string","description":"The bank country code ISO","example":"BOFAUS3N"},"bankStateCode":{"maxLength":2,"minLength":2,"pattern":"([a-zA-Z]{2})","type":"string","description":"The bank state code ISO","example":"NE"},"CardHolderId":{"$ref":"#/components/schemas/Identifier"},"PersonName":{"$ref":"#/components/schemas/PersonName"},"Address":{"$ref":"#/components/schemas/Address"},"Telephone":{"type":"array","items":{"$ref":"#/components/schemas/Telephone"}},"Email":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"CustomerLoyalty":{"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyalty"}},"SignatureOnFile":{"$ref":"#/components/schemas/SignatureOnFile"},"ThreeDomainSecurity":{"$ref":"#/components/schemas/ThreeDomainSecurity"},"extendedPaymentInd":{"type":"boolean","description":"Implementer: If true, the credit card company is requested to delay the date on which the amount of this transaction is applied to the customer's account."},"enettInd":{"type":"boolean","description":"True if this payment card has been issued through Enett","example":true},"thirdPartyInd":{"type":"boolean","description":"If true, then the payment card holder is not one of the travelers in the reservation","example":true},"acceptanceOverrideInd":{"type":"boolean","description":"If true, override airline restriction on the payment card","example":true}}}]}},"components/schemas/SignatureOnFile":{"id":"components/schemas/SignatureOnFile","kind":"json-schema","title":"SignatureOnFile","data":{"properties":{"@type":{"type":"string","example":"SignatureOnFile"},"Date_EffectiveExpire":{"$ref":"#/components/schemas/DateEffectiveExpire"},"signatureOnFileInd":{"type":"boolean","description":"When true, indicates a signature has been obtained.","example":true}},"description":"Signature held on file"}},"components/schemas/DateEffectiveExpire":{"id":"components/schemas/DateEffectiveExpire","kind":"json-schema","title":"DateEffectiveExpire","data":{"properties":{"effective":{"type":"string","description":"Indicates the starting date.","format":"date"},"expire":{"type":"string","description":"Indicates the ending date.","format":"date"},"expireDateExclusiveInd":{"type":"boolean","description":"When true, indicates that the ExpireDate is the first day after the applicable period (e.g. when expire date is Oct 15  the last date of the period is Oct 14)."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used to identify the effective date and/or expiration date."},"children":[]}]}]}]}},"components/schemas/ThreeDomainSecurity":{"id":"components/schemas/ThreeDomainSecurity","kind":"json-schema","title":"ThreeDomainSecurity","data":{"required":["ThreeDomainSecurityGateway","ThreeDomainSecurityResults"],"properties":{"@type":{"type":"string","example":"ThreeDomainSecurity"},"ThreeDomainSecurityGateway":{"$ref":"#/components/schemas/ThreeDomainSecurityGateway"},"ThreeDomainSecurityResults":{"$ref":"#/components/schemas/ThreeDomainSecurityResults"}},"description":"3DS authentication information"}},"components/schemas/ThreeDomainSecurityGateway":{"id":"components/schemas/ThreeDomainSecurityGateway","kind":"json-schema","title":"ThreeDomainSecurityGateway","data":{"properties":{"@type":{"type":"string","example":"ThreeDomainSecurityGateway"},"eCI":{"maxLength":1,"type":"string","description":"The eCI value","example":"2"},"merchantID":{"type":"string","description":"The merchant ID value","example":"mycart"},"processorID":{"type":"string","description":"The processor ID value","example":"201"},"uRL":{"type":"string","description":"Transaction URL.","example":"https://transactionURL"},"AuthenticationVerification":{"$ref":"#/components/schemas/AuthenticationVerification"},"Password":{"$ref":"#/components/schemas/Password"}},"description":"3DS authentication information"}},"components/schemas/AuthenticationVerification":{"id":"components/schemas/AuthenticationVerification","kind":"json-schema","title":"AuthenticationVerification","data":{"properties":{"@type":{"type":"string","default":"AuthenticationVerification"},"encryptionKey":{"type":"string","description":"Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.","example":"secret"},"encryptionKeyMethod":{"type":"string","description":"Developer: This contains a reference to the key generation method being used - this is NOT the key value.","example":"RSA"},"encryptionMethod":{"type":"string","description":"OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.","example":"RSA"},"encryptedValue":{"type":"string","description":"Encrypted value","example":"5dfc52b51bd35553df8592078de921bc"},"mask":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Masked Value","example":"xxxx436"},"token":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Token value","example":"A567GTREWQ"},"tokenProviderID":{"type":"string","description":"Developer: This contains a provider ID if multiple providers are used for secure information exchange.","example":"c1234532"},"authenticationMethod":{"$ref":"#/components/schemas/EncryptionTokenTypeAuthEnum"},"PlainText":{"type":"string","description":"Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value.","example":"un-encrypted data"},"ErrorWarning":{"$ref":"#/components/schemas/ErrorWarning"}},"description":"Authentication and verification information"}},"components/schemas/Password":{"id":"components/schemas/Password","kind":"json-schema","title":"Password","data":{"properties":{"@type":{"type":"string","default":"Password"},"encryptionKey":{"type":"string","description":"Note: This contains a key required to retrieve the full payment instrument details compliant with PCI DSS standards.","example":"secret"},"encryptionKeyMethod":{"type":"string","description":"Developer: This contains a reference to the key generation method being used - this is NOT the key value.","example":"RSA"},"encryptionMethod":{"type":"string","description":"OpenTravel Best Practice: Encryption Method: When using the OpenTravel Encryption element, it is RECOMMENDED that all trading partners be informed of all encryption methods being used in advance of implementation to ensure message processing compatibility.","example":"RSA"},"encryptedValue":{"type":"string","description":"Encrypted value","example":"5dfc52b51bd35553df8592078de921bc"},"mask":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Masked Value","example":"xxxx436"},"token":{"pattern":"[0-9a-zA-Z]{1,32}","type":"string","description":"Token value","example":"A567GTREWQ"},"tokenProviderID":{"type":"string","description":"Developer: This contains a provider ID if multiple providers are used for secure information exchange.","example":"c1234532"},"authenticationMethod":{"$ref":"#/components/schemas/EncryptionTokenTypeAuthEnum"},"PlainText":{"type":"string","description":"Don't use this unless it is REALLY ok to not use encryption. Non-secure (plain text) value.","example":"un-encrypted data"},"ErrorWarning":{"$ref":"#/components/schemas/ErrorWarning"}},"description":"Password information"}},"components/schemas/ThreeDomainSecurityResults":{"id":"components/schemas/ThreeDomainSecurityResults","kind":"json-schema","title":"ThreeDomainSecurityResults","data":{"properties":{"@type":{"type":"string","example":"ThreeDomainSecurityResults"},"cAVV":{"type":"string","description":"The cAVV value","example":"AAABAFaQRwAAAAAAEZBHAAAAAAA=ECI05"},"pAResStatus":{"maxLength":1,"type":"string","description":"The pAResStatus value","example":"1"},"signatureVerfication":{"type":"string","description":"The signature Verification value","example":"Y"},"transactionID":{"type":"string","description":"The transaction ID","example":"9D920E9-6FCF-4A74-A4E0-D6A591D1108F"},"xID":{"type":"string","description":"Merchants must ensure that each Payer Authentication Request (PAReq) contains a unique combination of account ID and XID","example":"2bxUs1emK0SCevbivcApzAcAAQk="},"eCI":{"maxLength":32,"type":"string","description":"Electronic Commerce Indicator - 3-D secure data, contact your authenticator for rules and downline processing.","example":"2"},"uCAFIndicator":{"maxLength":32,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Universal Card Authentication Field™ MasterCard only UCAF is the mechanism that is used to transmit the AAV from the merchant to issuer for authentication purposes during the authorization process"},"children":[]}]}]}],"example":"0"}},"description":"3DS authentication information"}},"components/schemas/FormOfPaymentVirtualPaymentAccount":{"id":"components/schemas/FormOfPaymentVirtualPaymentAccount","kind":"json-schema","title":"FormOfPaymentVirtualPaymentAccount","data":{"properties":{"Supplier":{"maxLength":32,"type":"string","example":"Conferma"},"AccountID":{"maxLength":32,"type":"string","example":"123"},"AlternateEmailAddress":{"type":"array","description":"Deprecated-do not use. Replaced by AgencyEmail and AlternateHotelEmail","deprecated":true,"items":{"$ref":"#/components/schemas/Email"}},"AlternateHotelEmail":{"type":"array","description":"The alternate hotel email to be used for correspondence with this virtual payment","items":{"$ref":"#/components/schemas/Email"}},"AgencyEmail":{"type":"array","description":"The agency email to be used for correspondence with this virtual payment","items":{"$ref":"#/components/schemas/Email"}},"PaymentComment":{"maxLength":512,"type":"string","description":"Optional text to be sent to the supplier"},"AlternateHotelFax":{"type":"array","description":"Hotel fax number to be used if the hotel fax is unknown or not provided in Property details","items":{"$ref":"#/components/schemas/Telephone"}},"MaximumChargeableAmount":{"type":"array","description":"The maximum amount that the supplier may charge to the payment card including room rate and any incidentals specified","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"IncidentalCharges":{"type":"array","description":"List of incidentals that are permitted to be charged to the virtual payment card.","example":["BAR","BUS","CRB"],"items":{"maxLength":32,"type":"string"}},"DeploymentID":{"maxLength":30,"type":"string","description":"Conferma transaction ID assigned to virtual credit card.","example":"583677"}},"description":"Form Of Payment is by Virtual Payment Account.","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"}]}},"components/schemas/FormOfPaymentFlightPass":{"id":"components/schemas/FormOfPaymentFlightPass","kind":"json-schema","title":"FormOfPaymentFlightPass","data":{"description":"Form Of Payment is by Flight Pass. Currently supported only for Air Canada NDC.","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"required":["FlightPass"],"properties":{"FlightPass":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/FlightPass"}}}}]}},"components/schemas/FlightPass":{"id":"components/schemas/FlightPass","kind":"json-schema","title":"FlightPass","data":{"required":["@type","accountNumber","supplier"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes","example":"FlightPass"},"accountNumber":{"maxLength":30,"type":"string","description":"The flight pass account number.","example":"0140851633093"},"supplier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The flight pass supplier code. AC is the only value accepted at this time.","example":"AC"},"Description":{"maxItems":5,"type":"array","items":{"maxLength":128,"type":"string","description":"Optional program name or description of the flight pass.","example":"FlightPass"}},"TravelerIdentifierRef":{"maxItems":10,"type":"array","description":"In Search, use the passengerCriteriaRef to reference the owner of the flightpass. This is a mandatory field for Search API.","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when using a flight pass to pay for an Air Canada NDC booking. Only one instance allowed. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/ndc/ndc-guide-for-air-canada-flight-pass"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Canada Flight Pass"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" NDC Guide for more information."},"children":[]}]}]}]}},"components/schemas/FormOfPaymentCheck":{"id":"components/schemas/FormOfPaymentCheck","kind":"json-schema","title":"FormOfPaymentCheck","data":{"description":"Form Of Payment is by Check","allOf":[{"$ref":"#/components/schemas/FormOfPaymentID"},{"properties":{"checkInd":{"type":"boolean","description":"If true, the form of payment type is check"}}}]}},"components/schemas/Flight":{"id":"components/schemas/Flight","kind":"json-schema","title":"Flight","data":{"description":"Common flight properties.","allOf":[{"$ref":"#/components/schemas/FlightID"},{"required":["Arrival","Departure","carrier","number"],"properties":{"distance":{"type":"integer","description":"Distance covered by the flight.","format":"int32","example":6574},"stops":{"type":"integer","description":"Number of stops","format":"int32","example":2},"duration":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Elapsed flight time."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represented in hours (H) and minutes (M) OR the format PT{x}H{x}M, in which P is the duration designator, T is the time designator, {x}H is the number of hours for the connection, and {x}H is the number of minutes for the connection."},"children":[]}]}]}],"example":"PT1H40M"},"carrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The airline code.","example":"BA"},"number":{"pattern":"[0-9]{1,4}[A-Z]?|OPEN|ARNK","type":"string","description":"The marketing carrier flight number.","example":"98"},"operatingCarrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The operating airline code. Shown in codeshare situations when the operating carrier is different to the marketing carrier.","example":"BA"},"operatingCarrierName":{"maxLength":128,"type":"string","description":"The operating carrier name","example":"Liberty Aerospace"},"operatingCarrierNumber":{"pattern":"[0-9]{1,4}[A-Z]?|OPEN|ARNK","type":"string","description":"Operating airline flight number. If there is no operating carrier number, then CO2 emission estimates for operating carriers is not supported. GDS only; not returned for NDC. Returned only in Search response.","example":"091"},"equipment":{"pattern":"([A-Z0-9]{3})?","type":"string","description":"Equipment model.  \nNote that TRN, TRS, and BUS equipment codes indicate ground transportation.","example":"777"},"Departure":{"$ref":"#/components/schemas/Departure"},"Arrival":{"$ref":"#/components/schemas/Arrival"},"IntermediateStop":{"maxItems":9,"type":"array","items":{"$ref":"#/components/schemas/IntermediateStop"}},"subjectToGovernmentApprovalInd":{"type":"boolean","description":"If true, the airline has filed in its schedule that availability for a specific flight is subject to government approval. GDS only, not supported for NDC. Returned only in the Air Search API response.","example":true}}}]}},"components/schemas/IntermediateStop":{"id":"components/schemas/IntermediateStop","kind":"json-schema","title":"IntermediateStop","data":{"properties":{"value":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The IATA airport code for the airport where the intermediate stop occurs."},"arrivalFlightDuration":{"type":"string","description":"Duration in hours and minutes of the flight arriving at the intermediate stop. ISO 8601 format","example":"PT2H35M"},"departureFlightDuration":{"type":"string","description":"Duration in hours and minutes of the flight departing the intermediate stop. ISO 8601 format","example":"PT1H35M"},"duration":{"type":"string","description":"Duration in hours and minutes between the arrival and departure at the intermediate stop. ISO 8601 format","example":"PT1H35M"},"equipment":{"pattern":"([A-Z0-9]{3})?","type":"string","description":"Equipment model, if there is a change of equipment during the stop.","example":"777"},"arrivalDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"The local date the aircraft arrives at the intermediate stop","example":"2026-04-30"},"departureDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"The local date the aircraft departs from the intermediate stop","example":"2026-04-30"},"arrivalTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$","type":"string","description":"The local time the aircraft arrives at the intermediate stop","example":"68400"},"departurelTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$","type":"string","description":"The local time the aircraft departs from the intermediate stop","example":"72000"},"arrivalTerminal":{"maxLength":4096,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"Arrival terminal of the intermediate stop airport","example":"Terminal2"},"departureTerminal":{"maxLength":4096,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"Departure terminal of the intermediate stop airport","example":"Terminal4"}},"description":"Returned if the flight has a technical stop but does not incur a change in flight number. Returned in the Search, AirPrice, Exchange Search responses. Not returned for Ancillary Shop or Fare Rules."}},"components/schemas/Brand":{"id":"components/schemas/Brand","kind":"json-schema","title":"Brand","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information on airline Brand offerings."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If brand attributes were not excluded with inhibitBrandContentInd=true (GDS only), then brand attributes are returned and consolidated in ReferenceList/ReferenceListBrand. In this case Brand does not return the name or Identifier objects but instead returns only BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/BrandID"},{"required":["name"],"properties":{"name":{"maxLength":128,"type":"string","description":"Brand name from the supplier.","example":"Main Cabin Extra"},"tier":{"type":"integer","description":"The brand tier. Not returned for NDC.","format":"int32","example":2},"shelfNumbers":{"type":"array","description":"ATPCO shelf number. If the carrier has provided it for this brand, the shelf number is the number for a grouping of comparable brands that share similar ticket and flight attributes.","example":[1,4,5],"items":{"type":"integer","format":"int32"}},"code":{"maxLength":32,"type":"string","description":"The ATPCO Brand Code.","example":"REFMAIN"},"BrandAttribute":{"maxItems":100,"type":"array","description":"A list of enumerated features that are included, chargeable, or not offered for this brand.  \nContains one or more instances of the two paired key value pairs classification and inclusion.  \nThe return of brand attributes can be disabled in the AirPrice Reference Payload request.","items":{"$ref":"#/components/schemas/BrandAttribute"}},"AdditionalBrandAttribute":{"maxItems":15,"type":"array","description":"Array of non-enumerated features that are included, chargeable, or not offered for this brand. Contains one or more instances of the two paired key value pairs classification and inclusion.","items":{"$ref":"#/components/schemas/AdditionalBrandAttribute"}},"ImageURL":{"maxItems":10,"type":"array","example":["http:/imageurl.com"],"items":{"type":"string"}}}}]}},"components/schemas/BrandAttribute":{"id":"components/schemas/BrandAttribute","kind":"json-schema","title":"BrandAttribute","data":{"required":["@type","classification","inclusion"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"BrandAttribute"},"classification":{"$ref":"#/components/schemas/BrandClassificationEnum"},"inclusion":{"$ref":"#/components/schemas/BrandInclusionEnum"},"ImageURL":{"maxItems":10,"type":"array","description":"URL for an image for the brand, when available.","example":["http:/imageurl.com"],"items":{"type":"string"}},"matchedAttributeInd":{"type":"boolean","description":"Returned only if true for any attribute requested in ProductInclusionPreference.Classification.","example":true},"groupCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"Carrier group code. Returned if filed by the carrier.","example":"BG"},"subGroupCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"Carrier sub group code. Returned if filed by the carrier.","example":"CY"},"subCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"Carrier sub code. Returned if filed by the carrier.","example":"08A"}},"description":"Brand features."}},"components/schemas/BrandClassificationEnum":{"id":"components/schemas/BrandClassificationEnum","kind":"json-schema","title":"BrandClassificationEnum","data":{"type":"string","description":"The Travelport classification used for a category of ancillaries. Additional items can be sent in AdditionalClassification","example":"CarryOn","enum":["CheckedBag","CarryOn","PersonalItem","Rebooking","Refund","SeatAssignment","PremiumSeat","LieFlatSeat","Meals","WiFi","Other"]}},"components/schemas/BrandInclusionEnum":{"id":"components/schemas/BrandInclusionEnum","kind":"json-schema","title":"BrandInclusionEnum","data":{"type":"string","description":"The indicator as to how the brand and the product are associated.","example":"Included","enum":["Included","Chargeable","Not Offered"],"x-enumDescriptions":{"Included":"Attribute is included in the brand at no additional charge.","Chargeable":"Attribute is available for the brand at a cost.","NotOffered":"Attribute is not available for this brand."}}},"components/schemas/AdditionalBrandAttribute":{"id":"components/schemas/AdditionalBrandAttribute","kind":"json-schema","title":"AdditionalBrandAttribute","data":{"required":["@type","Classification","Inclusion"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"AdditionalBrandAttribute"},"Classification":{"maxLength":512,"type":"string","description":"The Travelport classification used for categories of ancillaries. Supported attributes currently include ChauffeurTransfer, ExtraLegroom, InFlightEntertainment, LoungeAccess, PriorityBaggage, PriorityBoarding, PriorityCheckIn, PrioritySecurity, PriorityServices,MileageAccrual, Upgrades, USB.","example":"ChauffeurTransfer"},"Inclusion":{"$ref":"#/components/schemas/BrandInclusionEnum"},"ImageURL":{"maxItems":10,"type":"array","description":"URL for an image for the brand, when available.","example":["https:/travelport/image/profile/firstviewimage"],"items":{"type":"string"}},"matchedAttributeInd":{"type":"boolean","description":"Returned only if true for any attribute requested in ProductInclusionPreference.Classification.","example":true},"groupCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"Carrier group code. Returned if filed by the carrier.","example":"BG"},"subGroupCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"Carrier sub group code. Returned if filed by the carrier.","example":"CY"},"subCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"Carrier sub code. Returned if filed by the carrier.","example":"08A"}},"description":"Additional brand features. Non - enumerated list."}},"components/schemas/ChangeFeeMethodEnum_Base":{"id":"components/schemas/ChangeFeeMethodEnum_Base","kind":"json-schema","title":"ChangeFeeMethodEnum_Base","data":{"type":"string","description":"List of change fee method","example":"EMD","enum":["EMD","MCO","Tax","Unknown"]}},"schema_491":{"kind":"json-schema","data":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string"},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"maxLength":32,"type":"string"},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ImageSizeEnum"},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"maxLength":89,"minLength":10,"pattern":"(^[a-zA-Z-0-9_]*[-]?[+]?$)","type":"string","example":"TraceID_123456789"},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"maxLength":36,"minLength":36,"pattern":"([a-zA-Z-0-9-_]*)","type":"string","example":"19Y88702-C27A-4E5D-829A-89D7016688B1"},"id":"schema_495"},"schema_496":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z\\d]{3,4}_\\w{2}$","type":"string","example":"DU7_1G"},"id":"schema_496"},"schema_497":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"382c74c3-721d-4f34-80e5-57657b6cbc27"},"id":"schema_497"},"schema_498":{"kind":"json-schema","data":{"maxLength":128,"type":"string"},"id":"schema_498"},"schema_499":{"kind":"json-schema","data":{"type":"string"},"id":"schema_499"},"schema_500":{"kind":"json-schema","data":{"maxLength":100,"minLength":0,"pattern":"([a-zA-Z-0-9-_]*)","type":"string","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"id":"schema_500"},"schema_501":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_501"},"schema_502":{"kind":"json-schema","data":{"$ref":"#/components/schemas/IdentifierTypeENUM"},"id":"schema_502"}},"exampleStore":{"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location":{"value":{"PropertiesQuerySearch":{"@type":"PropertiesQuerySearch","CheckInDate":"2026-12-01","CheckOutDate":"2026-12-02","RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","age":54,"count":2,"ageQualifyingCode":"10"}]}}],"SearchBy":{"@type":"SearchByGeoLocation","SearchRadius":{"value":38.5,"unitOfDistance":"Kilometers"},"Latitude":48.8589507,"Longitude":2.2770198}}},"key":"by_location","summary":"By geo location","id":"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_location"},"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address":{"value":{"PropertiesQuerySearch":{"@type":"PropertiesQuerySearch","CheckInDate":"2026-12-01","CheckOutDate":"2026-12-02","RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","count":1}]}}],"SearchBy":{"@type":"SearchByAddress","SearchRadius":{"value":20,"unitOfDistance":"Miles"},"SearchAddress":{"@type":"SearchAddress","City":"Denver","StateProv":{"value":"CO","name":"Colorado"},"Country":"US"}}}},"key":"by_address","summary":"By address","id":"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_address"},"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport":{"value":{"PropertiesQuerySearch":{"@type":"PropertiesQuerySearch","CheckInDate":"2026-12-01","CheckOutDate":"2026-12-02","RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","count":1,"ageQualifyingCode":"10"}]}}],"SearchBy":{"@type":"SearchByAirport","SearchRadius":{"value":25,"unitOfDistance":"Miles"},"SearchAirport":"MCO"}}},"key":"by_airport","summary":"By airport","id":"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport"},"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city":{"value":{"PropertiesQuerySearch":{"@type":"PropertiesQuerySearch","CheckInDate":"2026-12-01","CheckOutDate":"2026-12-02","RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","count":1,"ageQualifyingCode":"10"}]}}],"SearchBy":{"@type":"SearchByCity","SearchRadius":{"value":25,"unitOfDistance":"Miles"},"SearchCity":"DEN"}}},"key":"by_city","summary":"By city","id":"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_city"},"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs":{"value":{"PropertiesQuerySearch":{"@type":"PropertiesQuerySearch","CheckInDate":"2026-12-01","CheckOutDate":"2026-12-02","ImageSize":"Large","returnAllImagesInd":true,"returnOnlyAvailablePropertiesInd":false,"RequestedCurrency":"EUR","HotelName":"paris","ChainCodes":["6C","EH","BW","CP","YX","SM"],"AggregatorList":["TVPT"],"RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","count":1,"ageQualifyingCode":"10"},{"@type":"GuestCount","count":1,"age":3,"ageQualifyingCode":"8"}]}}],"RateCandidates":{"@type":"RateCandidates","RateCandidate":[{"@type":"RateCandidateDetail","rateCode":"LOREAL"},{"@type":"RateCandidateDetail","rateCode":"PFI"},{"@type":"RateCandidateDetail","rateCode":"DUR"},{"@type":"RateCandidateDetail","rateCode":"H81"},{"@type":"RateCandidateDetail","rateCategory":"Tour"},{"@type":"RateCandidateDetail","rateCategory":"All"},{"@type":"RateCandidateDetail","CustomerLoyalty":{"supplier":"EM","value":"741439038"}}]},"SearchBy":{"@type":"SearchByAirport","SearchRadius":{"unitOfDistance":"Kilometers","value":40},"SearchAirport":"PAR"}}},"key":"by_airport_with_filters_and_RACs","summary":"By airport with filters and RACs","id":"paths/~1hotel~1search~1properties~1search/post/requestBody/content/application~1json/examples/by_airport_with_filters_and_RACs"},"paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id":{"value":{"PropertiesQuerySpecificPropertyList":{"@type":"PropertiesQuerySpecificPropertyList","checkinDate":"2026-12-01","checkoutDate":"2026-12-02","numberOfGuests":1,"RoomStayCandidates":{"RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","count":1,"age":26,"ageQualifyingCode":"10"}]}}]},"PropertyKey":[{"propertyCode":"G3375","chainCode":"WI","@type":"PropertyKey"}]}},"key":"by_property_id","summary":"By property ID","id":"paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id"},"paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs":{"value":{"PropertiesQuerySpecificPropertyList":{"@type":"PropertiesQuerySpecificPropertyList","checkinDate":"2026-12-01","checkoutDate":"2026-12-02","numberOfGuests":1,"imageSize":"Large","returnAllImagesInd":true,"requestedCurrency":"EUR","AggregatorList":["TVPT"],"RoomStayCandidates":{"RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"@type":"GuestCount","count":1,"age":26,"ageQualifyingCode":"10"},{"@type":"GuestCount","count":1,"age":3,"ageQualifyingCode":"8"}]}}]},"RateCandidates":{"@type":"RateCandidates","RateCandidate":[{"@type":"RateCandidateDetail","rateCode":"LOREAL"},{"@type":"RateCandidateDetail","rateCode":"PFI"},{"@type":"RateCandidateDetail","rateCode":"DUR"},{"@type":"RateCandidateDetail","rateCode":"H81"},{"@type":"RateCandidateDetail","masterRateCode":"1ABC23"},{"@type":"RateCandidateDetail","rateCategory":"Tour"},{"@type":"RateCandidateDetail","rateCategory":"All"},{"@type":"RateCandidateDetail","CustomerLoyalty":{"supplier":"EM","value":"741439038"}}]},"PropertyKey":[{"propertyCode":"G3375","chainCode":"WI","@type":"PropertyKey"},{"propertyCode":"02124","chainCode":"CP","@type":"PropertyKey"},{"propertyCode":"17424","chainCode":"HI","@type":"PropertyKey"},{"propertyCode":"G4741","chainCode":"UP","@type":"PropertyKey"}]}},"key":"by_property_id_with_filters_and_RACs","summary":"By property ID with filters and RACs","id":"paths/~1hotel~1search~1properties/post/requestBody/content/application~1json/examples/by_property_id_with_filters_and_RACs"},"paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability":{"value":{"CatalogOfferingsQueryRequest":{"@type":"CatalogOfferingsRequestHospitality","CatalogOfferingsRequest":[{"@type":"CatalogOfferingsRequestHospitality","verboseResponseInd":true,"requestedCurrency":"EUR","StayDates":{"start":"2026-12-01","end":"2026-12-02"},"HotelSearchCriterion":{"@type":"HotelSearchCriterion","numberOfRooms":1,"PropertyRequest":[{"@type":"PropertyRequest","PropertyKey":{"propertyCode":"95075","chainCode":"HH","@type":"PropertyKey"}},{"@type":"PropertyRequest","PropertyKey":{"propertyCode":"02892","chainCode":"MD","@type":"PropertyKey"}},{"@type":"PropertyRequest","PropertyKey":{"propertyCode":"12153","chainCode":"BR","@type":"PropertyKey"}}],"RoomStayCandidates":{"@type":"RoomStayCandidates","RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"count":2,"@type":"GuestCount"}]}}]}}}]}},"key":"availability","summary":"Availability","id":"paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability"},"paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC":{"value":{"CatalogOfferingsQueryRequest":{"@type":"CatalogOfferingsRequestHospitality","CatalogOfferingsRequest":[{"@type":"CatalogOfferingsRequestHospitality","verboseResponseInd":false,"StayDates":{"start":"2026-12-01","end":"2026-12-02"},"HotelSearchCriterion":{"@type":"HotelSearchCriterion","numberOfRooms":1,"AggregatorList":["TVPT"],"PropertyRequest":[{"@type":"PropertyRequest","PropertyKey":{"propertyCode":"95075","chainCode":"HH","@type":"PropertyKey"}}],"RoomStayCandidates":{"@type":"RoomStayCandidates","RoomStayCandidate":[{"@type":"RoomStayCandidate","GuestCounts":{"@type":"GuestCounts","GuestCount":[{"count":1,"@type":"GuestCount"},{"count":1,"ageQualifyingCode":"8","age":4,"@type":"GuestCount"}]}}]},"RateCandidates":{"@type":"RateCandidatesDetail","prePayRatesOnlyInd":false,"postPayRatesOnlyInd":false,"removeSpecialRatesInd":true,"RateCandidate":[{"@type":"RateCandidateDetail","rateCode":"H81","chainCode":"HH","propertyCode":"95075"},{"@type":"RateCandidateDetail","masterRateCode":"1ANA01","chainCode":"HH","propertyCode":"95075"},{"@type":"RateCandidateDetail","rateCategory":"Weekend"},{"@type":"RateCandidateDetail","rateCategory":"All"},{"@type":"RateCandidateDetail","CustomerLoyalty":{"supplier":"HH","value":"loyaltynumber"},"chainCode":"HH","propertyCode":"95075"}]}}}]}},"key":"availability_with_RAC","summary":"Availability with RAC","id":"paths/~1hotel~1availability~1catalogofferingshospitality/post/requestBody/content/application~1json/examples/availability_with_RAC"},"paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload":{"value":{"OfferQueryBuildFromCatalogOffering":{"@type":"OfferQueryBuildFromCatalogOffering","BuildFromCatalogOfferingHospitality":{"@type":"BuildFromCatalogOfferingHospitality","CatalogOfferingIdentifier":{"value":"c122d8e9-6563-4139-a9c7-99334e5a052e:898e8fab584bb2b787a41fe9f95ce9b3"}}}},"key":"rules_reference_payload","summary":"Rules reference payload","id":"paths/~1hotel~1rules~1offershospitality~1buildfromcatalogoffering/post/requestBody/content/application~1json/examples/rules_reference_payload"},"paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload":{"value":{"OfferQueryHospitalityRequest":{"@type":"OfferQueryHospitalityRequest","bookingCode":"A01E03","requestedCurrency":"EUR","checkinDate":"2026-12-01","checkoutDate":"2026-12-02","numberOfGuests":1,"storedAmount":398.65,"storedCurrency":"CAD","HotelAggregator":"Travelport","PropertyKey":{"@type":"PropertyKey","chainCode":"HH","propertyCode":"95075"},"RateCandidate":{"@type":"RateCandidateDetail","rateCode":"H81","rateID":"8181000"}}},"key":"rules_full_payload","summary":"Rules full payload","id":"paths/~1hotel~1rules~1offershospitality~1buildfromrequest/post/requestBody/content/application~1json/examples/rules_full_payload"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","id":"62b3ced3-92f7-47b3-adb1-03588c5dc5a7:190000fa-366c-4ffd-a4d1-59d17177c774","Product":[{"@type":"ProductHospitality","bookingCode":"APB174","Quantity":1,"guests":1,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-12-01","end":"2026-12-02"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":308.43}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Smith"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith@example.com"}]}]}},"key":"reservation_by_offer_id","summary":"Reservation by offer ID","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_offer_id"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","id":"62b3ced3-92f7-47b3-adb1-03588c5dc5a7:190000fa-366c-4ffd-a4d1-59d17177c774","Product":[{"@type":"ProductHospitality","Quantity":2,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":308.43}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Smith"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith@example.com"}]},{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Doe","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith2@example.com"}]}]}},"key":"group_reservation_by_offer_id","summary":"Group reservation by offer ID","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","Identifier":{"authority":"TVPT"},"Product":[{"@type":"ProductHospitality","bookingCode":"APB174","Quantity":1,"guests":1,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-12-01","end":"2026-12-02"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750},"TermsAndConditionsFull":[{"@type":"TermsAndConditionsFullHospitality","ProductRateCodeInfo":[{"@type":"ProductRateCodeInfo","RateCodeInfo":{"rateID":"100221835","value":"LOREAL"}}]}]}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":844.97},"guaranteeInd":false,"depositInd":true}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Middle":"Example String Value","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA","name":"California"},"Country":{"value":"US","id":"country_4","name":"United States","codeContext":"Example String Value"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}],"CustomerLoyalty":[{"value":"1111111","programId":"IQ","supplierType":"hotel"},{"value":"222222","programId":"IT","supplierType":"air"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Gabriel","Surname":"Deaconu","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"test@travelport.com"}]}]}},"key":"reservation_by_full_offer","summary":"Reservation by full offer","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/reservation_by_full_offer"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0824","CardType":"Credit","CardCode":"VI","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXXXX"}}}]}},"key":"modify_reservation_payment_card","summary":"Modify reservation payment card","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_payment_card"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Offer":[{"@type":"Offer","Product":[{"@type":"ProductHospitality","PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-11-23","end":"2026-11-24"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}]}},"key":"modify_reservation_check_in_out","summary":"Modify reservation check In/Out","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"ReservationComment":[{"@type":"ReservationComment","Comment":[{"value":"lower floor room please"}]}]}},"key":"modify_reservation_comment","summary":"Modify reservation comment","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_comment"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonName","Given":"john","Surname":"doe"},"Telephone":[{"@type":"TelephoneDetail","areaCityCode":"111","phoneNumber":"999999999"}]}]}},"key":"modify_reservation_traveler_phone","summary":"Modify reservation traveler phone","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonName","Given":"john","Surname":"doe"}}]}},"key":"modify_reservation_traveler_name","summary":"Modify reservation traveler name","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name"},"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","Product":[{"@type":"ProductHospitality","Quantity":1,"passiveBookingReasonCode":"G","bookingCode":"AAA1234567","propertyName":"Hilton Denver","PropertyAddress":{"AddressLine":["1001 A Havana street"],"City":"Denver","StateProv":{"value":"CO"},"Country":{"value":"US"},"PostalCode":"84188"},"GuestCounts":{"@type":"GuestCounts","GuestCount":[{"ageQualifyingCode":"10","count":2,"@type":"GuestCount"},{"ageQualifyingCode":"8","count":2,"age":4,"@type":"GuestCount"}]},"DateRange":{"start":"2026-12-06","end":"2026-12-07"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"USD","decimalPlace":2},"TotalPrice":100.55,"Base":90.3,"PriceBreakdown":[{"@type":"PriceBreakdownHospitality","roomPricingType":"Per stay","Commission":{"@type":"CommissionPercent","application":"Commissionable"}}]},"TermsAndConditionsFull":[{"@type":"TermsAndConditionsFullHospitality","ProductRateCodeInfo":[{"RateCodeInfo":{"rateID":"8888444"}}]}]}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Ionut","Surname":"Rotaru"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"myemailexample@travelport.com"}]}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0828","CardCode":"VI","CardNumber":{"@type":"CardNumber","PlainText":"4111111111111111"}}}],"Payment":[{"@type":"Payment","Amount":{"code":"KRW","value":844.97},"guaranteeInd":false,"depositInd":true}],"Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","Locator":{"value":"1111AAA","locatorType":"Confirmation Number","sourceContext":"Supplier"}}}],"ReservationComment":[{"@type":"ReservationComment","commentSource":"Agency","shareWith":"Traveler","Comment":[{"name":"Special Instruction","value":"This is my spécial instruction"}]}]}},"key":"create_passive_reservation","summary":"Create MK passive reservation","id":"paths/~1hotel~1book~1reservations/post/requestBody/content/application~1json/examples/create_passive_reservation"},"paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id":{"value":{"ReservationQueryBuild":{"@type":"ReservationQueryBuild","ReservationBuild":{"@type":"ReservationBuildFromCatalogOffering","BuildFromCatalogOfferingHospitality":{"@type":"BuildFromCatalogOfferingHospitality","CatalogOfferingIdentifier":{"value":"5fd5e2dd-7aa9-412e-b057-944cfa92d008:a5ab07a6-2186-43f2-948d-90f5500f7f7e"}},"Traveler":[{"@type":"Traveler","PersonName":{"Given":"Bear","Surname":"Das","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"matt.singh@galileo.co.in"}],"CustomerLoyalty":[{"value":"1111111","programId":"IQ","supplierType":"hotel"},{"value":"222222","programId":"IT","supplierType":"air"}]}],"ReservationComment":[{"@type":"ReservationComment","Comment":[{"value":"Please dont charge CC"}]}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":844.97},"guaranteeInd":false,"depositInd":true}]}}},"key":"reservation_by_offer_id","summary":"Reservation by offer ID","id":"paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/reservation_by_offer_id"},"paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id":{"value":{"ReservationQueryBuild":{"@type":"ReservationQueryBuild","ReservationBuild":{"@type":"ReservationBuildFromCatalogOffering","BuildFromCatalogOfferingHospitality":{"@type":"BuildFromCatalogOfferingHospitality","CatalogOfferingIdentifier":{"value":"5fd5e2dd-7aa9-412e-b057-944cfa92d008:a5ab07a6-2186-43f2-948d-90f5500f7f7e"},"NumberOfRooms":2},"Traveler":[{"@type":"Traveler","PersonName":{"Given":"Bear","Surname":"Das","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"test@travelport.com"}]},{"@type":"Traveler","PersonName":{"Given":"Bear","Surname":"Two","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"test2@travelport.com"}]}],"ReservationComment":[{"@type":"ReservationComment","Comment":[{"value":"Please dont charge CC"}]}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":844.97},"guaranteeInd":false,"depositInd":true}]}}},"key":"group_reservation_by_offer_id","summary":"Group reservation by offer ID","id":"paths/~1hotel~1book~1reservations~1build/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","id":"62b3ced3-92f7-47b3-adb1-03588c5dc5a7:190000fa-366c-4ffd-a4d1-59d17177c774","Product":[{"@type":"ProductHospitality","bookingCode":"APB174","Quantity":1,"guests":1,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-12-01","end":"2026-12-02"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":308.43}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Smith"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith@example.com"}]}]}},"key":"reservation_by_offer_id","summary":"Reservation by offer ID","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_offer_id"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","id":"62b3ced3-92f7-47b3-adb1-03588c5dc5a7:190000fa-366c-4ffd-a4d1-59d17177c774","Product":[{"@type":"ProductHospitality","Quantity":2,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":308.43}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Smith"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith@example.com"}]},{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Doe","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith2@example.com"}]}]}},"key":"group_reservation_by_offer_id","summary":"Group reservation by offer ID","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/group_reservation_by_offer_id"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","Identifier":{"authority":"TVPT"},"Product":[{"@type":"ProductHospitality","bookingCode":"APB174","Quantity":1,"guests":1,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-12-01","end":"2026-12-02"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750},"TermsAndConditionsFull":[{"@type":"TermsAndConditionsFullHospitality","ProductRateCodeInfo":[{"@type":"ProductRateCodeInfo","RateCodeInfo":{"rateID":"100221835","value":"LOREAL"}}]}]}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":844.97},"guaranteeInd":false,"depositInd":true}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Middle":"Example String Value","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA","name":"California"},"Country":{"value":"US","id":"country_4","name":"United States","codeContext":"Example String Value"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}],"CustomerLoyalty":[{"value":"1111111","programId":"IQ","supplierType":"hotel"},{"value":"222222","programId":"IT","supplierType":"air"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Gabriel","Surname":"Deaconu","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"test@travelport.com"}]}]}},"key":"reservation_by_full_offer","summary":"Reservation by full offer","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/reservation_by_full_offer"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0824","CardType":"Credit","CardCode":"VI","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXXXX"}}}]}},"key":"modify_reservation_payment_card","summary":"Modify reservation payment card","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_payment_card"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Offer":[{"@type":"Offer","Product":[{"@type":"ProductHospitality","PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-11-23","end":"2026-11-24"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}]}},"key":"modify_reservation_check_in_out","summary":"Modify reservation check In/Out","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_check_in_out"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"ReservationComment":[{"@type":"ReservationComment","Comment":[{"value":"lower floor room please"}]}]}},"key":"modify_reservation_comment","summary":"Modify reservation comment","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_comment"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonName","Given":"john","Surname":"doe"},"Telephone":[{"@type":"TelephoneDetail","areaCityCode":"111","phoneNumber":"999999999"}]}]}},"key":"modify_reservation_traveler_phone","summary":"Modify reservation traveler phone","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_phone"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonName","Given":"john","Surname":"doe"}}]}},"key":"modify_reservation_traveler_name","summary":"Modify reservation traveler name","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/modify_reservation_traveler_name"},"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","Product":[{"@type":"ProductHospitality","Quantity":1,"passiveBookingReasonCode":"G","bookingCode":"AAA1234567","propertyName":"Hilton Denver","PropertyAddress":{"AddressLine":["1001 A Havana street"],"City":"Denver","StateProv":{"value":"CO"},"Country":{"value":"US"},"PostalCode":"84188"},"GuestCounts":{"@type":"GuestCounts","GuestCount":[{"ageQualifyingCode":"10","count":2,"@type":"GuestCount"},{"ageQualifyingCode":"8","count":2,"age":4,"@type":"GuestCount"}]},"DateRange":{"start":"2026-12-06","end":"2026-12-07"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"USD","decimalPlace":2},"TotalPrice":100.55,"Base":90.3,"PriceBreakdown":[{"@type":"PriceBreakdownHospitality","roomPricingType":"Per stay","Commission":{"@type":"CommissionPercent","application":"Commissionable"}}]},"TermsAndConditionsFull":[{"@type":"TermsAndConditionsFullHospitality","ProductRateCodeInfo":[{"RateCodeInfo":{"rateID":"8888444"}}]}]}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Ionut","Surname":"Rotaru"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"myemailexample@travelport.com"}]}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0828","CardCode":"VI","CardNumber":{"@type":"CardNumber","PlainText":"4111111111111111"}}}],"Payment":[{"@type":"Payment","Amount":{"code":"KRW","value":844.97},"guaranteeInd":false,"depositInd":true}],"Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","Locator":{"value":"1111AAA","locatorType":"Confirmation Number","sourceContext":"Supplier"}}}],"ReservationComment":[{"@type":"ReservationComment","commentSource":"Agency","shareWith":"Traveler","Comment":[{"name":"Special Instruction","value":"This is my spécial instruction"}]}]}},"key":"create_passive_reservation","summary":"Create MK passive reservation","id":"paths/~1hotel~1book~1reservations~1{Identifier}/put/requestBody/content/application~1json/examples/create_passive_reservation"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","id":"62b3ced3-92f7-47b3-adb1-03588c5dc5a7:190000fa-366c-4ffd-a4d1-59d17177c774","Product":[{"@type":"ProductHospitality","bookingCode":"APB174","Quantity":1,"guests":1,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-12-01","end":"2026-12-02"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":308.43}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Smith"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith@example.com"}]}]}},"key":"reservation_by_offer_id","summary":"Reservation by offer ID","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_offer_id"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","id":"62b3ced3-92f7-47b3-adb1-03588c5dc5a7:190000fa-366c-4ffd-a4d1-59d17177c774","Product":[{"@type":"ProductHospitality","Quantity":2,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":308.43}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA"},"Country":{"value":"US"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Smith"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith@example.com"}]},{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Jon","Surname":"Doe","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"smith2@example.com"}]}]}},"key":"group_reservation_by_offer_id","summary":"Group reservation by offer ID","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/group_reservation_by_offer_id"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","Identifier":{"authority":"TVPT"},"Product":[{"@type":"ProductHospitality","bookingCode":"APB174","Quantity":1,"guests":1,"PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-12-01","end":"2026-12-02"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750},"TermsAndConditionsFull":[{"@type":"TermsAndConditionsFullHospitality","ProductRateCodeInfo":[{"@type":"ProductRateCodeInfo","RateCodeInfo":{"rateID":"100221835","value":"LOREAL"}}]}]}],"Payment":[{"@type":"Payment","Amount":{"code":"USD","value":844.97},"guaranteeInd":false,"depositInd":true}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0825","CardType":"Credit","CardCode":"VI","CardHolderName":"Frank Sinatra","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXX"},"SeriesCode":{"@type":"SeriesCode","PlainText":"XXX"},"PersonName":{"@type":"PersonNameDetail","Given":"Bill","Middle":"Example String Value","Surname":"Thisguy"},"Address":{"@type":"AddressDetail","Number":{"value":"125"},"Street":"Billing Address Street","AddressLine":["125 Billing Address Street"],"City":"Claremont","County":"Los Angeles","StateProv":{"value":"CA","name":"California"},"Country":{"value":"US","id":"country_4","name":"United States","codeContext":"Example String Value"},"PostalCode":"91711-3323"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"1231234","cityCode":"DEN"}],"Email":[{"value":"smith@example.com"}],"CustomerLoyalty":[{"value":"1111111","programId":"IQ","supplierType":"hotel"},{"value":"222222","programId":"IT","supplierType":"air"}]}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Gabriel","Surname":"Deaconu","Title":"Mr"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"test@travelport.com"}]}]}},"key":"reservation_by_full_offer","summary":"Reservation by full offer","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/reservation_by_full_offer"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0824","CardType":"Credit","CardCode":"VI","CardNumber":{"@type":"CardNumber","PlainText":"XXXXXXXXXXXXXX"}}}]}},"key":"modify_reservation_payment_card","summary":"Modify reservation payment card","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_payment_card"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Offer":[{"@type":"Offer","Product":[{"@type":"ProductHospitality","PropertyKey":{"@type":"PropertyKey","propertyCode":"2772","chainCode":"HH"},"DateRange":{"start":"2026-11-23","end":"2026-11-24"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"EUR"},"Base":600,"TotalTaxes":150,"TotalPrice":750}}]}},"key":"modify_reservation_check_in_out","summary":"Modify reservation check In/Out","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_check_in_out"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"ReservationComment":[{"@type":"ReservationComment","Comment":[{"value":"lower floor room please"}]}]}},"key":"modify_reservation_comment","summary":"Modify reservation comment","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_comment"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonName","Given":"john","Surname":"doe"},"Telephone":[{"@type":"TelephoneDetail","areaCityCode":"111","phoneNumber":"999999999"}]}]}},"key":"modify_reservation_traveler_phone","summary":"Modify reservation traveler phone","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_phone"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name":{"value":{"ReservationDetail":{"@type":"Reservation","Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","ConfirmationStatus":"Confirmed","Locator":{"locatorType":"Confirmation Number","source":"HY","sourceContext":"Supplier","value":"HY0008752038"}}}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonName","Given":"john","Surname":"doe"}}]}},"key":"modify_reservation_traveler_name","summary":"Modify reservation traveler name","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/modify_reservation_traveler_name"},"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation":{"value":{"ReservationDetail":{"@type":"Reservation","Offer":[{"@type":"Offer","Product":[{"@type":"ProductHospitality","Quantity":1,"passiveBookingReasonCode":"G","bookingCode":"AAA1234567","propertyName":"Hilton Denver","PropertyAddress":{"AddressLine":["1001 A Havana street"],"City":"Denver","StateProv":{"value":"CO"},"Country":{"value":"US"},"PostalCode":"84188"},"GuestCounts":{"@type":"GuestCounts","GuestCount":[{"ageQualifyingCode":"10","count":2,"@type":"GuestCount"},{"ageQualifyingCode":"8","count":2,"age":4,"@type":"GuestCount"}]},"DateRange":{"start":"2026-12-06","end":"2026-12-07"}}],"Price":{"@type":"PriceDetail","CurrencyCode":{"value":"USD","decimalPlace":2},"TotalPrice":100.55,"Base":90.3,"PriceBreakdown":[{"@type":"PriceBreakdownHospitality","roomPricingType":"Per stay","Commission":{"@type":"CommissionPercent","application":"Commissionable"}}]},"TermsAndConditionsFull":[{"@type":"TermsAndConditionsFullHospitality","ProductRateCodeInfo":[{"RateCodeInfo":{"rateID":"8888444"}}]}]}],"Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"Ionut","Surname":"Rotaru"},"Telephone":[{"@type":"TelephoneDetail","countryAccessCode":"91","areaCityCode":"011","phoneNumber":"9891766469","cityCode":"DL"}],"Email":[{"value":"myemailexample@travelport.com"}]}],"FormOfPayment":[{"@type":"FormOfPaymentPaymentCard","PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0828","CardCode":"VI","CardNumber":{"@type":"CardNumber","PlainText":"4111111111111111"}}}],"Payment":[{"@type":"Payment","Amount":{"code":"KRW","value":844.97},"guaranteeInd":false,"depositInd":true}],"Receipt":[{"@type":"ReceiptConfirmation","Confirmation":{"@type":"ConfirmationHold","Locator":{"value":"1111AAA","locatorType":"Confirmation Number","sourceContext":"Supplier"}}}],"ReservationComment":[{"@type":"ReservationComment","commentSource":"Agency","shareWith":"Traveler","Comment":[{"name":"Special Instruction","value":"This is my spécial instruction"}]}]}},"key":"create_passive_reservation","summary":"Create MK passive reservation","id":"paths/~1hotel~1book~1reservations~1passive/post/requestBody/content/application~1json/examples/create_passive_reservation"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer authentication using a JSON Web Token (JWT). The token must be sent in the Authorization header using the format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/apis/stays","isMockServer":true,"description":"Mock server"},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}]},"options":{"hideDownloadButtons":true,"hideReplay":true,"jsonSamplesExpandLevel":3,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Payload"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/apis/stays","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/stays/@11.35/index.json?download"},{"url":"/_bundle/apis/stays/@11.35/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"TripServices Stays","description":"The TripServices Stay v11 APIs are a robust, flexible set of RESTful JSON endpoints that empower developers to build seamless, beautiful hotel booking experiences with global reach and real-time data. Built for developers, our APIs are designed to integrate easily into your applications, enabling you to build rich, responsive hotel booking interfaces tailored to your users. For information on how Travelport uses polymorphism in our APIs please see documentation available. [Polymorphism guide](https://developer.travelport.com/docs/best-practice-polymorphism)"}},"baseSlug":"/apis/stays","routesMapping":{}}