{"items":[{"type":"link","label":"TripServices Flights","link":"/apis/flights","routeSlug":"/apis/flights","content":{"contentType":"overview","meta":{"name":"TripServices Flights"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://my.travelport.com/","url":"https://my.travelport.com/"}]},{"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/flights","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 Flights (11.35.2)","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 Flights API collection supports rapid development of high-performing travel solutions. The Air APIs connect you to comprehensive air content and facilitate multi-channel development across web and mobile platforms. All requests are RESTful and support JSON. 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/flights"}],"sectionId":"/apis/flights"}]}]}},{"type":"group","label":"Searches","link":"/apis/flights/searches","routeSlug":"/apis/flights/searches","items":[{"label":"Air Availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/searches/createairavailability","routeSlug":"/apis/flights/searches/createairavailability","metadata":{"seo":{"title":"Air Availability","description":"Air Availability returns scheduled flights between a specified city pair on a specified day and time and indicates whether seats are available on those flights. Air Availability is a full payload request that focuses on seat availability by class of service. It does not return pricing information. GDS only; not supported for NDC."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateAirAvailability","name":"Air Availability","isWebhook":false,"pointer":"/paths/~1air~1search~1airAvailability/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Air Availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Air Availability returns scheduled flights between a specified city pair on a specified day and time and indicates whether seats are available on those flights. Air Availability is a full payload request that focuses on seat availability by class of service. It does not return pricing information. GDS only; not supported for NDC."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1search~1airAvailability/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability"]}},"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability"],"pointer":"/paths/~1air~1search~1airAvailability/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/search/airAvailability","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/search/airAvailability","href":"searches/createairavailability","openApiOperationId":"CreateAirAvailability","summary":"Air Availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability"]}},"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/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1search~1airAvailability/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/searches/createairavailability"}],"panels":[]}]},"httpPath":"/air/search/airAvailability"},{"label":"Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/searches/createairsearch","routeSlug":"/apis/flights/searches/createairsearch","metadata":{"seo":{"title":"Search","description":"The Search API returns offers for flights between specific origin and destination (O&D) pairs. You can set the Search request to return offers for the full itinerary (a journey-based search), or for only the first leg (a leg-based search) and follow it with a Next Leg Search. Any modifiers or indicators sent in the Search request carry over to the Next Leg Search request and are not re-sent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateAirSearch","name":"Search","isWebhook":false,"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Search API returns offers for flights between specific origin and destination (O&D) pairs. You can set the Search request to return offers for the full itinerary (a journey-based search), or for only the first leg (a leg-based search) and follow it with a Next Leg Search. Any modifiers or indicators sent in the Search request carry over to the Next Leg Search request and are not re-sent."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing"]}},"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing"],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/catalog/search/catalogproductofferings","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/catalog/search/catalogproductofferings","href":"searches/createairsearch","openApiOperationId":"CreateAirSearch","summary":"Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased","paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing"]}},"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/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/searches/createairsearch"}],"panels":[]}]},"httpPath":"/air/catalog/search/catalogproductofferings"},{"label":"Next Leg Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/searches/buildnextairsearch","routeSlug":"/apis/flights/searches/buildnextairsearch","metadata":{"seo":{"title":"Next Leg Search","description":"The Next Leg Search API returns offers for the next leg of an itinerary after a leg-based round-trip Search. The leg-based Search response returns offers for the outbound leg of the itinerary, and Next Leg Search is then required to return offers for the next leg of the trip. For a multi-city itinerary, send an additional Next Leg Search request for each remaining leg. GDS supports searching for up to six O&D pairs (legs of the itinerary) while NDC supports three O&D pairs. Next Leg Search is supported only after a leg-based Search. If sent after a journey-based Search, an error message is returned. Any modifiers or indicators sent in the Search request carry over to the Next Leg Search request and are not re-sent. The Next Leg Search response uses the same structure and returns the same objects as the Search response. The only differences are, the first instance of CatalogProductOffering is the offer and product sent in the Next Leg Search request. This is the selected offer and product for the first leg. Subsequent instances of CatalogProductOffering are offers for the second leg."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildNextAirSearch","name":"Next Leg Search","isWebhook":false,"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Next Leg Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Next Leg Search API returns offers for the next leg of an itinerary after a leg-based round-trip Search. The leg-based Search response returns offers for the outbound leg of the itinerary, and Next Leg Search is then required to return offers for the next leg of the trip. For a multi-city itinerary, send an additional Next Leg Search request for each remaining leg. GDS supports searching for up to six O&D pairs (legs of the itinerary) while NDC supports three O&D pairs. Next Leg Search is supported only after a leg-based Search. If sent after a journey-based Search, an error message is returned. Any modifiers or indicators sent in the Search request carry over to the Next Leg Search request and are not re-sent. The Next Leg Search response uses the same structure and returns the same objects as the Search response. The only differences are, the first instance of CatalogProductOffering is the offer and product sent in the Next Leg Search request. This is the selected offer and product for the first leg. Subsequent instances of CatalogProductOffering are offers for the second leg."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildNext","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch"]}},"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildNext","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch"],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/catalog/search/catalogproductofferings/buildnext","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildNext","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/catalog/search/catalogproductofferings/buildnext","href":"searches/buildnextairsearch","openApiOperationId":"BuildNextAirSearch","summary":"Next Leg Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildNext","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildNext","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch"]}},"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/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/searches/buildnextairsearch"}],"panels":[]}]},"httpPath":"/air/catalog/search/catalogproductofferings/buildnext"},{"label":"Flight Specific Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/searches/buildoptionsairsearch","routeSlug":"/apis/flights/searches/buildoptionsairsearch","metadata":{"seo":{"title":"Flight Specific Search","description":"The Flight Specific Search API Reference Payload request returns additional upsells, up to 99, for any product/s returned by Search or Next Leg Search. The reference payload sends an identifier referencing a previous response and the offer and product identifiers. To use the Flight Specific Search reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached). The full payload request does not reference a previous Search response (GDS only, not supported for NDC). Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. The Flight Specific Search response uses the same structure and returns the same objects as the Search response. The difference is that one instance of CatalogProductOffering (id o1) is returned for each offer sent in the request and one instance of ReferenceListProduct/Product is returned for each product sent in the request. When sending a Premium Flex request, use the endpoint catalog/search/catalogproductofferings/buildpremiumflexoptions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildOptionsAirSearch","name":"Flight Specific Search","isWebhook":false,"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flight Specific Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Flight Specific Search API Reference Payload request returns additional upsells, up to 99, for any product/s returned by Search or Next Leg Search. The reference payload sends an identifier referencing a previous response and the offer and product identifiers. To use the Flight Specific Search reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached).  \nThe full payload request does not reference a previous Search response (GDS only, not supported for NDC).   \nAny CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests.  \nThe Flight Specific Search response uses the same structure and returns the same objects as the Search response. The difference is that one instance of CatalogProductOffering (id o1) is returned for each offer sent in the request and one instance of ReferenceListProduct/Product is returned for each product sent in the request.  \nWhen sending a Premium Flex request, use the endpoint catalog/search/catalogproductofferings/buildpremiumflexoptions."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS"]}},"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS"],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/catalog/search/catalogproductofferings/buildoptions","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/catalog/search/catalogproductofferings/buildoptions","href":"searches/buildoptionsairsearch","openApiOperationId":"BuildOptionsAirSearch","summary":"Flight Specific Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS"]}},"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/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/searches/buildoptionsairsearch"}],"panels":[]}]},"httpPath":"/air/catalog/search/catalogproductofferings/buildoptions"},{"label":"Flex Search (Premium)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/searches/createflexsearch","routeSlug":"/apis/flights/searches/createflexsearch","metadata":{"seo":{"title":"Flex Search (Premium)","description":"This is an additional premium feature, not activated by default. Please contact your Travelport representative for more information on how to activate.The Flex Search API is the first step in the travel booking workflow. Send a Search request to return offers for flights between the selected cities.TripServices Flex Search Point of Sales functionality is supported for GDS content. The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. Flex Search is supported for a maximum of two O&Ds and will be ignored when more than two SpecificFlightCriteria objects are sent in the request. The functionality will be available to selective TripServices Search customers. The customer can request this new functionality via their account representative.Customers can use the Accept Header to choose whether the TripServices Flex Flight Specific Search full payload response is aggregated or streamed.Stream Header Key “Accept” Value “application/stream+json”.When customers request streamed Flex Flight Specific Search full payload responses, multiple CatalogProductOfferingsResponse are returned consecutively, each including TermsAndConditionsAir and PricingAgency with the applicable PCC.Aggregate Header Key “Accept” Value “application/json”.When customers request aggregated Flex Flight Specific Search full payload  responses, offers from each PCC are combined into a single CatalogProductOfferingsResponse. Each offer includes its respective TermsAndConditionsAir and PricingAgency.References in the response have been updated to clearly distinguish offers by PCC. id = “f1o1”, “f1o2”, etc. for the first offer received, “f2o1”, “f2o2”, etc. for the second offer received, etc. Note: Customers should not assume that CatalogProductOffering “id” will follow a sequential pattern (e.g., f1, f2, f3) in aggregated Flex Search responses. Implementations must not rely on this ordering when consuming the data. CombinabilityCode = “f1j0”, “f1j1”, etc. for the first offer received, “f2j0”, “f2j1”, etc. for the second offer received, etc. ProductRef = “f1p0”, “f1p1”, etc. for the first offer received, “f2p0”, “f2p1”, etc. for the second offer received, etc. BrandRef = ”f1b0”, “f1b1”, etc. for the first offer received, “f2b0”, “f2b1”, etc. for the second offer received, etc. flightRefs = ”f1s1”, “f1s2”, etc. for the first offer received, “f2s1”, “f2s2”, etc. for the second offer received, etc. termsAndConditionsRef = ”f1T0”, “f1T1”, etc. for the first offer received, “f2T0”, “f2T1”, etc. for the second offer received, etc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateFlexSearch","name":"Flex Search (Premium)","isWebhook":false,"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flex Search (Premium)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an additional premium feature, not activated by default. Please contact your Travelport representative for more information on how to activate."},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Flex Search API is the first step in the travel booking workflow. Send a Search request to return offers for flights between the selected cities."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TripServices Flex Search Point of Sales functionality is supported for GDS content. The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir, MultiPricingAgency. Flex Search is supported for a maximum of two O&Ds and will be ignored when more than two SpecificFlightCriteria objects are sent in the request. The functionality will be available to selective TripServices Search customers. The customer can request this new functionality via their account representative."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers can use the Accept Header to choose whether the TripServices Flex Flight Specific Search full payload response is aggregated or streamed."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream Header Key “Accept” Value “application/stream+json”."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When customers request streamed Flex Flight Specific Search full payload responses, multiple CatalogProductOfferingsResponse are returned consecutively, each including TermsAndConditionsAir and PricingAgency with the applicable PCC."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate Header Key “Accept” Value “application/json”."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When customers request aggregated Flex Flight Specific Search full payload  responses, offers from each PCC are combined into a single CatalogProductOfferingsResponse. Each offer includes its respective TermsAndConditionsAir and PricingAgency."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References in the response have been updated to clearly distinguish offers by PCC. id = “f1o1”, “f1o2”, etc. for the first offer received, “f2o1”, “f2o2”, etc. for the second offer received, etc. Note: Customers should not assume that CatalogProductOffering “id” will follow a sequential pattern (e.g., f1, f2, f3) in aggregated Flex Search responses. Implementations must not rely on this ordering when consuming the data. CombinabilityCode = “f1j0”, “f1j1”, etc. for the first offer received, “f2j0”, “f2j1”, etc. for the second offer received, etc. ProductRef = “f1p0”, “f1p1”, etc. for the first offer received, “f2p0”, “f2p1”, etc. for the second offer received, etc. BrandRef = ”f1b0”, “f1b1”, etc. for the first offer received, “f2b0”, “f2b1”, etc. for the second offer received, etc. flightRefs = ”f1s1”, “f1s2”, etc. for the first offer received, “f2s1”, “f2s2”, etc. for the second offer received, etc. termsAndConditionsRef = ”f1T0”, “f1T1”, etc. for the first offer received, “f2T0”, “f2T1”, etc. for the second offer received, etc."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates","paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency"]}},"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates","paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency"],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/catalog/search/catalogproductofferings/premiumflex","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates","paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/catalog/search/catalogproductofferings/premiumflex","href":"searches/createflexsearch","openApiOperationId":"CreateFlexSearch","summary":"Flex Search (Premium)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates","paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryRequest","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates","paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency"]}},"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/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/searches/createflexsearch"}],"panels":[]}]},"httpPath":"/air/catalog/search/catalogproductofferings/premiumflex"},{"label":"Flex Flight Specific Search (Premium)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/searches/buildflexoptionsairsearch","routeSlug":"/apis/flights/searches/buildflexoptionsairsearch","metadata":{"seo":{"title":"Flex Flight Specific Search (Premium)","description":"This is an additional premium feature, not activated by default. Please contact your Travelport representative for more information on how to activate.With TripServices Flex Flight Specific Search full payload Point of Sales functionality, Online Travel Agencies (OTA) and Travel Management Companies (TMC) can expand their offer options for customers based on the point of sale of their branch agencies. They can select the offer that is more convenient even if the offer is in a different geographic location.TripServices Flex Flight Specific Search full payload Point of Sales functionality is supported for GDS content. The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir/MultiPricingAgency. Flex Search is supported for a maximum of two O&Ds and will be ignored when more than two SpecificFlightCriteria objects are sent in the request. The functionality will be available to selective TripServices Search customers. The customer can request this new functionality via their account representative.The request returns additional upsells, up to 99, for any product/s returned by Search or Next Leg Search. The reference payload sends an identifier referencing a previous response and the offer and product identifiers. The full payload request does not reference a previous Search response. GDS only, not supported for NDC. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. To use the Flight Specific Search reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached). The Flight Specific Search response uses the same structure and returns the same objects as the Search response. The differences are, One instance of CatalogProductOffering (id o1) is returned for each offer sent in the request. One instance of ReferenceListProduct/Product is returned for each product sent in the request.Customers can use the Accept Header to choose whether the TripServices Flex Flight Specific Search full payload response is aggregated or streamed.Stream Header Key “Accept” Value “application/stream+json”.When customers request streamed Flex Flight Specific Search full payload responses, multiple CatalogProductOfferingsResponse are returned consecutively, each including TermsAndConditionsAir and PricingAgency with the applicable PCC.Aggregate Header Key “Accept” Value “application/json”.When customers request aggregated Flex Flight Specific Search full payload  responses, offers from each PCC are combined into a single CatalogProductOfferingsResponse. Each offer includes its respective TermsAndConditionsAir and PricingAgency.References in the response have been updated to clearly distinguish offers by PCC. id = “f1o1”, “f1o2”, etc. for the first offer received, “f2o1”, “f2o2”, etc. for the second offer received, etc. Note: Customers should not assume that CatalogProductOffering “id” will follow a sequential pattern (e.g., f1, f2, f3) in aggregated Flex Search responses. Implementations must not rely on this ordering when consuming the data. CombinabilityCode = “f1j0”, “f1j1”, etc. for the first offer received, “f2j0”, “f2j1”, etc. for the second offer received, etc. ProductRef = “f1p0”, “f1p1”, etc. for the first offer received, “f2p0”, “f2p1”, etc. for the second offer received, etc. BrandRef = ”f1b0”, “f1b1”, etc. for the first offer received, “f2b0”, “f2b1”, etc. for the second offer received, etc. flightRefs = ”f1s1”, “f1s2”, etc. for the first offer received, “f2s1”, “f2s2”, etc. for the second offer received, etc. termsAndConditionsRef = ”f1T0”, “f1T1”, etc. for the first offer received, “f2T0”, “f2T1”, etc. for the second offer received, etc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildFlexOptionsAirSearch","name":"Flex Flight Specific Search (Premium)","isWebhook":false,"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flex Flight Specific Search (Premium)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an additional premium feature, not activated by default. Please contact your Travelport representative for more information on how to activate."},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With TripServices Flex Flight Specific Search full payload Point of Sales functionality, Online Travel Agencies (OTA) and Travel Management Companies (TMC) can expand their offer options for customers based on the point of sale of their branch agencies. They can select the offer that is more convenient even if the offer is in a different geographic location."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TripServices Flex Flight Specific Search full payload Point of Sales functionality is supported for GDS content. The customer can send up to 3 Pseudo City Codes (PCCs) in PricingModifiersAir/MultiPricingAgency. Flex Search is supported for a maximum of two O&Ds and will be ignored when more than two SpecificFlightCriteria objects are sent in the request. The functionality will be available to selective TripServices Search customers. The customer can request this new functionality via their account representative."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request returns additional upsells, up to 99, for any product/s returned by Search or Next Leg Search. The reference payload sends an identifier referencing a previous response and the offer and product identifiers. The full payload request does not reference a previous Search response. GDS only, not supported for NDC. Any CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests. To use the Flight Specific Search reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached). The Flight Specific Search response uses the same structure and returns the same objects as the Search response. The differences are, One instance of CatalogProductOffering (id o1) is returned for each offer sent in the request. One instance of ReferenceListProduct/Product is returned for each product sent in the request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers can use the Accept Header to choose whether the TripServices Flex Flight Specific Search full payload response is aggregated or streamed."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream Header Key “Accept” Value “application/stream+json”."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When customers request streamed Flex Flight Specific Search full payload responses, multiple CatalogProductOfferingsResponse are returned consecutively, each including TermsAndConditionsAir and PricingAgency with the applicable PCC."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate Header Key “Accept” Value “application/json”."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When customers request aggregated Flex Flight Specific Search full payload  responses, offers from each PCC are combined into a single CatalogProductOfferingsResponse. Each offer includes its respective TermsAndConditionsAir and PricingAgency."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References in the response have been updated to clearly distinguish offers by PCC. id = “f1o1”, “f1o2”, etc. for the first offer received, “f2o1”, “f2o2”, etc. for the second offer received, etc. Note: Customers should not assume that CatalogProductOffering “id” will follow a sequential pattern (e.g., f1, f2, f3) in aggregated Flex Search responses. Implementations must not rely on this ordering when consuming the data. CombinabilityCode = “f1j0”, “f1j1”, etc. for the first offer received, “f2j0”, “f2j1”, etc. for the second offer received, etc. ProductRef = “f1p0”, “f1p1”, etc. for the first offer received, “f2p0”, “f2p1”, etc. for the second offer received, etc. BrandRef = ”f1b0”, “f1b1”, etc. for the first offer received, “f2b0”, “f2b1”, etc. for the second offer received, etc. flightRefs = ”f1s1”, “f1s2”, etc. for the first offer received, “f2s1”, “f2s2”, etc. for the second offer received, etc. termsAndConditionsRef = ”f1T0”, “f1T1”, etc. for the first offer received, “f2T0”, “f2T1”, etc. for the second offer received, etc."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS"]}},"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS"],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/catalog/search/catalogproductofferings/buildpremiumflexoptions","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/catalog/search/catalogproductofferings/buildpremiumflexoptions","href":"searches/buildflexoptionsairsearch","openApiOperationId":"BuildFlexOptionsAirSearch","summary":"Flex Flight Specific Search (Premium)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsQueryBuildOptions","exampleIds":["paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS"]}},"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/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}},"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogProductOfferingsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/searches/buildflexoptionsairsearch"}],"panels":[]}]},"httpPath":"/air/catalog/search/catalogproductofferings/buildpremiumflexoptions"}],"content":{"contentType":"group","meta":{"name":"Searches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches","showPageActions":true},{"nodeType":"markdoc","content":"Air searches."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/search/airAvailability","summary":"Air Availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/searches/createairavailability","deprecated":false},{"title":"/air/catalog/search/catalogproductofferings","summary":"Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/searches/createairsearch","deprecated":false},{"title":"/air/catalog/search/catalogproductofferings/buildnext","summary":"Next Leg Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/searches/buildnextairsearch","deprecated":false},{"title":"/air/catalog/search/catalogproductofferings/buildoptions","summary":"Flight Specific Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/searches/buildoptionsairsearch","deprecated":false},{"title":"/air/catalog/search/catalogproductofferings/premiumflex","summary":"Flex Search (Premium)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/searches/createflexsearch","deprecated":false},{"title":"/air/catalog/search/catalogproductofferings/buildpremiumflexoptions","summary":"Flex Flight Specific Search (Premium)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/searches/buildflexoptionsairsearch","deprecated":false}]}]}]}]}},{"type":"group","label":"Pricing and Fare Rules","link":"/apis/flights/pricing-and-fare-rules","routeSlug":"/apis/flights/pricing-and-fare-rules","items":[{"label":"AirPrice Reference Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/pricing-and-fare-rules/offerbuildfromcatalogproductofferings","routeSlug":"/apis/flights/pricing-and-fare-rules/offerbuildfromcatalogproductofferings","metadata":{"seo":{"title":"AirPrice Reference Payload","description":"The AirPrice API confirms pricing on air search results. While air pricing is generally an optional but recommended step, it is required for low cost carriers and some NDC carriers. This API uses a reference payload request, which sends identifiers from the Search API response. To use the AirPrice reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OfferBuildFromCatalogProductOfferings","name":"AirPrice Reference Payload","isWebhook":false,"pointer":"/paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AirPrice Reference Payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The AirPrice API confirms pricing on air search results. While air pricing is generally an optional but recommended step, it is required for low cost carriers and some NDC carriers. This API uses a reference payload request, which sends identifiers from the Search API response. To use the AirPrice reference payload request, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached)."},{"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":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty"]}},"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty"],"pointer":"/paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/price/offers/buildfromcatalogproductofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/price/offers/buildfromcatalogproductofferings","href":"pricing-and-fare-rules/offerbuildfromcatalogproductofferings","openApiOperationId":"OfferBuildFromCatalogProductOfferings","summary":"AirPrice Reference Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number","paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing-and-fare-rules/offerbuildfromcatalogproductofferings"}],"panels":[]}]},"httpPath":"/air/price/offers/buildfromcatalogproductofferings"},{"label":"AirPrice Full Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/pricing-and-fare-rules/offerbuildfromproducts","routeSlug":"/apis/flights/pricing-and-fare-rules/offerbuildfromproducts","metadata":{"seo":{"title":"AirPrice Full Payload","description":"The AirPrice API confirms pricing on air search results. While air pricing is generally an optional but recommended step, it is required for low cost carriers and some NDC carriers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"OfferBuildFromProducts","name":"AirPrice Full Payload","isWebhook":false,"pointer":"/paths/~1air~1price~1offers~1buildfromproducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AirPrice Full Payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The AirPrice API confirms pricing on air search results. While air pricing is generally an optional but recommended step, it is required for low cost carriers and some NDC carriers."},{"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":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1price~1offers~1buildfromproducts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing"]}},"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing"],"pointer":"/paths/~1air~1price~1offers~1buildfromproducts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/price/offers/buildfromproducts","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/price/offers/buildfromproducts","href":"pricing-and-fare-rules/offerbuildfromproducts","openApiOperationId":"OfferBuildFromProducts","summary":"AirPrice Full Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier","paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1price~1offers~1buildfromproducts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing-and-fare-rules/offerbuildfromproducts"}],"panels":[]}]},"httpPath":"/air/price/offers/buildfromproducts"},{"label":"Fare Rules for Existing Reservation (after Booking)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/pricing-and-fare-rules/getrulesfromreservation","routeSlug":"/apis/flights/pricing-and-fare-rules/getrulesfromreservation","metadata":{"seo":{"title":"Fare Rules for Existing Reservation (after Booking)","description":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRulesFromReservation","name":"Fare Rules for Existing Reservation (after Booking)","isWebhook":false,"pointer":"/paths/~1air~1farerule~1farerules~1fromreservation/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fare Rules for Existing Reservation (after Booking)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."},{"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":"reservationIdentifier","in":"query","schemaId":"schema_388","description":"Reservation locator code.","required":true},{"name":"offerIDs","in":"query","schemaId":"schema_389","description":"Deprecated. Not supported in rules from reservation.","deprecated":true},{"name":"productIDs","in":"query","schemaId":"schema_390","description":"Deprecated. Not supported in rules from reservation.","deprecated":true},{"name":"flightIDs","in":"query","schemaId":"schema_391","description":"Deprecated. Not supported in rules from reservation.","deprecated":true},{"name":"fareRuleCategories","in":"query","schemaId":"schema_392","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values: AdvanceReservationTicketing (GDS only), MinimumStay (GDS only), MaximumStay (GDS only), Stopovers (GDS only), Penalties."},"children":[]}]}]}]},{"name":"fareRuleType","in":"query","schemaId":"schema_393","description":"The type of fare rules requested. Supported values: ShortText, LongText (GDS only), Structured. (For NDC, structured fare rules are supported only for Penalties. A warning message returned if no penalties are applicable to the fare).","required":true}],"pointer":"/paths/~1air~1farerule~1farerules~1fromreservation/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromreservation/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/farerule/farerules/fromreservation","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"reservationIdentifier","in":"query","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"offerIDs","in":"query","required":false,"schemaId":"schema_389"},{"name":"productIDs","in":"query","required":false,"schemaId":"schema_390"},{"name":"flightIDs","in":"query","required":false,"schemaId":"schema_391"},{"name":"fareRuleCategories","in":"query","required":false,"schemaId":"schema_392"},{"name":"fareRuleType","in":"query","required":true,"example":"Structured","schemaId":"schema_393"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/farerule/farerules/fromreservation","href":"pricing-and-fare-rules/getrulesfromreservation","openApiOperationId":"GetRulesFromReservation","summary":"Fare Rules for Existing Reservation (after Booking)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/FareRuleListResponseWrapper"}},"schemaId":"components/schemas/FareRuleListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromreservation/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FareRuleListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FareRuleListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing-and-fare-rules/getrulesfromreservation"}],"panels":[]}]},"httpPath":"/air/farerule/farerules/fromreservation"},{"label":"Fare Rules after AirPrice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/pricing-and-fare-rules/getrulesfromoffer","routeSlug":"/apis/flights/pricing-and-fare-rules/getrulesfromoffer","metadata":{"seo":{"title":"Fare Rules after AirPrice","description":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRulesFromOffer","name":"Fare Rules after AirPrice","isWebhook":false,"pointer":"/paths/~1air~1farerule~1farerules~1fromoffer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fare Rules after AirPrice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."},{"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":"offerIdentifier","in":"query","schemaId":"schema_394","description":"Identifier value from the AirPrice response in OfferListResponse/Identifier/value for the offer to return fare rules on.","required":true},{"name":"productIDs","in":"query","schemaId":"schema_390","description":"Deprecated. Not supported in rules from price.","deprecated":true},{"name":"flightIDs","in":"query","schemaId":"schema_391","description":"Deprecated. Not supported in rules from price.","deprecated":true},{"name":"fareRuleCategories","in":"query","schemaId":"schema_392","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values: AdvanceReservationTicketing (GDS only), MinimumStay (GDS only), MaximumStay (GDS only), Stopovers (GDS only), Penalties."},"children":[]}]}]}]},{"name":"fareRuleType","in":"query","schemaId":"schema_393","description":"The type of fare rules requested. Supported values: ShortText, LongText (GDS only), Structured. (For NDC, structured fare rules are supported only for Penalties. A warning message returned if no penalties are applicable to the fare).","required":true}],"pointer":"/paths/~1air~1farerule~1farerules~1fromoffer/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromoffer/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/farerule/farerules/fromoffer","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"offerIdentifier","in":"query","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_394"},{"name":"productIDs","in":"query","required":false,"schemaId":"schema_390"},{"name":"flightIDs","in":"query","required":false,"schemaId":"schema_391"},{"name":"fareRuleCategories","in":"query","required":false,"schemaId":"schema_392"},{"name":"fareRuleType","in":"query","required":true,"example":"Structured","schemaId":"schema_393"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/farerule/farerules/fromoffer","href":"pricing-and-fare-rules/getrulesfromoffer","openApiOperationId":"GetRulesFromOffer","summary":"Fare Rules after AirPrice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/FareRuleListResponseWrapper"}},"schemaId":"components/schemas/FareRuleListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromoffer/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FareRuleListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FareRuleListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing-and-fare-rules/getrulesfromoffer"}],"panels":[]}]},"httpPath":"/air/farerule/farerules/fromoffer"},{"label":"Fare Rules after AirSearch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/pricing-and-fare-rules/getrulesfromcatalogproductofferings","routeSlug":"/apis/flights/pricing-and-fare-rules/getrulesfromcatalogproductofferings","metadata":{"seo":{"title":"Fare Rules after AirSearch","description":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRulesFromCatalogProductOfferings","name":"Fare Rules after AirSearch","isWebhook":false,"pointer":"/paths/~1air~1farerule~1farerules~1fromcatalogproductofferings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fare Rules after AirSearch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."},{"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":"catalogProductOfferingsIdentifier","in":"query","schemaId":"schema_388","description":"Identifier value from the AirSearch response in CatalogProductOfferings/Identifier/value.","required":true},{"name":"catalogProductOfferingID","in":"query","schemaId":"schema_395","description":"Value from Search response in CatalogProductOffering.id for the offering to return fare rules for.","required":true},{"name":"productBrandOfferingIDs","in":"query","schemaId":"schema_396","description":"Deprecated. Not supported in rules from search.","deprecated":true},{"name":"productIDs","in":"query","schemaId":"schema_390","description":"Value from Search response in CatalogProductOffering.ProductBrandOptions.ProductBrandOffering.Product.productRef for the product to return fare rules for. Fare rules can be requested for one and only one product per request, using the productIDs query parameter. Multiple product IDs are not supported when requested after Search."},{"name":"flightIDs","in":"query","schemaId":"schema_391","description":"Not supported. Use productIDs","deprecated":true},{"name":"fareRuleCategories","in":"query","schemaId":"schema_392","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only if requesting structured fare rules. If fareRuleType=Structured and fareRuleCategories is not sent, all structured fare rules are returned. Supported values: AdvanceReservationTicketing (GDS only), MinimumStay (GDS only), MaximumStay (GDS only), Stopovers (GDS only), Penalties."},"children":[]}]}]}]},{"name":"fareRuleType","in":"query","schemaId":"schema_393","description":"The type of fare rules requested. Supported values: ShortText, LongText (GDS only), Structured. (For NDC, structured fare rules are supported only for Penalties. A warning message returned if no penalties are applicable to the fare).","required":true}],"pointer":"/paths/~1air~1farerule~1farerules~1fromcatalogproductofferings/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromcatalogproductofferings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/farerule/farerules/fromcatalogproductofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"catalogProductOfferingsIdentifier","in":"query","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"catalogProductOfferingID","in":"query","required":true,"example":"cpo_01234","schemaId":"schema_395"},{"name":"productBrandOfferingIDs","in":"query","required":false,"schemaId":"schema_396"},{"name":"productIDs","in":"query","required":false,"schemaId":"schema_390"},{"name":"flightIDs","in":"query","required":false,"schemaId":"schema_391"},{"name":"fareRuleCategories","in":"query","required":false,"schemaId":"schema_392"},{"name":"fareRuleType","in":"query","required":true,"example":"Structured","schemaId":"schema_393"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/farerule/farerules/fromcatalogproductofferings","href":"pricing-and-fare-rules/getrulesfromcatalogproductofferings","openApiOperationId":"GetRulesFromCatalogProductOfferings","summary":"Fare Rules after AirSearch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/FareRuleListResponseWrapper"}},"schemaId":"components/schemas/FareRuleListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromcatalogproductofferings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FareRuleListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FareRuleListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing-and-fare-rules/getrulesfromcatalogproductofferings"}],"panels":[]}]},"httpPath":"/air/farerule/farerules/fromcatalogproductofferings"},{"label":"Fare Rules after Fare Display","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/pricing-and-fare-rules/getfromfaredisplay","routeSlug":"/apis/flights/pricing-and-fare-rules/getfromfaredisplay","metadata":{"seo":{"title":"Fare Rules after Fare Display","description":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetFromFareDisplay","name":"Fare Rules after Fare Display","isWebhook":false,"pointer":"/paths/~1air~1farerule~1farerules~1fromfaredisplay/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fare Rules after Fare Display","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fare rules are the conditions and restrictions that apply to any booking based on its fare type. These determine the price of the fare. Generally, less expensive fares have more restrictions and more expensive fares have fewer restrictions. Fare rules can include blackout dates, advanced reservation requirements, minimum and maximum stay requirements, and cancellation and change penalties."},{"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":"fareRuleIdentifier","in":"query","schemaId":"schema_397","description":"Send the value from FareDisplayResponse.Identifier from the Fare Display response."},{"name":"fareID","in":"query","schemaId":"schema_398","description":"Send the value from fareDisplay.fare.sequence from the Fare Display response for the fare to request fare rules for.","example":"1"},{"name":"fareRuleCategories","in":"query","schemaId":"schema_392","description":"List of fare rule categories required"},{"name":"fareRuleType","in":"query","schemaId":"schema_399","description":"The type of fare rules requested. Supported values: ShortText, LongText","required":true}],"pointer":"/paths/~1air~1farerule~1farerules~1fromfaredisplay/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromfaredisplay/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/farerule/farerules/fromfaredisplay","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"fareRuleIdentifier","in":"query","required":false,"schemaId":"schema_397"},{"name":"fareID","in":"query","required":false,"example":"1","schemaId":"schema_398"},{"name":"fareRuleCategories","in":"query","required":false,"schemaId":"schema_392"},{"name":"fareRuleType","in":"query","required":true,"example":"LongText","schemaId":"schema_399"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/farerule/farerules/fromfaredisplay","href":"pricing-and-fare-rules/getfromfaredisplay","openApiOperationId":"GetFromFareDisplay","summary":"Fare Rules after Fare Display"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/FareRuleListResponseWrapper"}},"schemaId":"components/schemas/FareRuleListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1farerule~1farerules~1fromfaredisplay/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FareRuleListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FareRuleListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pricing-and-fare-rules/getfromfaredisplay"}],"panels":[]}]},"httpPath":"/air/farerule/farerules/fromfaredisplay"}],"content":{"contentType":"group","meta":{"name":"Pricing and Fare Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pricing and Fare Rules","showPageActions":true},{"nodeType":"markdoc","content":"Air pricing, fare rules, and fare display."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/price/offers/buildfromcatalogproductofferings","summary":"AirPrice Reference Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pricing-and-fare-rules/offerbuildfromcatalogproductofferings","deprecated":false},{"title":"/air/price/offers/buildfromproducts","summary":"AirPrice Full Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pricing-and-fare-rules/offerbuildfromproducts","deprecated":false},{"title":"/air/farerule/farerules/fromreservation","summary":"Fare Rules for Existing Reservation (after Booking)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricing-and-fare-rules/getrulesfromreservation","deprecated":false},{"title":"/air/farerule/farerules/fromoffer","summary":"Fare Rules after AirPrice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricing-and-fare-rules/getrulesfromoffer","deprecated":false},{"title":"/air/farerule/farerules/fromcatalogproductofferings","summary":"Fare Rules after AirSearch","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricing-and-fare-rules/getrulesfromcatalogproductofferings","deprecated":false},{"title":"/air/farerule/farerules/fromfaredisplay","summary":"Fare Rules after Fare Display","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pricing-and-fare-rules/getfromfaredisplay","deprecated":false}]}]}]}]}},{"type":"group","label":"Seats Ancillaries EMDs","link":"/apis/flights/seats-ancillaries-emds","routeSlug":"/apis/flights/seats-ancillaries-emds","items":[{"label":"Seat Map","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/createseatavailability","routeSlug":"/apis/flights/seats-ancillaries-emds/createseatavailability","metadata":{"seo":{"title":"Seat Map","description":"The Seat Map request returns seat availability for both free and paid seats. It is a reference payload that sends identifiers from a previous transaction or a booking. You can send the Seat Map request at several places in the TripServices workflow - after searching, after pricing, during booking, and after booking. The Seat Map request uses the same endpoint but a different message payload depending on where in the workflow it is sent. See the supported workflow options in the Seats Guide. All Seat Map requests allow you to request seat maps for any of the following: All flights within an offer (all flights on the itinerary). All flights within a product (all flights on one leg of an itinerary). One or more individual flights. Standalone Seat Map sends flight criteria including a booking code to return a view-only seat map. Unlike the Seat Map request, Standalone Seat Map does not send any identifiers from a previously searched or priced flight. It is instead a full payload request and can be sent entirely on its own, either within or outside of a workbench session."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateSeatAvailability","name":"Seat Map","isWebhook":false,"pointer":"/paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Seat Map","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Seat Map request returns seat availability for both free and paid seats. It is a reference payload that sends identifiers from a previous transaction or a booking. You can send the Seat Map request at several places in the TripServices workflow - after searching, after pricing, during booking, and after booking. The Seat Map request uses the same endpoint but a different message payload depending on where in the workflow it is sent. See the supported workflow options in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/seats-and-ancillaries/seats-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seats Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All Seat Map requests allow you to request seat maps for any of the following: All flights within an offer (all flights on the itinerary). All flights within a product (all flights on one leg of an itinerary). One or more individual flights. Standalone Seat Map sends flight criteria including a booking code to return a view-only seat map. Unlike the Seat Map request, Standalone Seat Map does not send any identifiers from a previously searched or priced flight. It is instead a full payload request and can be sent entirely on its own, either within or outside of a workbench session."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQuerySeatAvailability","exampleIds":["paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment"]}},"schemaId":"components/schemas/CatalogOfferingsQuerySeatAvailability","exampleIds":["paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment"],"pointer":"/paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/search/seat/catalogofferingsancillaries/seatavailabilities","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQuerySeatAvailability","exampleIds":["paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/search/seat/catalogofferingsancillaries/seatavailabilities","href":"seats-ancillaries-emds/createseatavailability","openApiOperationId":"CreateSeatAvailability","summary":"Seat Map"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogOfferingsQuerySeatAvailability","exampleIds":["paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQuerySeatAvailability","exampleIds":["paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg","paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment"]}},"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/CatalogOfferingsAncillaryListResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/createseatavailability"}],"panels":[]}]},"httpPath":"/air/search/seat/catalogofferingsancillaries/seatavailabilities"},{"label":"Ancillary Price (NDC Only)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/buildancillaryoffersfromcatalogofferings","routeSlug":"/apis/flights/seats-ancillaries-emds/buildancillaryoffersfromcatalogofferings","metadata":{"seo":{"title":"Ancillary Price (NDC Only)","description":"The Ancillary Price request confirms pricing request searches for a selected ancillary. You must first create a new or post-commit workbench and send an Ancillary Shop request. After pricing, add the selected ancillary to the workbench"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildAncillaryOffersFromCatalogOfferings","name":"Ancillary Price (NDC Only)","isWebhook":false,"pointer":"/paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ancillary Price (NDC Only)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Ancillary Price request confirms pricing request searches for a selected ancillary. You must first create a new or post-commit workbench and send an Ancillary Shop request. After pricing, add the selected ancillary to the workbench"},{"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":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price"]}},"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price"],"pointer":"/paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ancillaryprice/offers/buildancillaryoffersfromcatalogofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ancillaryprice/offers/buildancillaryoffersfromcatalogofferings","href":"seats-ancillaries-emds/buildancillaryoffersfromcatalogofferings","openApiOperationId":"BuildAncillaryOffersFromCatalogOfferings","summary":"Ancillary Price (NDC Only)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/buildancillaryoffersfromcatalogofferings"}],"panels":[]}]},"httpPath":"/air/ancillaryprice/offers/buildancillaryoffersfromcatalogofferings"},{"label":"Ancillary Shop","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/createancillarysearch","routeSlug":"/apis/flights/seats-ancillaries-emds/createancillarysearch","metadata":{"seo":{"title":"Ancillary Shop","description":"The Ancillary Shop request searches for ancillaries available for the Reservation. You must first create a new or post-commit workbench. After ancillary shop, send an ancillary price request (only for NDC), and then add the selected ancillary to the workbench."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateAncillarySearch","name":"Ancillary Shop","isWebhook":false,"pointer":"/paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ancillary Shop","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Ancillary Shop request searches for ancillaries available for the Reservation. You must first create a new or post-commit workbench. After ancillary shop, send an ancillary price request (only for NDC), and then add the selected ancillary to the workbench."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAncillaries","exampleIds":["paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_reservation"]}},"schemaId":"components/schemas/CatalogOfferingsQueryAncillaries","exampleIds":["paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_reservation"],"pointer":"/paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ancillaryshop/catalogofferingsancillaries","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAncillaries","exampleIds":["paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_reservation"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ancillaryshop/catalogofferingsancillaries","href":"seats-ancillaries-emds/createancillarysearch","openApiOperationId":"CreateAncillarySearch","summary":"Ancillary Shop"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogOfferingsQueryAncillaries","exampleIds":["paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_reservation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAncillaries","exampleIds":["paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit","paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_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/CatalogOfferingsAncillaryListResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/createancillarysearch"}],"panels":[]}]},"httpPath":"/air/ancillaryshop/catalogofferingsancillaries"},{"label":"NDC Refund Quote and Seat/Ancillary Cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/cancelworkbenchoffer","routeSlug":"/apis/flights/seats-ancillaries-emds/cancelworkbenchoffer","metadata":{"seo":{"title":"NDC Refund Quote and Seat/Ancillary Cancel","description":"The NDC Refund Quote API determines what if any refund value may be available on a ticket. It is part of the NDC cancel workflow: Create a workbench session, send Refund Quote, then send Cancel to cancel the ticket and issue any refund. For supporting NDC carriers only, you can cancel only specified segments in Refund Quote instead of the entire itinerary. In this case, the ticket value is retained at Cancel. Refund Quote is mandatory when canceling a ticket outside the void period and there is any difference between a refund due and the purchase price. If Refund Quote is not sent, and a refund is not available for the exact amount of the purchase price, Cancel returns the error message 'OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN'.The Ancillary Cancel API supports canceling baggage and/or paid seats for both GDS and NDC, and canceling non-baggage ancillaries for NDC. Canceling non-baggage ancillaries for GDS is not supported. Ancillary Cancel must be sent in a workbench session: Create a workbench, send Ancillary Cancel, and commit the workbench. You can cancel ancillaries booked in the same or a previous session. Seat and ancillary cancel support varies in the booking workflow. See the Seats Guide and Ancillary Guide for support details. Only one paid seat per workbench session can be canceled. To cancel multiple seats, send one cancel request, commit the workbench, and start a new workbench to cancel the next seat. For paid bags, you can send multiple cancel requests in a post-commit workbench session. You cannot cancel ancillaries or seats from a ticketed itinerary."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelWorkbenchOffer","name":"NDC Refund Quote and Seat/Ancillary Cancel","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NDC Refund Quote and Seat/Ancillary Cancel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The NDC Refund Quote API determines what if any refund value may be available on a ticket. It is part of the NDC cancel workflow: Create a workbench session, send Refund Quote, then send Cancel to cancel the ticket and issue any refund. For supporting NDC carriers only, you can cancel only specified segments in Refund Quote instead of the entire itinerary. In this case, the ticket value is retained at Cancel. Refund Quote is mandatory when canceling a ticket outside the void period and there is any difference between a refund due and the purchase price. If Refund Quote is not sent, and a refund is not available for the exact amount of the purchase price, Cancel returns the error message 'OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN'."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Ancillary Cancel API supports canceling baggage and/or paid seats for both GDS and NDC, and canceling non-baggage ancillaries for NDC. Canceling non-baggage ancillaries for GDS is not supported. Ancillary Cancel must be sent in a workbench session: Create a workbench, send Ancillary Cancel, and commit the workbench. You can cancel ancillaries booked in the same or a previous session. Seat and ancillary cancel support varies in the booking workflow. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/seats-and-ancillaries/seats-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seats Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/seats-and-ancillaries/ancillaries-and-emd-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for support details. Only one paid seat per workbench session can be canceled. To cancel multiple seats, send one cancel request, commit the workbench, and start a new workbench to cancel the next seat. For paid bags, you can send multiple cancel requests in a post-commit workbench session. You cannot cancel ancillaries or seats from a ticketed itinerary."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"]}},"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer","href":"seats-ancillaries-emds/cancelworkbenchoffer","openApiOperationId":"CancelWorkbenchOffer","summary":"NDC Refund Quote and Seat/Ancillary Cancel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/cancelworkbenchoffer"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer"},{"label":"Seat/Ancillary Book","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/workbenchbuildancillaryoffersfromcatalogofferings","routeSlug":"/apis/flights/seats-ancillaries-emds/workbenchbuildancillaryoffersfromcatalogofferings","metadata":{"seo":{"title":"Seat/Ancillary Book","description":"The Ancillary Book request adds a selected ancillary or a paid seat to the new or post-commit workbench.For ancillaries, first send an Ancillary Shop request and an Ancillary Price request (NDC only). After adding an ancillary to the workbench, you must also issue an EMD for the selected ancillary. See the Ancillary and EMD Guide for more details.For paid seats, you must first create a workbench and send a Seat Map request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkbenchBuildAncillaryOffersFromCatalogOfferings","name":"Seat/Ancillary Book","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Seat/Ancillary Book","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Ancillary Book request adds a selected ancillary or a paid seat to the new or post-commit workbench."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ancillaries, first send an Ancillary Shop request and an Ancillary Price request (NDC only). After adding an ancillary to the workbench, you must also issue an EMD for the selected ancillary. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/seats-and-ancillaries/ancillaries-and-emd-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary and EMD Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more details."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For paid seats, you must first create a workbench and send a Seat Map request."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book"]}},"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildancillaryoffersfromcatalogofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildancillaryoffersfromcatalogofferings","href":"seats-ancillaries-emds/workbenchbuildancillaryoffersfromcatalogofferings","openApiOperationId":"WorkbenchBuildAncillaryOffersFromCatalogOfferings","summary":"Seat/Ancillary Book"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/workbenchbuildancillaryoffersfromcatalogofferings"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildancillaryoffersfromcatalogofferings"},{"label":"EMD Retrieve","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/emdgetbylocator","routeSlug":"/apis/flights/seats-ancillaries-emds/emdgetbylocator","metadata":{"seo":{"title":"EMD Retrieve","description":"Not currently implemented."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"EMDGetByLocator","name":"EMD Retrieve","isWebhook":false,"pointer":"/paths/~1air~1emds~1getbylocator/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EMD Retrieve","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Not currently implemented."},{"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":"Locator","in":"query","schemaId":"schema_400","description":"The booking locator code used to retrieve a Reservation","required":true},{"name":"locatorType","in":"query","schemaId":"schema_401","description":"Specifies the type of reservation ID","deprecated":true},{"name":"source","in":"query","schemaId":"schema_402","description":"Specifies a unique identifier to indicate the source system which generated the resId.","deprecated":true},{"name":"sourceContext","in":"query","schemaId":"schema_403","description":"Specifies the context of the source.","deprecated":true},{"name":"otaType","in":"query","schemaId":"schema_404","description":"Used for codes in the OpenTravel Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.","deprecated":true},{"name":"creationDate","in":"query","schemaId":"schema_405","description":"PNR creation Date"}],"pointer":"/paths/~1air~1emds~1getbylocator/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1emds~1getbylocator/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/emds/getbylocator","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"Locator","in":"query","required":true,"example":"ABC123","schemaId":"schema_400"},{"name":"locatorType","in":"query","required":false,"example":"GDS","schemaId":"schema_401"},{"name":"source","in":"query","required":false,"example":"1G","schemaId":"schema_402"},{"name":"sourceContext","in":"query","required":false,"example":"GDS","schemaId":"schema_403"},{"name":"otaType","in":"query","required":false,"example":"31","schemaId":"schema_404"},{"name":"creationDate","in":"query","required":false,"schemaId":"schema_405"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/emds/getbylocator","href":"seats-ancillaries-emds/emdgetbylocator","openApiOperationId":"EMDGetByLocator","summary":"EMD Retrieve"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/EMDListResponseWrapper"}},"schemaId":"components/schemas/EMDListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1emds~1getbylocator/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EMDListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EMDListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/emdgetbylocator"}],"panels":[]}]},"httpPath":"/air/emds/getbylocator"},{"label":"EMD Display","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/getemd","routeSlug":"/apis/flights/seats-ancillaries-emds/getemd","metadata":{"seo":{"title":"EMD Display","description":"Display an EMD to retrieve EMD details such as the amount paid and agency ticketing information. EMD Display not supported for NDC. EMD details for NDC are returned in the Reservation Retrieve."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetEMD","name":"EMD Display","isWebhook":false,"pointer":"/paths/~1air~1emds~1{Identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EMD Display","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Display an EMD to retrieve EMD details such as the amount paid and agency ticketing information. EMD Display not supported for NDC. EMD details for NDC are returned in the Reservation Retrieve."},{"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_406","description":"The EMD number you wish to retrieve","required":true}],"pointer":"/paths/~1air~1emds~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1emds~1{Identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/emds/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"1253300123456","schemaId":"schema_406"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/emds/{Identifier}","href":"seats-ancillaries-emds/getemd","openApiOperationId":"GetEMD","summary":"EMD Display"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/EMDListResponseWrapper"}},"schemaId":"components/schemas/EMDListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1emds~1{Identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EMDListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EMDListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/getemd"}],"panels":[]}]},"httpPath":"/air/emds/{Identifier}"},{"label":"EMD Void","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/seats-ancillaries-emds/updateemd","routeSlug":"/apis/flights/seats-ancillaries-emds/updateemd","metadata":{"seo":{"title":"EMD Void","description":"Void an EMD to cancel it. You can also use EMD void with the GDS exchange APIs to refund an EMD back to the original FOP. See the Exchange, Refund, and Void Guide. EMD Void not supported for NDC."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateEMD","name":"EMD Void","isWebhook":false,"pointer":"/paths/~1air~1emds~1{Identifier}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EMD Void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void an EMD to cancel it. You can also use EMD void with the GDS exchange APIs to refund an EMD back to the original FOP. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/exchange-refund-and-void-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange, Refund, and Void Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". EMD Void not supported for NDC."},"children":[]}]}]}]},{"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_407","description":"The EMD number you wish to update","required":true}],"pointer":"/paths/~1air~1emds~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1emds~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/EMDQueryUpdateEMD","exampleIds":["paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void"]}},"schemaId":"components/schemas/EMDQueryUpdateEMD","exampleIds":["paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void"],"pointer":"/paths/~1air~1emds~1{Identifier}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/emds/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"1253303123456","schemaId":"schema_407"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EMDQueryUpdateEMD","exampleIds":["paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/emds/{Identifier}","href":"seats-ancillaries-emds/updateemd","openApiOperationId":"UpdateEMD","summary":"EMD Void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/EMDQueryUpdateEMD","exampleIds":["paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EMDQueryUpdateEMD","exampleIds":["paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void"]}},"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/EMDListResponseWrapper"}},"schemaId":"components/schemas/EMDListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1emds~1{Identifier}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EMDListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EMDListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/seats-ancillaries-emds/updateemd"}],"panels":[]}]},"httpPath":"/air/emds/{Identifier}"}],"content":{"contentType":"group","meta":{"name":"Seats Ancillaries EMDs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Seats Ancillaries EMDs","showPageActions":true},{"nodeType":"markdoc","content":"Seat map, book and cancel. Ancillary search, book, and cancel. EMD retrieve and void."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/search/seat/catalogofferingsancillaries/seatavailabilities","summary":"Seat Map","prefix":{"name":"post","color":"post"},"badges":[],"link":"/seats-ancillaries-emds/createseatavailability","deprecated":false},{"title":"/air/ancillaryprice/offers/buildancillaryoffersfromcatalogofferings","summary":"Ancillary Price (NDC Only)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/seats-ancillaries-emds/buildancillaryoffersfromcatalogofferings","deprecated":false},{"title":"/air/ancillaryshop/catalogofferingsancillaries","summary":"Ancillary Shop","prefix":{"name":"post","color":"post"},"badges":[],"link":"/seats-ancillaries-emds/createancillarysearch","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer","summary":"NDC Refund Quote and Seat/Ancillary Cancel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/seats-ancillaries-emds/cancelworkbenchoffer","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildancillaryoffersfromcatalogofferings","summary":"Seat/Ancillary Book","prefix":{"name":"post","color":"post"},"badges":[],"link":"/seats-ancillaries-emds/workbenchbuildancillaryoffersfromcatalogofferings","deprecated":false},{"title":"/air/emds/getbylocator","summary":"EMD Retrieve","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seats-ancillaries-emds/emdgetbylocator","deprecated":false},{"title":"/air/emds/{Identifier}","summary":"EMD Display","prefix":{"name":"get","color":"get"},"badges":[],"link":"/seats-ancillaries-emds/getemd","deprecated":false},{"title":"/air/emds/{Identifier}","summary":"EMD Void","prefix":{"name":"put","color":"put"},"badges":[],"link":"/seats-ancillaries-emds/updateemd","deprecated":false}]}]}]}]}},{"type":"group","label":"Workbench Actions","link":"/apis/flights/workbench-actions","routeSlug":"/apis/flights/workbench-actions","items":[{"label":"New Workbench","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/workbench-actions/createreservationworkbench","routeSlug":"/apis/flights/workbench-actions/createreservationworkbench","metadata":{"seo":{"title":"New Workbench","description":"Use this request to initiate a workbench for a new reservation. This prerequisite step for booking creates the workbench session in which all booking details are added together to create a PNR at commit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateReservationWorkbench","name":"New Workbench","isWebhook":false,"pointer":"/paths/~1air~1book~1session~1reservationworkbench/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"New Workbench","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this request to initiate a workbench for a new reservation. This prerequisite step for booking creates the workbench session in which all booking details are added together to create a PNR at commit."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationID","exampleIds":["paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench"]}},"schemaId":"components/schemas/ReservationID","exampleIds":["paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench"],"pointer":"/paths/~1air~1book~1session~1reservationworkbench/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/session/reservationworkbench","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationID","exampleIds":["paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/session/reservationworkbench","href":"workbench-actions/createreservationworkbench","openApiOperationId":"CreateReservationWorkbench","summary":"New Workbench"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationID","exampleIds":["paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationID","exampleIds":["paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workbench-actions/createreservationworkbench"}],"panels":[]}]},"httpPath":"/air/book/session/reservationworkbench"},{"label":"Post Commit Workbench","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/workbench-actions/createreservationworkbenchfromlocator","routeSlug":"/apis/flights/workbench-actions/createreservationworkbenchfromlocator","metadata":{"seo":{"title":"Post Commit Workbench","description":"Initiate a post-commit workbench to create a session for ticketing or updating an existing reservation. This is a prerequisite step for any workbench session to modify, update, or ticket a reservation.Post-Commit Workbench returns air, hotel, and/or car segments for any reservation that includes that content, called a multi-content booking. All segments must have been booked with the TripServices Flights APIs, TripServices Stays APIs, TripServices Car APIs (release pending), or a Travelport+ terminal program. You can add either GDS or NDC air offers to a hotel and/or car booking, but not both. See the Multi-content Booking Guide (Air, Hotel, Car) for workflows and examples."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateReservationWorkbenchFromLocator","name":"Post Commit Workbench","isWebhook":false,"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post Commit Workbench","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate a post-commit workbench to create a session for ticketing or updating an existing reservation. This is a prerequisite step for any workbench session to modify, update, or ticket a reservation."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post-Commit Workbench returns air, hotel, and/or car segments for any reservation that includes that content, called a multi-content booking. All segments must have been booked with the TripServices Flights APIs, TripServices Stays APIs, TripServices Car APIs (release pending), or a Travelport+ terminal program. You can add either GDS or NDC air offers to a hotel and/or car booking, but not both. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/multi-content-booking-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-content Booking Guide (Air, Hotel, Car)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for workflows and examples."},"children":[]}]}]}]},{"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":"Locator","in":"query","schemaId":"schema_400","description":"The booking locator code used to retrieve a Reservation"},{"name":"source","in":"query","schemaId":"schema_408","description":"Specifies a unique identifier to indicate the source system which generated the resId."},{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, ReservationDetail will be returned"},{"name":"viewBrandCompleteInfoInd","in":"query","schemaId":"schema_409","description":"If true, Brand complete information will be returned in Reservation Response"},{"name":"viewBaggageDetailInd","in":"query","schemaId":"schema_409","description":"if true, full baggage information will be returned in Reservation Response"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/session/reservationworkbench/buildfromlocator","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"Locator","in":"query","required":false,"example":"ABC123","schemaId":"schema_400"},{"name":"source","in":"query","required":false,"schemaId":"schema_408"},{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBrandCompleteInfoInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBaggageDetailInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/session/reservationworkbench/buildfromlocator","href":"workbench-actions/createreservationworkbenchfromlocator","openApiOperationId":"CreateReservationWorkbenchFromLocator","summary":"Post Commit Workbench"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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":"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workbench-actions/createreservationworkbenchfromlocator"}],"panels":[]}]},"httpPath":"/air/book/session/reservationworkbench/buildfromlocator"},{"label":"Cancel Workbench Items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/workbench-actions/cancelworkbenchitems","routeSlug":"/apis/flights/workbench-actions/cancelworkbenchitems","metadata":{"seo":{"title":"Cancel Workbench Items","description":"Cancel one or more offers or unpriced segments within the workbench. Offer types including air, hotel, vehicle. Ancillaries associated to air segments will by default cancel when the air segment is cancelled. Some restrictions on NDC and non-GDS hotel content apply."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelWorkbenchItems","name":"Cancel Workbench Items","isWebhook":false,"pointer":"/paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Workbench Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel one or more offers or unpriced segments within the workbench. Offer types including air, hotel, vehicle. Ancillaries associated to air segments will by default cancel when the air segment is cancelled. Some restrictions on NDC and non-GDS hotel content apply."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Workbench Identifier you are actively working in","required":true}],"pointer":"/paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelRequest","exampleIds":["paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment"]}},"schemaId":"components/schemas/CancelRequest","exampleIds":["paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment"],"pointer":"/paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/book/reservationworkbench/{ReservationResource_Identifier}/reservations/cancelitems","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelRequest","exampleIds":["paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/book/reservationworkbench/{ReservationResource_Identifier}/reservations/cancelitems","href":"workbench-actions/cancelworkbenchitems","openApiOperationId":"CancelWorkbenchItems","summary":"Cancel Workbench Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CancelRequest","exampleIds":["paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelRequest","exampleIds":["paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments","paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workbench-actions/cancelworkbenchitems"}],"panels":[]}]},"httpPath":"/book/reservationworkbench/{ReservationResource_Identifier}/reservations/cancelitems"},{"label":"Retrieve Workbench.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/workbench-actions/retrievereservationworkbench","routeSlug":"/apis/flights/workbench-actions/retrievereservationworkbench","metadata":{"seo":{"title":"Retrieve Workbench.","description":"At any point in the booking session, you can retrieve the workbench. The response returns all details added to the workbench at that point."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveReservationWorkbench","name":"Retrieve Workbench.","isWebhook":false,"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Workbench.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"At any point in the booking session, you can retrieve the workbench. The response returns all details added to the workbench at that 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":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Workbench Identifier of the Reservation Workbench you are actively working on","required":true}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, ReservationDetail will be returned."},{"name":"viewBrandCompleteInfoInd","in":"query","schemaId":"schema_409","description":"If true, Brand complete information will be returned in Reservation Response"},{"name":"viewBaggageDetailInd","in":"query","schemaId":"schema_409","description":"if true, full baggage information will be returned in Reservation Response"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/book/session/reservationworkbench/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBrandCompleteInfoInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBaggageDetailInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/session/reservationworkbench/{Identifier}","href":"workbench-actions/retrievereservationworkbench","openApiOperationId":"RetrieveReservationWorkbench","summary":"Retrieve Workbench."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workbench-actions/retrievereservationworkbench"}],"panels":[]}]},"httpPath":"/air/book/session/reservationworkbench/{Identifier}"},{"label":"Discard Workbench","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/workbench-actions/ignorereservationworkbench","routeSlug":"/apis/flights/workbench-actions/ignorereservationworkbench","metadata":{"seo":{"title":"Discard Workbench","description":"At any point in a booking or ticketing workflow, if necessary, you can discard the workbench and any information in it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"IgnoreReservationWorkbench","name":"Discard Workbench","isWebhook":false,"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Discard Workbench","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"At any point in a booking or ticketing workflow, if necessary, you can discard the workbench and any information in it."},{"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_388","description":"The Reservation Workbench Identifier of the Reservation Workbench you are actively working on","required":true}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/book/session/reservationworkbench/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/book/session/reservationworkbench/{Identifier}","href":"workbench-actions/ignorereservationworkbench","openApiOperationId":"IgnoreReservationWorkbench","summary":"Discard Workbench"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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"},{"code":"204","description":" No Content - 204"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1{Identifier}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workbench-actions/ignorereservationworkbench"}],"panels":[]}]},"httpPath":"/air/book/session/reservationworkbench/{Identifier}"},{"label":"Workbench Commit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/workbench-actions/commitreservation","routeSlug":"/apis/flights/workbench-actions/commitreservation","metadata":{"seo":{"title":"Workbench Commit","description":"After all required and any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the workbench. The resulting actions depend on whether payment is present in the workbench. If no Add Payment request has been sent, committing the workbench books the itinerary and generates a PNR. If an Add Payment request has not been sent, committing the workbench tickets the itinerary and generates ticket number/s."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CommitReservation","name":"Workbench Commit","isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workbench Commit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"After all required and any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the workbench. The resulting actions depend on whether payment is present in the workbench.  \nIf no Add Payment request has been sent, committing the workbench books the itinerary and generates a PNR.  \nIf an Add Payment request has not been sent, committing the workbench tickets the itinerary and generates ticket number/s."},{"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_388","description":"The ReservationWorkbenchIdentifier you wish to commit","required":true}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"autoDeleteDate","in":"query","schemaId":"schema_405","description":"Acts as a retention segment to hold the reservation open past the last date of travel purge date. Sending a new autoDeleteDate at commit step will update the existing autoDeleteDate. Sending 000/00/00 will delete an existing autoDeleteDate."},{"name":"Issuance","in":"query","schemaId":"schema_410","description":"Indicates the type of issuance that should be performed at commit. (Ticket, BackOffice (MIR/TAIR))"},{"name":"DocumentValue","in":"query","schemaId":"schema_411","description":"Indicates of the value of the document should be refunded or retained following a CancelOffer action"},{"name":"payLaterInd","in":"query","schemaId":"schema_409","description":"If true, the Reservation will be fulfilled at a later date"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/reservation/reservations/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"autoDeleteDate","in":"query","required":false,"schemaId":"schema_405"},{"name":"Issuance","in":"query","required":false,"schemaId":"schema_410"},{"name":"DocumentValue","in":"query","required":false,"schemaId":"schema_411"},{"name":"payLaterInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/{Identifier}","href":"workbench-actions/commitreservation","openApiOperationId":"CommitReservation","summary":"Workbench Commit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/workbench-actions/commitreservation"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/{Identifier}"}],"content":{"contentType":"group","meta":{"name":"Workbench Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workbench Actions","showPageActions":true},{"nodeType":"markdoc","content":"Create, manage, and commit workbench sessions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/session/reservationworkbench","summary":"New Workbench","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workbench-actions/createreservationworkbench","deprecated":false},{"title":"/air/book/session/reservationworkbench/buildfromlocator","summary":"Post Commit Workbench","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workbench-actions/createreservationworkbenchfromlocator","deprecated":false},{"title":"/book/reservationworkbench/{ReservationResource_Identifier}/reservations/cancelitems","summary":"Cancel Workbench Items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workbench-actions/cancelworkbenchitems","deprecated":false},{"title":"/air/book/session/reservationworkbench/{Identifier}","summary":"Retrieve Workbench.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workbench-actions/retrievereservationworkbench","deprecated":false},{"title":"/air/book/session/reservationworkbench/{Identifier}","summary":"Discard Workbench","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/workbench-actions/ignorereservationworkbench","deprecated":false},{"title":"/air/book/reservation/reservations/{Identifier}","summary":"Workbench Commit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/workbench-actions/commitreservation","deprecated":false}]}]}]}]}},{"type":"group","label":"Booking","link":"/apis/flights/booking","routeSlug":"/apis/flights/booking","items":[{"label":"Host Profile Move","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/clientprofilemove","routeSlug":"/apis/flights/booking/clientprofilemove","metadata":{"seo":{"title":"Host Profile Move","description":"Functionality to move client profile information into the Reservation workbench. Release"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ClientProfileMove","name":"Host Profile Move","isWebhook":false,"pointer":"/paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Host Profile Move","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Functionality to move client profile information into the Reservation workbench. Release"},{"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_388","description":"The ReservationWorkbench Identifier you wish to move the client profile to","required":true}],"pointer":"/paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryClientProfileMove","exampleIds":["paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers"]}},"schemaId":"components/schemas/ReservationQueryClientProfileMove","exampleIds":["paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers"],"pointer":"/paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/book/profile/reservationworkbench/{identifier}/clientprofile","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryClientProfileMove","exampleIds":["paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers"]}},"responseCodes":["204","400","401","402","403","404","500","503"],"pointer":"/air/book/profile/reservationworkbench/{identifier}/clientprofile","href":"booking/clientprofilemove","openApiOperationId":"ClientProfileMove","summary":"Host Profile Move"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryClientProfileMove","exampleIds":["paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryClientProfileMove","exampleIds":["paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile","paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content - Success."},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/clientprofilemove"}],"panels":[]}]},"httpPath":"/air/book/profile/reservationworkbench/{identifier}/clientprofile"},{"label":"Add Offer Reference Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/workbenchbuildfromcatalogproductofferings","routeSlug":"/apis/flights/booking/workbenchbuildfromcatalogproductofferings","metadata":{"seo":{"title":"Add Offer Reference Payload","description":"Use the Add Offer reference payload request to add an offer to the reservation workbench as part of the booking workflow. The reference payload request sends identifiers from the Search response instead of full itinerary details.NDC supports only the reference payload. For GDS, you can send either a reference payload or a full payload.To use the Add Offer reference payload request following a search request, your initial Search request must send 'offersPerPage' to invoke caching if that Search was journey-based (leg-based search results are always cached). If you add the offer after a price request, you can send the transaction identifier from the AirPrice response."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkbenchBuildFromCatalogProductOfferings","name":"Add Offer Reference Payload","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Offer Reference Payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Add Offer reference payload request to add an offer to the reservation workbench as part of the booking workflow. The reference payload request sends identifiers from the Search response instead of full itinerary details."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC supports only the reference payload. For GDS, you can send either a reference payload or a full payload."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the Add Offer reference payload request following a search request, your initial Search request must send 'offersPerPage' to invoke caching if that Search was journey-based (leg-based search results are always cached). If you add the offer after a price request, you can send the transaction identifier from the AirPrice response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Multiple Offers (GDS only; not supported for NDC):   In either the initial booking workflow, or for an existing reservation, you can send one or more Add Offer requests to add multiple GDS air offers in a single booking. While there is no specific limit on the number of offers that can be combined, a reservation cannot have more than 16 flight segments."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also supported in the Add Offer full payload request. Your PCC must be provisioned for multi-offers; contact your Travelport representative if necessary. See Multi-offer Bookings in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/flights-booking-guide#multi-offer-bookings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flights Booking Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use Add Offer to add a GDS air offer to an existing reservation that has hotel and/or car offers. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/multi-content-booking-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-Content Booking Guide (Air, Car, Hotel)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for workflow details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add offer to expired booking:"},"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":"For GDS only: use this Add Offer reference payload request or the full payload request to add an offer to an existing reservation, such as when the previously added offer has expired and can no longer be booked."},"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":"For NDC, use the NDC-specific "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/apis/flights/ndc-modify-cancel-exchange/workbenchndcbuildfromcatalogofferings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone Reprice API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead to add an offer to an expired booking.)"},"children":[]}]}]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer"]}},"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogproductofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogproductofferings","href":"booking/workbenchbuildfromcatalogproductofferings","openApiOperationId":"WorkbenchBuildFromCatalogProductOfferings","summary":"Add Offer Reference Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/workbenchbuildfromcatalogproductofferings"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogproductofferings"},{"label":"Add Offer Full Payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/workbenchbuildfromproducts","routeSlug":"/apis/flights/booking/workbenchbuildfromproducts","metadata":{"seo":{"title":"Add Offer Full Payload","description":"Full payload is not supported for NDC; use the reference payload instead. For GDS, you can send either a reference payload or a full payload.Use the Add Offer full payload request to add an offer to the reservation workbench as part of the booking workflow. The full payload request sends full itinerary details instead of identifiers from the Search response as in the reference payload request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkbenchBuildFromProducts","name":"Add Offer Full Payload","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Offer Full Payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full payload is not supported for NDC; use the reference payload instead. For GDS, you can send either a reference payload or a full payload."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Add Offer full payload request to add an offer to the reservation workbench as part of the booking workflow. The full payload request sends full itinerary details instead of identifiers from the Search response as in the reference payload request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add Multiple Offers (GDS only; not supported for NDC):   You can repeat the Add Offer request as needed to combine multiple offers into one reservation, either in the initial booking workflow or for an existing reservation. While there is no limit on the number of offers that can be combined, a reservation cannot have more than 16 flight segments. Also supported in the Add Offer reference payload request. Your PCC must be provisioned for multi-offers; contact your Travelport representative if necessary."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add offer to expired booking (GDS only; not supported for NDC):   You can use this or the reference payload request to add an offer to an existing reservation, such as when the previously added offer has expired and can no longer be booked. Start with a post-commit workbench."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pricing modifiers and brand information:   The full payload request supports optional pricing modifiers and/or brand information. You must send these modifiers during the initial booking workbench session - you cannot add them later."},"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":"Pricing modifiers:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no pricing modifier is sent, the auto stored fare is added to the reservation. If a requested modifier does not have any fares associated with it, the Add Offer step returns a successful response but the Commit step will fail and return the error message No Fare Found."},"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":"Brand information:"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can store fares with brand information at either or both the offer or segment level."},"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":"To store brand information at the offer level, send PricingModifiersAir/Brand/tier with any valid brand tier value."},"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":"To store brand information at the segment level, send the brand tier with the flight segment in ProductCriteriaAir/SpecificFlightCriteria/brandtier. You can send brandTier for any or all segments."},"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":"There is no change in the response when brand information is requested. Brand details are returned after booking in the Reservation Retrieve."},"children":[]}]}]}]}]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment"]}},"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromproducts","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromproducts","href":"booking/workbenchbuildfromproducts","openApiOperationId":"WorkbenchBuildFromProducts","summary":"Add Offer Full Payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromProducts","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/workbenchbuildfromproducts"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromproducts"},{"label":"Auto Price/ Manual Fare","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/buildfromunpricedsegments","routeSlug":"/apis/flights/booking/buildfromunpricedsegments","metadata":{"seo":{"title":"Auto Price/ Manual Fare","description":"Auto Price/ Manual Fare"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildFromUnpricedSegments","name":"Auto Price/ Manual Fare","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auto Price/ Manual Fare","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The reservation workbench identifier you wish to add the offer to.","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromUnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare"]}},"schemaId":"components/schemas/OfferQueryBuildFromUnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromunpricedsegments","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromUnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromunpricedsegments","href":"booking/buildfromunpricedsegments","openApiOperationId":"BuildFromUnpricedSegments","summary":"Auto Price/ Manual Fare"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromUnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromUnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/buildfromunpricedsegments"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromunpricedsegments"},{"label":"Unpriced Segment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/addunpricedsegments","routeSlug":"/apis/flights/booking/addunpricedsegments","metadata":{"seo":{"title":"Unpriced Segment","description":"Use the Unpriced Segment API in either the booking or post-booking workflow to add an unpriced segment to the workbench. You can send the Unpriced Segment request instead of the Add Offer API in the booking workflow. Or, to add both an unpriced segment and an offer, you can send both Unpriced Segment and Add Offer. Unpriced Segment adds flight/s as unpriced segments instead of as an offer, which is by definition priced.Unpriced segments can be priced using the offers/buildfromunpricedsegments API. GDS content only. NDC does not support unpriced segments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddUnpricedSegments","name":"Unpriced Segment","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpriced Segment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the Unpriced Segment API in either the booking or post-booking workflow to add an unpriced segment to the workbench. You can send the Unpriced Segment request instead of the Add Offer API in the booking workflow. Or, to add both an unpriced segment and an offer, you can send both Unpriced Segment and Add Offer. Unpriced Segment adds flight/s as unpriced segments instead of as an offer, which is by definition priced.Unpriced segments can be priced using the offers/buildfromunpricedsegments API. GDS content only. NDC does not support unpriced segments."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_412","description":"The reservation workbench identifier to add unpriced segments to.","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment"]}},"schemaId":"components/schemas/UnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_412"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments","href":"booking/addunpricedsegments","openApiOperationId":"AddUnpricedSegments","summary":"Unpriced Segment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/UnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnpricedSegments","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment"]}},"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/UnpricedSegmentsResponseWrapper"}},"schemaId":"components/schemas/UnpricedSegmentsResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UnpricedSegmentsResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnpricedSegmentsResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/addunpricedsegments"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments"},{"label":"Add Auxiliary Segments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/addauxiliarysegments","routeSlug":"/apis/flights/booking/addauxiliarysegments","metadata":{"seo":{"title":"Add Auxiliary Segments","description":"Add Auxiliary Segments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddAuxiliarySegments","name":"Add Auxiliary Segments","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1customauxiliarysegments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Auxiliary Segments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_412","description":"The reservation workbench identifier to add unpriced segments to.","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1customauxiliarysegments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1customauxiliarysegments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomAuxiliarySegmentRequest"}},"schemaId":"components/schemas/CustomAuxiliarySegmentRequest","pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1customauxiliarysegments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/customauxiliarysegments","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"382c74c3-721d-4f34-80e5-57657b6cbc27","schemaId":"schema_412"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomAuxiliarySegmentRequest"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/customauxiliarysegments","href":"booking/addauxiliarysegments","openApiOperationId":"AddAuxiliarySegments","summary":"Add Auxiliary Segments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CustomAuxiliarySegmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomAuxiliarySegmentRequest"}},"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/CustomAuxiliarySegmentResponseWrapper"}},"schemaId":"components/schemas/CustomAuxiliarySegmentResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1customauxiliarysegments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomAuxiliarySegmentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomAuxiliarySegmentResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/addauxiliarysegments"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/customauxiliarysegments"},{"label":"Add Multiple Travelers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/addtravelers","routeSlug":"/apis/flights/booking/addtravelers","metadata":{"seo":{"title":"Add Multiple Travelers","description":"Send the Add Traveler request to add multiple travelers to the reservation workbench. Traveler information can include traveler name and contact details. Traveler information can include traveler name and contact details, add traveler-specific remarks including certain SSRs and travel documents such as a passport.Use air/book/traveler/reservationworkbench/{workbenchID}/travelers when adding exactly one traveler."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddTravelers","name":"Add Multiple Travelers","isWebhook":false,"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Multiple Travelers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the Add Traveler request to add multiple travelers to the reservation workbench. Traveler information can include traveler name and contact details. Traveler information can include traveler name and contact details, add traveler-specific remarks including certain SSRs and travel documents such as a passport."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use air/book/traveler/reservationworkbench/{workbenchID}/travelers when adding exactly one traveler."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier that you wish to add Travelers to","required":true}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerListRequest","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail"]}},"schemaId":"components/schemas/TravelerListRequest","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail"],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/list","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelerListRequest","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail"]}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/list","href":"booking/addtravelers","openApiOperationId":"AddTravelers","summary":"Add Multiple Travelers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelerListRequest","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerListRequest","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerListResponseWrapper"}},"schemaId":"components/schemas/TravelerListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelerListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/addtravelers"}],"panels":[]}]},"httpPath":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/list"},{"label":"Add Single Traveler","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/booking/addtraveler","routeSlug":"/apis/flights/booking/addtraveler","metadata":{"seo":{"title":"Add Single Traveler","description":"Send the Add Traveler request to add a single traveler to the reservation workbench. Traveler information can include traveler name and contact details, add traveler-specific remarks including certain SSRs and travel documents such as a passport.Add each traveler to the same workbench with separate POST requests.Alternatively, use air/book/traveler/reservationworkbench/{workbenchID}/travelers/list when adding multiple travelers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddTraveler","name":"Add Single Traveler","isWebhook":false,"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Single Traveler","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the Add Traveler request to add a single traveler to the reservation workbench. Traveler information can include traveler name and contact details, add traveler-specific remarks including certain SSRs and travel documents such as a passport."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add each traveler to the same workbench with separate POST requests."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, use air/book/traveler/reservationworkbench/{workbenchID}/travelers/list when adding multiple travelers."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the Traveler information to","required":true}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Traveler","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_ID"]}},"schemaId":"components/schemas/Traveler","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_ID"],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Traveler","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_ID"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers","href":"booking/addtraveler","openApiOperationId":"AddTraveler","summary":"Add Single Traveler"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/Traveler","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_ID"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Traveler","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_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/TravelerResponseWrapper"}},"schemaId":"components/schemas/TravelerResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelerResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/booking/addtraveler"}],"panels":[]}]},"httpPath":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers"}],"content":{"contentType":"group","meta":{"name":"Booking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Booking","showPageActions":true},{"nodeType":"markdoc","content":"Reference and full payload booking workflows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/profile/reservationworkbench/{identifier}/clientprofile","summary":"Host Profile Move","prefix":{"name":"put","color":"put"},"badges":[],"link":"/booking/clientprofilemove","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogproductofferings","summary":"Add Offer Reference Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/workbenchbuildfromcatalogproductofferings","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromproducts","summary":"Add Offer Full Payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/workbenchbuildfromproducts","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromunpricedsegments","summary":"Auto Price/ Manual Fare","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/buildfromunpricedsegments","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments","summary":"Unpriced Segment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/addunpricedsegments","deprecated":false},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/customauxiliarysegments","summary":"Add Auxiliary Segments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/addauxiliarysegments","deprecated":false},{"title":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/list","summary":"Add Multiple Travelers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/addtravelers","deprecated":false},{"title":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers","summary":"Add Single Traveler","prefix":{"name":"post","color":"post"},"badges":[],"link":"/booking/addtraveler","deprecated":false}]}]}]}]}},{"type":"group","label":"Remarks and Special Service Requests","link":"/apis/flights/remarks-and-special-service-requests","routeSlug":"/apis/flights/remarks-and-special-service-requests","items":[{"label":"Document Override Remarks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/createdocumentoverrides","routeSlug":"/apis/flights/remarks-and-special-service-requests/createdocumentoverrides","metadata":{"seo":{"title":"Document Override Remarks","description":"Use document override to send remarks such as tour code, commission, or endorsements/restrictions.Document override remarks are returned in the PNR retrieve only when the detailViewInd query parameter is set to true. Document override remarks can be added to an existing PNR but cannot be modified or deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateDocumentOverrides","name":"Document Override Remarks","isWebhook":false,"pointer":"/paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document Override Remarks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use document override to send remarks such as tour code, commission, or endorsements/restrictions.Document override remarks are returned in the PNR retrieve only when the detailViewInd query parameter is set to true. Document override remarks can be added to an existing PNR but cannot be modified or deleted."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add document overrides","required":true}],"pointer":"/paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentOverrides","exampleIds":["paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd"]}},"schemaId":"components/schemas/DocumentOverrides","exampleIds":["paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd"],"pointer":"/paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/documentoverride/Reservation/{ReservationResource_Identifier}/documentoverrides","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentOverrides","exampleIds":["paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/documentoverride/Reservation/{ReservationResource_Identifier}/documentoverrides","href":"remarks-and-special-service-requests/createdocumentoverrides","openApiOperationId":"CreateDocumentOverrides","summary":"Document Override Remarks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/DocumentOverrides","exampleIds":["paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentOverrides","exampleIds":["paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator","paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd"]}},"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/DocumentOverridesResponseWrapper"}},"schemaId":"components/schemas/DocumentOverridesResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentOverridesResponseWrapper"}},"schemaId":"components/schemas/DocumentOverridesResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentOverridesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentOverridesResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/DocumentOverridesResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentOverridesResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/createdocumentoverrides"}],"panels":[]}]},"httpPath":"/air/book/documentoverride/Reservation/{ReservationResource_Identifier}/documentoverrides"},{"label":"Accounting Remarks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/createaccounting","routeSlug":"/apis/flights/remarks-and-special-service-requests/createaccounting","metadata":{"seo":{"title":"Accounting Remarks","description":"Accounting remarks are optional remarks that are added to the PNR and typically used by an agency's back office system in some way. The remarks can include ticket numbers, customer or account numbers, fares offered to the customer but refused, and canned remarks that document fare rules. Accounting remarks replace the back office accounting remarks in AirReservation prior to version 11."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateAccounting","name":"Accounting Remarks","isWebhook":false,"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Remarks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Accounting remarks are optional remarks that are added to the PNR and typically used by an agency's back office system in some way. The remarks can include ticket numbers, customer or account numbers, fares offered to the customer but refused, and canned remarks that document fare rules. Accounting remarks replace the back office accounting remarks in AirReservation prior to version 11."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add accounting information","required":true}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Accounting","exampleIds":["paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks"]}},"schemaId":"components/schemas/Accounting","exampleIds":["paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks"],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Accounting","exampleIds":["paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings","href":"remarks-and-special-service-requests/createaccounting","openApiOperationId":"CreateAccounting","summary":"Accounting Remarks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/Accounting","exampleIds":["paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Accounting","exampleIds":["paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve","paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks"]}},"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/AccountingResponseWrapper"}},"schemaId":"components/schemas/AccountingResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingResponseWrapper"}},"schemaId":"components/schemas/AccountingResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/AccountingResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/createaccounting"}],"panels":[]}]},"httpPath":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings"},{"label":"Delete Accounting Remarks","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/deleteaccounting","routeSlug":"/apis/flights/remarks-and-special-service-requests/deleteaccounting","metadata":{"seo":{"title":"Delete Accounting Remarks","description":"Delete Accounting Remarks"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAccounting","name":"Delete Accounting Remarks","isWebhook":false,"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings~1{id}~1namevaluepairs/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Accounting Remarks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete accounting information from","required":true},{"name":"id","in":"path","schemaId":"schema_413","description":"The Accounting item id to be deleted","required":true}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings~1{id}~1namevaluepairs/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"NameValuePairIds","in":"query","schemaId":"schema_414","description":"Comma separated list of nameValuePair IDs"}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings~1{id}~1namevaluepairs/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings~1{id}~1namevaluepairs/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings/{id}/namevaluepairs","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"accounting_123","schemaId":"schema_413"}],"query":[{"name":"NameValuePairIds","in":"query","required":false,"example":"1 ,2, 3","schemaId":"schema_414"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings/{id}/namevaluepairs","href":"remarks-and-special-service-requests/deleteaccounting","openApiOperationId":"DeleteAccounting","summary":"Delete Accounting Remarks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings~1{id}~1namevaluepairs/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/deleteaccounting"}],"panels":[]}]},"httpPath":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings/{id}/namevaluepairs"},{"label":"Reservation Comments (general, Itinerary, and OSI Remarks)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/addreservationcomments","routeSlug":"/apis/flights/remarks-and-special-service-requests/addreservationcomments","metadata":{"seo":{"title":"Reservation Comments (general, Itinerary, and OSI Remarks)","description":"Reservation Comments (general, Itinerary, and OSI Remarks)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddReservationComments","name":"Reservation Comments (general, Itinerary, and OSI Remarks)","isWebhook":false,"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reservation Comments (general, Itinerary, and OSI Remarks)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the Reservation Comments to","required":true}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationCommentListRequest","exampleIds":["paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks"]}},"schemaId":"components/schemas/ReservationCommentListRequest","exampleIds":["paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks"],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/list","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationCommentListRequest","exampleIds":["paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/list","href":"remarks-and-special-service-requests/addreservationcomments","openApiOperationId":"AddReservationComments","summary":"Reservation Comments (general, Itinerary, and OSI Remarks)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationCommentListRequest","exampleIds":["paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationCommentListRequest","exampleIds":["paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks","paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks"]}},"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/ReservationCommentListResponseWrapper"}},"schemaId":"components/schemas/ReservationCommentListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationCommentListResponseWrapper"}},"schemaId":"components/schemas/ReservationCommentListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReservationCommentListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationCommentListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/ReservationCommentListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReservationCommentListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/addreservationcomments"}],"panels":[]}]},"httpPath":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/list"},{"label":"Delete Reservation Comments","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/deletereservationcomments","routeSlug":"/apis/flights/remarks-and-special-service-requests/deletereservationcomments","metadata":{"seo":{"title":"Delete Reservation Comments","description":"Delete Reservation Comments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteReservationComments","name":"Delete Reservation Comments","isWebhook":false,"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1{id}~1comments/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Reservation Comments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete the Reservation Comments","required":true},{"name":"id","in":"path","schemaId":"schema_415","description":"The Reservation Comment ID to be deleted.","required":true}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1{id}~1comments/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"CommentIds","in":"query","schemaId":"schema_416","description":"Comma separated list of comments IDs"}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1{id}~1comments/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1{id}~1comments/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/{id}/comments","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"reservationcomment_123","schemaId":"schema_415"}],"query":[{"name":"CommentIds","in":"query","required":false,"example":"1, 2, 3","schemaId":"schema_416"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/{id}/comments","href":"remarks-and-special-service-requests/deletereservationcomments","openApiOperationId":"DeleteReservationComments","summary":"Delete Reservation Comments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1{id}~1comments/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/deletereservationcomments"}],"panels":[]}]},"httpPath":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/{id}/comments"},{"label":"Special Service List Requests","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/addspecialservices","routeSlug":"/apis/flights/remarks-and-special-service-requests/addspecialservices","metadata":{"seo":{"title":"Special Service List Requests","description":"Special Service List Requests"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddSpecialServices","name":"Special Service List Requests","isWebhook":false,"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Special Service List Requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the special service to","required":true}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SpecialServiceListRequest","exampleIds":["paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level"]}},"schemaId":"components/schemas/SpecialServiceListRequest","exampleIds":["paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level"],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/list","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SpecialServiceListRequest","exampleIds":["paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level"]}},"responseCodes":["200","201","204","400","401","402","403","404","500","503"],"pointer":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/list","href":"remarks-and-special-service-requests/addspecialservices","openApiOperationId":"AddSpecialServices","summary":"Special Service List Requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/SpecialServiceListRequest","exampleIds":["paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SpecialServiceListRequest","exampleIds":["paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level","paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level"]}},"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/SpecialServiceListResponseWrapper"}},"schemaId":"components/schemas/SpecialServiceListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialServiceListResponseWrapper"}},"schemaId":"components/schemas/SpecialServiceListResponseWrapper"},{"code":"204","description":"No Content - 204"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpecialServiceListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialServiceListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/SpecialServiceListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialServiceListResponseWrapper"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/addspecialservices"}],"panels":[]}]},"httpPath":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/list"},{"label":"Delete a Special Service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/deletespecialservices","routeSlug":"/apis/flights/remarks-and-special-service-requests/deletespecialservices","metadata":{"seo":{"title":"Delete a Special Service","description":"Delete a Special Service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSpecialServices","name":"Delete a Special Service","isWebhook":false,"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Special Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete the special service.","required":true},{"name":"id","in":"path","schemaId":"schema_417","description":"The Special Service Id","required":true}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/{id}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"specialservice_123","schemaId":"schema_417"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/{id}","href":"remarks-and-special-service-requests/deletespecialservices","openApiOperationId":"DeleteSpecialServices","summary":"Delete a Special Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/deletespecialservices"}],"panels":[]}]},"httpPath":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/{id}"},{"label":"Delete Multiple Special Services","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/deletemultiplespecialservices","routeSlug":"/apis/flights/remarks-and-special-service-requests/deletemultiplespecialservices","metadata":{"seo":{"title":"Delete Multiple Special Services","description":"Delete Multiple Special Services"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteMultipleSpecialServices","name":"Delete Multiple Special Services","isWebhook":false,"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1deletemultiple/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Multiple Special Services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to update the special service.","required":true}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1deletemultiple/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1deletemultiple/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SpecialServiceQueryDeleteMultiple"}},"schemaId":"components/schemas/SpecialServiceQueryDeleteMultiple","pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1deletemultiple/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/deletemultiple","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SpecialServiceQueryDeleteMultiple"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/deletemultiple","href":"remarks-and-special-service-requests/deletemultiplespecialservices","openApiOperationId":"DeleteMultipleSpecialServices","summary":"Delete Multiple Special Services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/SpecialServiceQueryDeleteMultiple","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SpecialServiceQueryDeleteMultiple"}},"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/SpecialServiceListResponseWrapper"}},"schemaId":"components/schemas/SpecialServiceListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1deletemultiple/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpecialServiceListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialServiceListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/deletemultiplespecialservices"}],"panels":[]}]},"httpPath":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/deletemultiple"},{"label":"Add Primary Contact Remark (SSR CTC)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/addprimarycontact","routeSlug":"/apis/flights/remarks-and-special-service-requests/addprimarycontact","metadata":{"seo":{"title":"Add Primary Contact Remark (SSR CTC)","description":"Add Primary Contact Remark (SSR CTC)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPrimaryContact","name":"Add Primary Contact Remark (SSR CTC)","isWebhook":false,"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Primary Contact Remark (SSR CTC)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the primary contact to","required":true}],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrimaryContact","exampleIds":["paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM"]}},"schemaId":"components/schemas/PrimaryContact","exampleIds":["paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM"],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PrimaryContact","exampleIds":["paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts","href":"remarks-and-special-service-requests/addprimarycontact","openApiOperationId":"AddPrimaryContact","summary":"Add Primary Contact Remark (SSR CTC)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/PrimaryContact","exampleIds":["paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrimaryContact","exampleIds":["paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrimaryContactResponseWrapper"}},"schemaId":"components/schemas/PrimaryContactResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrimaryContactResponseWrapper"}},"schemaId":"components/schemas/PrimaryContactResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PrimaryContactResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrimaryContactResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/PrimaryContactResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PrimaryContactResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/addprimarycontact"}],"panels":[]}]},"httpPath":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts"},{"label":"Delete Primary Contact Remark","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/remarks-and-special-service-requests/deleteprimarycontact","routeSlug":"/apis/flights/remarks-and-special-service-requests/deleteprimarycontact","metadata":{"seo":{"title":"Delete Primary Contact Remark","description":"Delete Primary Contact Remark"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePrimaryContact","name":"Delete Primary Contact Remark","isWebhook":false,"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Primary Contact Remark","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Identifier you wish to delete the primary contact from","required":true},{"name":"id","in":"path","schemaId":"schema_418","description":"The primary contact id","required":true}],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts/{id}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"},{"name":"id","in":"path","required":true,"example":"primary_001","schemaId":"schema_418"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts/{id}","href":"remarks-and-special-service-requests/deleteprimarycontact","openApiOperationId":"DeletePrimaryContact","summary":"Delete Primary Contact Remark"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/remarks-and-special-service-requests/deleteprimarycontact"}],"panels":[]}]},"httpPath":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts/{id}"}],"content":{"contentType":"group","meta":{"name":"Remarks and Special Service Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remarks and Special Service Requests","showPageActions":true},{"nodeType":"markdoc","content":"Booking remarks including notepad, OSI, and itinerary remarks, and SSRs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/documentoverride/Reservation/{ReservationResource_Identifier}/documentoverrides","summary":"Document Override Remarks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remarks-and-special-service-requests/createdocumentoverrides","deprecated":false},{"title":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings","summary":"Accounting Remarks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remarks-and-special-service-requests/createaccounting","deprecated":false},{"title":"/air/book/accounting/reservationworkbench/{ReservationResource_Identifier}/accountings/{id}/namevaluepairs","summary":"Delete Accounting Remarks","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/remarks-and-special-service-requests/deleteaccounting","deprecated":false},{"title":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/list","summary":"Reservation Comments (general, Itinerary, and OSI Remarks)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remarks-and-special-service-requests/addreservationcomments","deprecated":false},{"title":"/air/book/remarks/reservationworkbench/{ReservationResource_Identifier}/reservationcomments/{id}/comments","summary":"Delete Reservation Comments","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/remarks-and-special-service-requests/deletereservationcomments","deprecated":false},{"title":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/list","summary":"Special Service List Requests","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remarks-and-special-service-requests/addspecialservices","deprecated":false},{"title":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/{id}","summary":"Delete a Special Service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/remarks-and-special-service-requests/deletespecialservices","deprecated":false},{"title":"/air/book/specialservices/reservationworkbench/{ReservationResource_Identifier}/specialservices/deletemultiple","summary":"Delete Multiple Special Services","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remarks-and-special-service-requests/deletemultiplespecialservices","deprecated":false},{"title":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts","summary":"Add Primary Contact Remark (SSR CTC)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/remarks-and-special-service-requests/addprimarycontact","deprecated":false},{"title":"/air/book/primarycontact/reservationworkbench/{ReservationResource_Identifier}/primarycontacts/{id}","summary":"Delete Primary Contact Remark","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/remarks-and-special-service-requests/deleteprimarycontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Ticketing","link":"/apis/flights/ticketing","routeSlug":"/apis/flights/ticketing","items":[{"label":"Post Commit Workbench","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/createreservationworkbenchfromlocator","routeSlug":"/apis/flights/ticketing/createreservationworkbenchfromlocator","metadata":{"seo":{"title":"Post Commit Workbench","description":"Initiate a post-commit workbench to create a session for ticketing or updating an existing reservation. This is a prerequisite step for any workbench session to modify, update, or ticket a reservation.Post-Commit Workbench returns air, hotel, and/or car segments for any reservation that includes that content, called a multi-content booking. All segments must have been booked with the TripServices Flights APIs, TripServices Stays APIs, TripServices Car APIs (release pending), or a Travelport+ terminal program. You can add either GDS or NDC air offers to a hotel and/or car booking, but not both. See the Multi-content Booking Guide (Air, Hotel, Car) for workflows and examples."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateReservationWorkbenchFromLocator","name":"Post Commit Workbench","isWebhook":false,"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post Commit Workbench","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Initiate a post-commit workbench to create a session for ticketing or updating an existing reservation. This is a prerequisite step for any workbench session to modify, update, or ticket a reservation."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Post-Commit Workbench returns air, hotel, and/or car segments for any reservation that includes that content, called a multi-content booking. All segments must have been booked with the TripServices Flights APIs, TripServices Stays APIs, TripServices Car APIs (release pending), or a Travelport+ terminal program. You can add either GDS or NDC air offers to a hotel and/or car booking, but not both. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/multi-content-booking-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-content Booking Guide (Air, Hotel, Car)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for workflows and examples."},"children":[]}]}]}]},{"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":"Locator","in":"query","schemaId":"schema_400","description":"The booking locator code used to retrieve a Reservation"},{"name":"source","in":"query","schemaId":"schema_408","description":"Specifies a unique identifier to indicate the source system which generated the resId."},{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, ReservationDetail will be returned"},{"name":"viewBrandCompleteInfoInd","in":"query","schemaId":"schema_409","description":"If true, Brand complete information will be returned in Reservation Response"},{"name":"viewBaggageDetailInd","in":"query","schemaId":"schema_409","description":"if true, full baggage information will be returned in Reservation Response"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/session/reservationworkbench/buildfromlocator","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"Locator","in":"query","required":false,"example":"ABC123","schemaId":"schema_400"},{"name":"source","in":"query","required":false,"schemaId":"schema_408"},{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBrandCompleteInfoInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBaggageDetailInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/session/reservationworkbench/buildfromlocator","href":"ticketing/createreservationworkbenchfromlocator","openApiOperationId":"CreateReservationWorkbenchFromLocator","summary":"Post Commit Workbench"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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":"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromlocator/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/createreservationworkbenchfromlocator"}],"panels":[]}]},"httpPath":"/air/book/session/reservationworkbench/buildfromlocator"},{"label":"Workbench Commit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/commitreservation","routeSlug":"/apis/flights/ticketing/commitreservation","metadata":{"seo":{"title":"Workbench Commit","description":"After all required and any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the workbench. The resulting actions depend on whether payment is present in the workbench. If no Add Payment request has been sent, committing the workbench books the itinerary and generates a PNR. If an Add Payment request has not been sent, committing the workbench tickets the itinerary and generates ticket number/s."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CommitReservation","name":"Workbench Commit","isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workbench Commit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"After all required and any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the workbench. The resulting actions depend on whether payment is present in the workbench.  \nIf no Add Payment request has been sent, committing the workbench books the itinerary and generates a PNR.  \nIf an Add Payment request has not been sent, committing the workbench tickets the itinerary and generates ticket number/s."},{"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_388","description":"The ReservationWorkbenchIdentifier you wish to commit","required":true}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"autoDeleteDate","in":"query","schemaId":"schema_405","description":"Acts as a retention segment to hold the reservation open past the last date of travel purge date. Sending a new autoDeleteDate at commit step will update the existing autoDeleteDate. Sending 000/00/00 will delete an existing autoDeleteDate."},{"name":"Issuance","in":"query","schemaId":"schema_410","description":"Indicates the type of issuance that should be performed at commit. (Ticket, BackOffice (MIR/TAIR))"},{"name":"DocumentValue","in":"query","schemaId":"schema_411","description":"Indicates of the value of the document should be refunded or retained following a CancelOffer action"},{"name":"payLaterInd","in":"query","schemaId":"schema_409","description":"If true, the Reservation will be fulfilled at a later date"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/reservation/reservations/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"autoDeleteDate","in":"query","required":false,"schemaId":"schema_405"},{"name":"Issuance","in":"query","required":false,"schemaId":"schema_410"},{"name":"DocumentValue","in":"query","required":false,"schemaId":"schema_411"},{"name":"payLaterInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/{Identifier}","href":"ticketing/commitreservation","openApiOperationId":"CommitReservation","summary":"Workbench Commit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/commitreservation"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/{Identifier}"},{"label":"Add Form of Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/addformofpayment","routeSlug":"/apis/flights/ticketing/addformofpayment","metadata":{"seo":{"title":"Add Form of Payment","description":"You can send an Add Form of Payment (FOP) request in either a booking or ticketing workbench session. FOPs of cash and credit are supported. FOPs of agent invoice and non-standard credit card are supported for GDS only. The form of payment will only be added to the reservation when an itinerary exists. If no itinerary exists the form of payment will be ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddFormOfPayment","name":"Add Form of Payment","isWebhook":false,"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Form of Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can send an Add Form of Payment (FOP) request in either a booking or ticketing workbench session. FOPs of cash and credit are supported. FOPs of agent invoice and non-standard credit card are supported for GDS only.  \nThe form of payment will only be added to the reservation when an itinerary exists. If no itinerary exists the form of payment will be ignored."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add form of payment to","required":true}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"authorizePaymentInd","in":"query","schemaId":"schema_409","description":"If true payment card approval will be obtained."}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"]}},"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"authorizePaymentInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment","href":"ticketing/addformofpayment","openApiOperationId":"AddFormOfPayment","summary":"Add Form of Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"]}},"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/FormOfPaymentResponseWrapper"}},"schemaId":"components/schemas/FormOfPaymentResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormOfPaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormOfPaymentResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/addformofpayment"}],"panels":[]}]},"httpPath":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment"},{"label":"Update Form of Payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/updateformofpayment","routeSlug":"/apis/flights/ticketing/updateformofpayment","metadata":{"seo":{"title":"Update Form of Payment","description":"Update a Form Of Payment with new information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateFormOfPayment","name":"Update Form of Payment","isWebhook":false,"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Form of Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Form Of Payment with new information"},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Identifier that includes the form of payment you want to update.","required":true},{"name":"Identifier","in":"path","schemaId":"schema_408","description":"The form of payment identifier you wish to update.","required":true}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass"]}},"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass"],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"},{"name":"Identifier","in":"path","required":true,"schemaId":"schema_408"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass"]}},"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}","href":"ticketing/updateformofpayment","openApiOperationId":"UpdateFormOfPayment","summary":"Update Form of Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass"]}},"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/FormOfPaymentResponseWrapper"}},"schemaId":"components/schemas/FormOfPaymentResponseWrapper"},{"code":"204","description":"No Content - 204"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormOfPaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormOfPaymentResponseWrapper"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/updateformofpayment"}],"panels":[]}]},"httpPath":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}"},{"label":"Delete Form of Payment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/deleteformofpayment","routeSlug":"/apis/flights/ticketing/deleteformofpayment","metadata":{"seo":{"title":"Delete Form of Payment","description":"Delete a Form Of Payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteFormOfPayment","name":"Delete Form of Payment","isWebhook":false,"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Form of Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Form Of Payment"},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Identifier that includes the form of payment you want to delete","required":true},{"name":"Identifier","in":"path","schemaId":"schema_408","description":"The form of payment identifier you wish to update.","required":true}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"},{"name":"Identifier","in":"path","required":true,"schemaId":"schema_408"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}","href":"ticketing/deleteformofpayment","openApiOperationId":"DeleteFormOfPayment","summary":"Delete Form of Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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"},{"code":"204","description":"No Content - 204"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/deleteformofpayment"}],"panels":[]}]},"httpPath":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}"},{"label":"Add Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/addpayment","routeSlug":"/apis/flights/ticketing/addpayment","metadata":{"seo":{"title":"Add Payment","description":"The Payment step takes place in a ticketing workbench session and applies the payment sent previously in the Form of Payment request to the offer/s specified in the Payment request payload. Payment can be sent for any type of offer, including air, seats, and ancillaries. Payment can be made for multiple offers and multiple types of offers in the same request. Form of payment information must either already be present in the reservation or the workbench. At workbench commit, tickets or EMDs are issued for any offer payment has been sent for. Payment is also required prior to ticketing when exchanging tickets in the case of an even exchange, or an add collect (price of new itinerary is greater than existing itinerary). In the case of an add collect, send Payment with a zero amount in Amount/value. See the Exchange, Refund, and Void Guide for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPayment","name":"Add Payment","isWebhook":false,"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Payment step takes place in a ticketing workbench session and applies the payment sent previously in the Form of Payment request to the offer/s specified in the Payment request payload. Payment can be sent for any type of offer, including air, seats, and ancillaries. Payment can be made for multiple offers and multiple types of offers in the same request. Form of payment information must either already be present in the reservation or the workbench. At workbench commit, tickets or EMDs are issued for any offer payment has been sent for. Payment is also required prior to ticketing when exchanging tickets in the case of an even exchange, or an add collect (price of new itinerary is greater than existing itinerary). In the case of an add collect, send Payment with a zero amount in Amount/value. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/exchange-refund-and-void-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange, Refund, and Void Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the payment to","required":true}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"]}},"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments","href":"ticketing/addpayment","openApiOperationId":"AddPayment","summary":"Add Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"]}},"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/PaymentResponseWrapper"}},"schemaId":"components/schemas/PaymentResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}},"schemaId":"components/schemas/PaymentResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/PaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/addpayment"}],"panels":[]}]},"httpPath":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments"},{"label":"Ticket Retrieve","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/ticketgetbylocator","routeSlug":"/apis/flights/ticketing/ticketgetbylocator","metadata":{"seo":{"title":"Ticket Retrieve","description":"Ticket Retrieve"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TicketGetByLocator","name":"Ticket Retrieve","isWebhook":false,"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Retrieve","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"]}},"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"],"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/tickets/getbylocator","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/tickets/getbylocator","href":"ticketing/ticketgetbylocator","openApiOperationId":"TicketGetByLocator","summary":"Ticket Retrieve"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"]}},"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/TicketListResponseWrapper"}},"schemaId":"components/schemas/TicketListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/ticketgetbylocator"}],"panels":[]}]},"httpPath":"/air/ticket/tickets/getbylocator"},{"label":"Ticket Display","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/getticket","routeSlug":"/apis/flights/ticketing/getticket","metadata":{"seo":{"title":"Ticket Display","description":"GDS only. To retrieve an NDC ticket use the Ticket Retrieve API. This API duplicates functionality available in the more recently released Ticket Retrieve API, which for GDS can retrieve a single or multiple tickets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTicket","name":"Ticket Display","isWebhook":false,"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Display","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"GDS only. To retrieve an NDC ticket use the Ticket Retrieve API. This API duplicates functionality available in the more recently released Ticket Retrieve API, which for GDS can retrieve a single or multiple tickets."},{"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_419","description":"The ticket number you wish to retrieve","required":true}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, TicketDetail will be returned"}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/ticket/tickets/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"1259900123456","schemaId":"schema_419"}],"query":[{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/tickets/{Identifier}","href":"ticketing/getticket","openApiOperationId":"GetTicket","summary":"Ticket Display"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TicketListResponseWrapper"}},"schemaId":"components/schemas/TicketListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/getticket"}],"panels":[]}]},"httpPath":"/air/ticket/tickets/{Identifier}"},{"label":"Single Ticket Void","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/updateticket","routeSlug":"/apis/flights/ticketing/updateticket","metadata":{"seo":{"title":"Single Ticket Void","description":"New customers please implement the batch void operation \"documents/void\" end point. This TicketVoid API supports voiding a single GDS ticket. Generally a ticket can be voided only within the same day it was issued. At this time AirTicketing does not support canceling a GDS itinerary outside the void period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateTicket","name":"Single Ticket Void","isWebhook":false,"pointer":"/paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Single Ticket Void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"New customers please implement the batch void operation \"documents/void\" end point.   This TicketVoid API supports voiding a single GDS ticket. Generally a ticket can be voided only within the same day it was issued. At this time AirTicketing does not support canceling a GDS itinerary outside the void period."},{"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_419","description":"The ticket number you wish to update","required":true}],"pointer":"/paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1tickets~1updatestatus~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/TicketQueryUpdateTicket","exampleIds":["paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void"]}},"schemaId":"components/schemas/TicketQueryUpdateTicket","exampleIds":["paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void"],"pointer":"/paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/ticket/tickets/updatestatus/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"1259900123456","schemaId":"schema_419"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TicketQueryUpdateTicket","exampleIds":["paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/tickets/updatestatus/{Identifier}","href":"ticketing/updateticket","openApiOperationId":"UpdateTicket","summary":"Single Ticket Void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TicketQueryUpdateTicket","exampleIds":["paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TicketQueryUpdateTicket","exampleIds":["paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void"]}},"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/TicketIDResponseWrapper"}},"schemaId":"components/schemas/TicketIDResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketIDResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketIDResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/updateticket"}],"panels":[]}]},"httpPath":"/air/ticket/tickets/updatestatus/{Identifier}"},{"label":"Batch Void","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ticketing/documentvoid","routeSlug":"/apis/flights/ticketing/documentvoid","metadata":{"seo":{"title":"Batch Void","description":"The Batch Void API voids multiple documents, including Tickets, EMDs and MCOs on a single booking. You can either void all documents of a specific type (ticket, EMD, or MCO), or send a list of individual ticket or document numbers to void. All tickets and/or documents must be on the same booking. This function is not supported for NDC or LCC. TASF void will be supported as a future enhancement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documentvoid","name":"Batch Void","isWebhook":false,"pointer":"/paths/~1documents~1void/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Batch Void API voids multiple documents, including Tickets, EMDs and MCOs on a single booking. You can either void all documents of a specific type (ticket, EMD, or MCO), or send a list of individual ticket or document numbers to void. All tickets and/or documents must be on the same booking. This function is not supported for NDC or LCC. TASF void will be supported as a future enhancement."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1documents~1void/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentVoidQueryRequest","exampleIds":["paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void"]}},"schemaId":"components/schemas/DocumentVoidQueryRequest","exampleIds":["paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void"],"pointer":"/paths/~1documents~1void/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/void","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentVoidQueryRequest","exampleIds":["paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/documents/void","href":"ticketing/documentvoid","openApiOperationId":"documentvoid","summary":"Batch Void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/DocumentVoidQueryRequest","exampleIds":["paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentVoidQueryRequest","exampleIds":["paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void"]}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentVoidListResponseWrapper"}},"schemaId":"components/schemas/DocumentVoidListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1documents~1void/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentVoidListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentVoidListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ticketing/documentvoid"}],"panels":[]}]},"httpPath":"/documents/void"}],"content":{"contentType":"group","meta":{"name":"Ticketing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticketing","showPageActions":true},{"nodeType":"markdoc","content":"Issuing tickets including form of payment and payment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/session/reservationworkbench/buildfromlocator","summary":"Post Commit Workbench","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticketing/createreservationworkbenchfromlocator","deprecated":false},{"title":"/air/book/reservation/reservations/{Identifier}","summary":"Workbench Commit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticketing/commitreservation","deprecated":false},{"title":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment","summary":"Add Form of Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticketing/addformofpayment","deprecated":false},{"title":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}","summary":"Update Form of Payment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticketing/updateformofpayment","deprecated":false},{"title":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment/{Identifier}","summary":"Delete Form of Payment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ticketing/deleteformofpayment","deprecated":false},{"title":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments","summary":"Add Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticketing/addpayment","deprecated":false},{"title":"/air/ticket/tickets/getbylocator","summary":"Ticket Retrieve","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticketing/ticketgetbylocator","deprecated":false},{"title":"/air/ticket/tickets/{Identifier}","summary":"Ticket Display","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ticketing/getticket","deprecated":false},{"title":"/air/ticket/tickets/updatestatus/{Identifier}","summary":"Single Ticket Void","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ticketing/updateticket","deprecated":false},{"title":"/documents/void","summary":"Batch Void","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ticketing/documentvoid","deprecated":false}]}]}]}]}},{"type":"group","label":"Retrieve Bookings and Tickets","link":"/apis/flights/retrieve-bookings-and-tickets","routeSlug":"/apis/flights/retrieve-bookings-and-tickets","items":[{"label":"Reservation Retrieve","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/retrievereservation","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/retrievereservation","metadata":{"seo":{"title":"Reservation Retrieve","description":"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. If the booking has been ticketed, Reservation Retrieve returns booking, payment, and ticketing details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveReservation","name":"Reservation Retrieve","isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reservation Retrieve","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve details about a held booking or PNR."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"While a PNR refers to a held booking that has not been ticketed, the PNR code persists after ticketing to provide the booking records. If the booking has been ticketed, Reservation Retrieve returns booking, payment, and ticketing details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation Retrieve returns air, hotel, and/or car segments for any reservation that includes that content, called a multi-content booking. All segments must have been booked with the TripServices Flights APIs, TripServices Stays APIs, TripServices Car APIs (release pending), or a Travelport+ terminal program. You can add either GDS or NDC air offers to a hotel and/or car booking, but not both. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/multi-content-booking-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-content Booking Guide (Air, Hotel, Car)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for workflows and examples."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The TripServices Flights APIs provide the following APIs to retrieve bookings and tickets:"},"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":"To retrieve all booking details, use Reservation Retrieve. Returns all booking, payment, and ticketing information currently on a booking."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a ticketed itinerary from a ticket number, use Ticket Display."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a list of all ticket numbers on a booking, use Ticket List."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve details for all tickets associated with a booking (GDS only), or for a single ticket for NDC, use Ticket Retrieve."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To return a list of documents on a booking, such as tickets, invoices, MCOs, and EMDs, use Document List."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To return histories of up to six documents on a booking, such as tickets, invoices, MCOs, and EMDs, use Document History."},"children":[]}]}]}]}]},{"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_420","description":"The Reservation Identifier or Record Locator for the Reservation you wish to retrieve.","required":true}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"authority","in":"query","schemaId":"schema_421","description":"The authorizing entity creating the identifier"},{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The detail view returns any document override, accounting, historical, and DOCI remarks added to the booking, and any custom rules added to a booking."},"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":"If true: Returns detail view."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Does not return detail view."},"children":[]}]}]}]}]},{"name":"viewBrandCompleteInfoInd","in":"query","schemaId":"schema_409","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":"Request the return of brand attributes in the reservation retrieve."},"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":"If true: Returns complete information for brand attributes in Offer/Product/PassengerFlight/FlightProduct/Brand."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Does not return brand attributes."},"children":[]}]}]}]}]},{"name":"viewBaggageDetailInd","in":"query","schemaId":"schema_409","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":"Request the return of baggage dimension and fee details in the reservation retrieve."},"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":"If true: Returns additional baggage details in TermsAndConditionsFull/BaggageAllowance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Does not return baggage details"},"children":[]}]}]}]}]},{"name":"identifierType","in":"query","schemaId":"schema_422","description":"The type of identifier key used to retrieve the reservation.  \nTypically sent as 'Locator' with Identifier as the Locator Code (PNR) to retrieve booking information.  ","example":"Locator"},{"name":"documentType","in":"query","schemaId":"schema_423","description":"When DocumentNumber is selected in identifierType, use documentType to identify the type of document.","example":"Ticket"},{"name":"includeFlightAmenitiesInd","in":"query","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request the return of additional flight amenities, provided by ATPCO as RouteHappy data."},"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":"If true: Returns flight amenity data in ReferenceList/ReferenceListAmenity."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Does not return flight amenity data."},"children":[]}]}]}]}]},{"name":"retrieveNonGDSSourceReservationInd","in":"query","schemaId":"schema_409","description":"If true, reservation information will be retrieved directly from the source supplier."}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/book/reservation/reservations/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"DVZJ8M","schemaId":"schema_420"}],"query":[{"name":"authority","in":"query","required":false,"example":"TVPT","schemaId":"schema_421"},{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBrandCompleteInfoInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBaggageDetailInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"identifierType","in":"query","required":false,"example":"Locator","schemaId":"components/schemas/IdentifierTypeENUM"},{"name":"documentType","in":"query","required":false,"example":"Ticket","schemaId":"components/schemas/DocumentTypeEnum"},{"name":"includeFlightAmenitiesInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"retrieveNonGDSSourceReservationInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/{Identifier}","href":"retrieve-bookings-and-tickets/retrievereservation","openApiOperationId":"RetrieveReservation","summary":"Reservation Retrieve"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/retrievereservation"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/{Identifier}"},{"label":"Retrieve a Reservation by Locator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/getreservationbylocator","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/getreservationbylocator","metadata":{"seo":{"title":"Retrieve a Reservation by Locator","description":"To be deprecated and replaced by Get by Identifier using identifier Type \"Locator\""}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetReservationByLocator","name":"Retrieve a Reservation by Locator","isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1getbylocator/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Reservation by Locator","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"To be deprecated and replaced by Get by Identifier using identifier Type \"Locator\""},{"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":"Locator","in":"query","schemaId":"schema_400","description":"The booking locator code used to retrieve a Reservation"},{"name":"creationDate","in":"query","schemaId":"schema_405","description":"PNR creation Date"},{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, ReservationDetail will be returned"},{"name":"viewBrandCompleteInfoInd","in":"query","schemaId":"schema_409","description":"If true, Brand complete information will be returned in Reservation Response"},{"name":"viewBaggageDetailInd","in":"query","schemaId":"schema_409","description":"if true, full baggage information will be returned in Reservation Response"},{"name":"includeFlightAmenitiesInd","in":"query","schemaId":"schema_409","description":"If true, flight amenities will be included in the response"},{"name":"retrieveNonGDSSourceReservationInd","in":"query","schemaId":"schema_409","description":"if true, reservation information will be retrieved directly from the source supplier"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1getbylocator/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1getbylocator/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/book/reservation/reservations/getbylocator","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"Locator","in":"query","required":false,"example":"ABC123","schemaId":"schema_400"},{"name":"creationDate","in":"query","required":false,"schemaId":"schema_405"},{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBrandCompleteInfoInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBaggageDetailInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"includeFlightAmenitiesInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"retrieveNonGDSSourceReservationInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/getbylocator","href":"retrieve-bookings-and-tickets/getreservationbylocator","openApiOperationId":"GetReservationByLocator","summary":"Retrieve a Reservation by Locator"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1getbylocator/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/getreservationbylocator"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/getbylocator"},{"label":"Ticket List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/getreceipts","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/getreceipts","metadata":{"seo":{"title":"Ticket List","description":"Get a list of ticket receipts for a reservation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetReceipts","name":"Ticket List","isWebhook":false,"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of ticket receipts for a 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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ReceiptType","in":"query","schemaId":"schema_424","description":"The type of receipt you wish to view"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"}],"query":[{"name":"ReceiptType","in":"query","required":false,"schemaId":"schema_424"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","href":"retrieve-bookings-and-tickets/getreceipts","openApiOperationId":"GetReceipts","summary":"Ticket List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ReceiptListResponseWrapper"}},"schemaId":"components/schemas/ReceiptListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReceiptListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceiptListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/getreceipts"}],"panels":[]}]},"httpPath":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts"},{"label":"Ticket Retrieve","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/ticketgetbylocator","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/ticketgetbylocator","metadata":{"seo":{"title":"Ticket Retrieve","description":"Ticket Retrieve"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TicketGetByLocator","name":"Ticket Retrieve","isWebhook":false,"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Retrieve","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"]}},"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"],"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/tickets/getbylocator","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/tickets/getbylocator","href":"retrieve-bookings-and-tickets/ticketgetbylocator","openApiOperationId":"TicketGetByLocator","summary":"Ticket Retrieve"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TicketQueryGetByLocator","exampleIds":["paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"]}},"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/TicketListResponseWrapper"}},"schemaId":"components/schemas/TicketListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1tickets~1getbylocator/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/ticketgetbylocator"}],"panels":[]}]},"httpPath":"/air/ticket/tickets/getbylocator"},{"label":"Ticket Display","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/getticket","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/getticket","metadata":{"seo":{"title":"Ticket Display","description":"GDS only. To retrieve an NDC ticket use the Ticket Retrieve API. This API duplicates functionality available in the more recently released Ticket Retrieve API, which for GDS can retrieve a single or multiple tickets."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetTicket","name":"Ticket Display","isWebhook":false,"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ticket Display","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"GDS only. To retrieve an NDC ticket use the Ticket Retrieve API. This API duplicates functionality available in the more recently released Ticket Retrieve API, which for GDS can retrieve a single or multiple tickets."},{"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_419","description":"The ticket number you wish to retrieve","required":true}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, TicketDetail will be returned"}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/ticket/tickets/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"1259900123456","schemaId":"schema_419"}],"query":[{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/tickets/{Identifier}","href":"retrieve-bookings-and-tickets/getticket","openApiOperationId":"GetTicket","summary":"Ticket Display"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TicketListResponseWrapper"}},"schemaId":"components/schemas/TicketListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1tickets~1{Identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/getticket"}],"panels":[]}]},"httpPath":"/air/ticket/tickets/{Identifier}"},{"label":"Document List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/documenthistorylist","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/documenthistorylist","metadata":{"seo":{"title":"Document List","description":"Document List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documenthistorylist","name":"Document List","isWebhook":false,"pointer":"/paths/~1documents~1documentlist~1{identifier}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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_425","description":"The Reservation Identifier or Record Locator for the Reservation you wish to retrieve","required":true}],"pointer":"/paths/~1documents~1documentlist~1{identifier}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1documents~1documentlist~1{identifier}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/documentlist/{identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"ABC123","schemaId":"schema_425"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/documents/documentlist/{identifier}","href":"retrieve-bookings-and-tickets/documenthistorylist","openApiOperationId":"documenthistorylist","summary":"Document List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/DocumentHistoryListResponseWrapper"}},"schemaId":"components/schemas/DocumentHistoryListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1documents~1documentlist~1{identifier}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentHistoryListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentHistoryListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/documenthistorylist"}],"panels":[]}]},"httpPath":"/documents/documentlist/{identifier}"},{"label":"Document History","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/retrieve-bookings-and-tickets/documenthistory","routeSlug":"/apis/flights/retrieve-bookings-and-tickets/documenthistory","metadata":{"seo":{"title":"Document History","description":"Document History"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"documenthistory","name":"Document History","isWebhook":false,"pointer":"/paths/~1documents~1history/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document History","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1documents~1history/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentHistoryQueryRequest","exampleIds":["paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code","paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number"]}},"schemaId":"components/schemas/DocumentHistoryQueryRequest","exampleIds":["paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code","paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number"],"pointer":"/paths/~1documents~1history/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/history","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DocumentHistoryQueryRequest","exampleIds":["paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code","paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/documents/history","href":"retrieve-bookings-and-tickets/documenthistory","openApiOperationId":"documenthistory","summary":"Document History"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/DocumentHistoryQueryRequest","exampleIds":["paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code","paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DocumentHistoryQueryRequest","exampleIds":["paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code","paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number"]}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentHistoryResponseWrapper"}},"schemaId":"components/schemas/DocumentHistoryResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1documents~1history/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DocumentHistoryResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DocumentHistoryResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/retrieve-bookings-and-tickets/documenthistory"}],"panels":[]}]},"httpPath":"/documents/history"}],"content":{"contentType":"group","meta":{"name":"Retrieve Bookings and Tickets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Bookings and Tickets","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve bookings, tickets, and document histories."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/reservation/reservations/{Identifier}","summary":"Reservation Retrieve","prefix":{"name":"get","color":"get"},"badges":[],"link":"/retrieve-bookings-and-tickets/retrievereservation","deprecated":false},{"title":"/air/book/reservation/reservations/getbylocator","summary":"Retrieve a Reservation by Locator","prefix":{"name":"get","color":"get"},"badges":[],"link":"/retrieve-bookings-and-tickets/getreservationbylocator","deprecated":false},{"title":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","summary":"Ticket List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/retrieve-bookings-and-tickets/getreceipts","deprecated":false},{"title":"/air/ticket/tickets/getbylocator","summary":"Ticket Retrieve","prefix":{"name":"post","color":"post"},"badges":[],"link":"/retrieve-bookings-and-tickets/ticketgetbylocator","deprecated":false},{"title":"/air/ticket/tickets/{Identifier}","summary":"Ticket Display","prefix":{"name":"get","color":"get"},"badges":[],"link":"/retrieve-bookings-and-tickets/getticket","deprecated":false},{"title":"/documents/documentlist/{identifier}","summary":"Document List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/retrieve-bookings-and-tickets/documenthistorylist","deprecated":false},{"title":"/documents/history","summary":"Document History","prefix":{"name":"post","color":"post"},"badges":[],"link":"/retrieve-bookings-and-tickets/documenthistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Modify Traveler Details","link":"/apis/flights/modify-traveler-details","routeSlug":"/apis/flights/modify-traveler-details","items":[{"label":"Update Traveler Information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/modify-traveler-details/updatefromtravelerupdateditems","routeSlug":"/apis/flights/modify-traveler-details/updatefromtravelerupdateditems","metadata":{"seo":{"title":"Update Traveler Information","description":"The Traveler Update request follows an Updatable Items request and makes a change to one or more items returned in that Updatable Items response. Sent as part of a workbench session, either during the initial booking workflow (workbench not committed, PNR not issued yet) or a post-commit workbench for an existing PNR. It is followed by a workbench commit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateFromTravelerUpdatedItems","name":"Update Traveler Information","isWebhook":false,"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Traveler Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Traveler Update request follows an Updatable Items request and makes a change to one or more items returned in that Updatable Items response. Sent as part of a workbench session, either during the initial booking workflow (workbench not committed, PNR not issued yet) or a post-commit workbench for an existing PNR. It is followed by a workbench commit."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier that contains the Traveler you wish to update","required":true},{"name":"id","in":"path","schemaId":"schema_426","description":"The specific TravelerUpdatableItemsListResponse Identifier","required":true}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"]}},"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"59f58f5f-c443-43b4-9f5d-be999fd00a01","schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"]}},"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}","href":"modify-traveler-details/updatefromtravelerupdateditems","openApiOperationId":"UpdateFromTravelerUpdatedItems","summary":"Update Traveler Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"204","description":"No Content - Success"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/modify-traveler-details/updatefromtravelerupdateditems"}],"panels":[]}]},"httpPath":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}"},{"label":"Traveler Updatable Items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/modify-traveler-details/buildfromtraveler","routeSlug":"/apis/flights/modify-traveler-details/buildfromtraveler","metadata":{"seo":{"title":"Traveler Updatable Items","description":"The Updatable Items request retrieves by traveler ID a list of objects that are updatable for that traveler, and returns for each an indicator for whether that item can be added, modified, or deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildFromTraveler","name":"Traveler Updatable Items","isWebhook":false,"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Traveler Updatable Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Updatable Items request retrieves by traveler ID a list of objects that are updatable for that traveler, and returns for each an indicator for whether that item can be added, modified, or deleted."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"]}},"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"]}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler","href":"modify-traveler-details/buildfromtraveler","openApiOperationId":"BuildFromTraveler","summary":"Traveler Updatable Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper"}},"schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/modify-traveler-details/buildfromtraveler"}],"panels":[]}]},"httpPath":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler"}],"content":{"contentType":"group","meta":{"name":"Modify Traveler Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify Traveler Details","showPageActions":true},{"nodeType":"markdoc","content":"Modify traveler information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}","summary":"Update Traveler Information","prefix":{"name":"put","color":"put"},"badges":[],"link":"/modify-traveler-details/updatefromtravelerupdateditems","deprecated":false},{"title":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler","summary":"Traveler Updatable Items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/modify-traveler-details/buildfromtraveler","deprecated":false}]}]}]}]}},{"type":"group","label":"Modify Bookings","link":"/apis/flights/modify-bookings","routeSlug":"/apis/flights/modify-bookings","items":[{"label":"Reservation Divide","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/modify-bookings/divide","routeSlug":"/apis/flights/modify-bookings/divide","metadata":{"seo":{"title":"Reservation Divide","description":"Use this operation to divide a reservation when any of the party needs to cancel or travel on alternative flights; you can divide a reservation with multiple travelers into separate itineraries. This avoids having to cancel a multi-traveler booking to cancel or otherwise modify only some of the travelers.At this time, only Smartpoint Cloud should be used to divide an NDC booking. See the Exchange, Refund, and Void Guide for support details by carrier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Divide","name":"Reservation Divide","isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1divide/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reservation Divide","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this operation to divide a reservation when any of the party needs to cancel or travel on alternative flights; you can divide a reservation with multiple travelers into separate itineraries. This avoids having to cancel a multi-traveler booking to cancel or otherwise modify only some of the travelers."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only Smartpoint Cloud should be used to divide an NDC booking. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/exchange-refund-and-void-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange, Refund, and Void Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for support details by carrier."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1divide/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryDivide","exampleIds":["paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide"]}},"schemaId":"components/schemas/ReservationQueryDivide","exampleIds":["paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide"],"pointer":"/paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/reservation/reservations/divide","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryDivide","exampleIds":["paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/divide","href":"modify-bookings/divide","openApiOperationId":"Divide","summary":"Reservation Divide"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryDivide","exampleIds":["paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryDivide","exampleIds":["paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1divide/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/modify-bookings/divide"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/divide"},{"label":"Reservation Cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/modify-bookings/cancelreservation","routeSlug":"/apis/flights/modify-bookings/cancelreservation","metadata":{"seo":{"title":"Reservation Cancel","description":"Create a set of offer cancellation receipts for every offer in the reservation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelReservation","name":"Reservation Cancel","isWebhook":false,"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reservation Cancel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a set of offer cancellation receipts for every offer in the 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":"ReservationResource_Identifier","in":"path","schemaId":"schema_394","description":" The Reservation Identifier you wish to cancel","required":true}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"OfferIdentifier","in":"query","schemaId":"schema_427","description":"The Offer Identifier you wish to cancel"},{"name":"agencySettlementNotReportedInd","in":"query","schemaId":"schema_409","description":"If true, this refund is settled by the agency directly with the traveler. Transaction is not reported to BSP or ARC. Ticket coupon is updated to RFND status"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_394"}],"query":[{"name":"OfferIdentifier","in":"query","required":false,"example":"offer_1","schemaId":"schema_427"},{"name":"agencySettlementNotReportedInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","href":"modify-bookings/cancelreservation","openApiOperationId":"CancelReservation","summary":"Reservation Cancel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ReceiptListResponseWrapper"}},"schemaId":"components/schemas/ReceiptListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReceiptListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceiptListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/modify-bookings/cancelreservation"}],"panels":[]}]},"httpPath":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts"},{"label":"Update Traveler Information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/modify-bookings/updatefromtravelerupdateditems","routeSlug":"/apis/flights/modify-bookings/updatefromtravelerupdateditems","metadata":{"seo":{"title":"Update Traveler Information","description":"The Traveler Update request follows an Updatable Items request and makes a change to one or more items returned in that Updatable Items response. Sent as part of a workbench session, either during the initial booking workflow (workbench not committed, PNR not issued yet) or a post-commit workbench for an existing PNR. It is followed by a workbench commit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateFromTravelerUpdatedItems","name":"Update Traveler Information","isWebhook":false,"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Traveler Information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Traveler Update request follows an Updatable Items request and makes a change to one or more items returned in that Updatable Items response. Sent as part of a workbench session, either during the initial booking workflow (workbench not committed, PNR not issued yet) or a post-commit workbench for an existing PNR. It is followed by a workbench commit."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier that contains the Traveler you wish to update","required":true},{"name":"id","in":"path","schemaId":"schema_426","description":"The specific TravelerUpdatableItemsListResponse Identifier","required":true}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"]}},"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"59f58f5f-c443-43b4-9f5d-be999fd00a01","schemaId":"schema_426"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"]}},"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}","href":"modify-bookings/updatefromtravelerupdateditems","openApiOperationId":"UpdateFromTravelerUpdatedItems","summary":"Update Traveler Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerQueryUpdate","exampleIds":["paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone","paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"204","description":"No Content - Success"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/modify-bookings/updatefromtravelerupdateditems"}],"panels":[]}]},"httpPath":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}"},{"label":"Traveler Updatable Items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/modify-bookings/buildfromtraveler","routeSlug":"/apis/flights/modify-bookings/buildfromtraveler","metadata":{"seo":{"title":"Traveler Updatable Items","description":"The Updatable Items request retrieves by traveler ID a list of objects that are updatable for that traveler, and returns for each an indicator for whether that item can be added, modified, or deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildFromTraveler","name":"Traveler Updatable Items","isWebhook":false,"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Traveler Updatable Items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Updatable Items request retrieves by traveler ID a list of objects that are updatable for that traveler, and returns for each an indicator for whether that item can be added, modified, or deleted."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_408","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"]}},"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"schemaId":"schema_408"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"]}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler","href":"modify-bookings/buildfromtraveler","openApiOperationId":"BuildFromTraveler","summary":"Traveler Updatable Items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","exampleIds":["paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper"}},"schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelerUpdatableItemsListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/modify-bookings/buildfromtraveler"}],"panels":[]}]},"httpPath":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler"}],"content":{"contentType":"group","meta":{"name":"Modify Bookings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify Bookings","showPageActions":true},{"nodeType":"markdoc","content":"Divide or cancel bookings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/reservation/reservations/divide","summary":"Reservation Divide","prefix":{"name":"post","color":"post"},"badges":[],"link":"/modify-bookings/divide","deprecated":false},{"title":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","summary":"Reservation Cancel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/modify-bookings/cancelreservation","deprecated":false},{"title":"/air/book/traveler/reservationworkbench/{ReservationResource_Identifier}/travelers/updatefromtravelerupdateditems/{id}","summary":"Update Traveler Information","prefix":{"name":"put","color":"put"},"badges":[],"link":"/modify-bookings/updatefromtravelerupdateditems","deprecated":false},{"title":"/air/book/updatableItem/reservationworkbench/{ReservationResource_Identifier}/travelerupdatableitems/buildfromtraveler","summary":"Traveler Updatable Items","prefix":{"name":"post","color":"post"},"badges":[],"link":"/modify-bookings/buildfromtraveler","deprecated":false}]}]}]}]}},{"type":"group","label":"GDS Exchanges","link":"/apis/flights/gds-exchanges","routeSlug":"/apis/flights/gds-exchanges","items":[{"label":"Exchange Eligibility","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/geteligibility","routeSlug":"/apis/flights/gds-exchanges/geteligibility","metadata":{"seo":{"title":"Exchange Eligibility","description":"The Eligibility API is the first step in the GDS exchange workflow. It is an optional step. Eligibility returns information about whether a ticket may have value in an exchange or refund scenario, and the range of potential exchange and refund fees. This information relates only to fees and not any fare or tax difference for the itinerary. Send either Ticket or Locator as a query parameter. Ticket returns eligibility details for only the one traveler on the ticket, while Locator returns details for all travelers on that reservation. A request by reservation locator for a reservation that has multiple open tickets for one passenger will return eligibility information only for the last ticket listed in the reservation. In this scenario you should instead send the request by ticket number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetEligibility","name":"Exchange Eligibility","isWebhook":false,"pointer":"/paths/~1eligibility~1ticketchangeeligibilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange Eligibility","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Eligibility API is the first step in the GDS exchange workflow. It is an optional step.  \nEligibility returns information about whether a ticket may have value in an exchange or refund scenario, and the range of potential exchange and refund fees. This information relates only to fees and not any fare or tax difference for the itinerary.  \nSend either Ticket or Locator as a query parameter. Ticket returns eligibility details for only the one traveler on the ticket, while Locator returns details for all travelers on that reservation.  \nA request by reservation locator for a reservation that has multiple open tickets for one passenger will return eligibility information only for the last ticket listed in the reservation. In this scenario you should instead send the request by ticket number."},{"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":"Locator","in":"query","schemaId":"schema_428","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reservation locator of the itinerary you want to request eligibility information for."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Append '?Locator=' and the reservation locator to the GET request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not supported for any ticket with multiple offers."},"children":[]}]}]}]},{"name":"authority","in":"query","schemaId":"schema_408","description":"Name of the authoritative system that created this guid","example":"Travelport"},{"name":"Ticket","in":"query","schemaId":"schema_408","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ticket number of the ticketed itinerary you want to request eligibility information for."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Append '?Ticket=' and the ticket number to the GET request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Ticket parameter when sending an Eligibility request for any ticket with multiple offers."},"children":[]}]}]}],"example":"1259900123456"}],"pointer":"/paths/~1eligibility~1ticketchangeeligibilities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1eligibility~1ticketchangeeligibilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/eligibility/ticketchangeeligibilities","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"Locator","in":"query","required":false,"example":"ABC123","schemaId":"schema_428","style":"form","explode":true},{"name":"authority","in":"query","required":false,"example":"Travelport","schemaId":"schema_408","style":"form","explode":true},{"name":"Ticket","in":"query","required":false,"example":"1259900123456","schemaId":"schema_408","style":"form","explode":true}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/eligibility/ticketchangeeligibilities","href":"gds-exchanges/geteligibility","openApiOperationId":"GetEligibility","summary":"Exchange Eligibility"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TicketChangeEligibilityListResponseWrapper"}},"schemaId":"components/schemas/TicketChangeEligibilityListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1eligibility~1ticketchangeeligibilities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TicketChangeEligibilityListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TicketChangeEligibilityListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/geteligibility"}],"panels":[]}]},"httpPath":"/eligibility/ticketchangeeligibilities"},{"label":"Exchange Search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/createexchangesearch","routeSlug":"/apis/flights/gds-exchanges/createexchangesearch","metadata":{"seo":{"title":"Exchange Search","description":"The Exchange Search API is the second step in the GDS exchange workflow, after Eligibility. It supports searching for an alternate itinerary for a possible exchange on a currently ticketed GDS itinerary. The response details any differences in base fare, taxes, fees, and total price between the currently ticketed itinerary and the possible new itinerary."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateExchangeSearch","name":"Exchange Search","isWebhook":false,"pointer":"/paths/~1exchangesearch~1catalogofferingsairchange/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange Search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Exchange Search API is the second step in the GDS exchange workflow, after Eligibility. It supports searching for an alternate itinerary for a possible exchange on a currently ticketed GDS itinerary. The response details any differences in base fare, taxes, fees, and total price between the currently ticketed itinerary and the possible new itinerary."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1exchangesearch~1catalogofferingsairchange/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search"]}},"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search"],"pointer":"/paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exchangesearch/catalogofferingsairchange","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/exchangesearch/catalogofferingsairchange","href":"gds-exchanges/createexchangesearch","openApiOperationId":"CreateExchangeSearch","summary":"Exchange Search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search"]}},"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/CatalogOfferingsAirChangeResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsAirChangeResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1exchangesearch~1catalogofferingsairchange/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogOfferingsAirChangeResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsAirChangeResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/createexchangesearch"}],"panels":[]}]},"httpPath":"/exchangesearch/catalogofferingsairchange"},{"label":"Workbench Commit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/commitreservation","routeSlug":"/apis/flights/gds-exchanges/commitreservation","metadata":{"seo":{"title":"Workbench Commit","description":"After all required and any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the workbench. The resulting actions depend on whether payment is present in the workbench. If no Add Payment request has been sent, committing the workbench books the itinerary and generates a PNR. If an Add Payment request has not been sent, committing the workbench tickets the itinerary and generates ticket number/s."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CommitReservation","name":"Workbench Commit","isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workbench Commit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"After all required and any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the workbench. The resulting actions depend on whether payment is present in the workbench.  \nIf no Add Payment request has been sent, committing the workbench books the itinerary and generates a PNR.  \nIf an Add Payment request has not been sent, committing the workbench tickets the itinerary and generates ticket number/s."},{"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_388","description":"The ReservationWorkbenchIdentifier you wish to commit","required":true}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"autoDeleteDate","in":"query","schemaId":"schema_405","description":"Acts as a retention segment to hold the reservation open past the last date of travel purge date. Sending a new autoDeleteDate at commit step will update the existing autoDeleteDate. Sending 000/00/00 will delete an existing autoDeleteDate."},{"name":"Issuance","in":"query","schemaId":"schema_410","description":"Indicates the type of issuance that should be performed at commit. (Ticket, BackOffice (MIR/TAIR))"},{"name":"DocumentValue","in":"query","schemaId":"schema_411","description":"Indicates of the value of the document should be refunded or retained following a CancelOffer action"},{"name":"payLaterInd","in":"query","schemaId":"schema_409","description":"If true, the Reservation will be fulfilled at a later date"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/reservation/reservations/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"autoDeleteDate","in":"query","required":false,"schemaId":"schema_405"},{"name":"Issuance","in":"query","required":false,"schemaId":"schema_410"},{"name":"DocumentValue","in":"query","required":false,"schemaId":"schema_411"},{"name":"payLaterInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/{Identifier}","href":"gds-exchanges/commitreservation","openApiOperationId":"CommitReservation","summary":"Workbench Commit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation","exampleIds":["paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit","paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"]}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/commitreservation"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/{Identifier}"},{"label":"Refund Commit from Document Refund Quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/refundfromofferlist","routeSlug":"/apis/flights/gds-exchanges/refundfromofferlist","metadata":{"seo":{"title":"Refund Commit from Document Refund Quote","description":"Issues the refund based on a previously generated refund quote. Reference the OfferListIdentifiers returned in Document Refun Quote to select the refund you wish to complete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RefundFromOfferList","name":"Refund Commit from Document Refund Quote","isWebhook":false,"pointer":"/paths/~1air~1receipt~1receipts~1documentrefundfromofferlist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund Commit from Document Refund Quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Issues the refund based on a previously generated refund quote. Reference the OfferListIdentifiers returned in Document Refun Quote to select the refund you wish to complete."},{"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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReceiptQueryDocumentRefundFromOfferList"}},"schemaId":"components/schemas/ReceiptQueryDocumentRefundFromOfferList","pointer":"/paths/~1air~1receipt~1receipts~1documentrefundfromofferlist/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/receipt/receipts/documentrefundfromofferlist","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReceiptQueryDocumentRefundFromOfferList"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/receipt/receipts/documentrefundfromofferlist","href":"gds-exchanges/refundfromofferlist","openApiOperationId":"RefundFromOfferList","summary":"Refund Commit from Document Refund Quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReceiptQueryDocumentRefundFromOfferList","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReceiptQueryDocumentRefundFromOfferList"}},"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/ReceiptListResponseWrapper"}},"schemaId":"components/schemas/ReceiptListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1receipt~1receipts~1documentrefundfromofferlist/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReceiptListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceiptListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/refundfromofferlist"}],"panels":[]}]},"httpPath":"/air/receipt/receipts/documentrefundfromofferlist"},{"label":"Document Refund Quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/documentrefundquote","routeSlug":"/apis/flights/gds-exchanges/documentrefundquote","metadata":{"seo":{"title":"Document Refund Quote","description":"Send one or more ticket numbers for a Refund Quote to determine what, if any, refund value may be available on the ticket(s). You can send multiple tickets only if all tickets sent in the request belong to the same PNR and use the same filed fare. The response includes a detailed refund quote with refundable amounts, penalties, tax breakdowns, and related details. Use the following endpoint. The information returned in the response payload is similar whether the request was by a record locator or by a ticket number. Refund Quote price details are provided in the following objects. All objects provide a total amount and a breakdown by base fare, price, and taxes as applicable: - Price - Amount paid for the ticket. - ModifyPrice - Any amount eligible for refund. - SupplierRetainedPrice - Any amount forfeited."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DocumentRefundQuote","name":"Document Refund Quote","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1offers~1documentrefundquote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Document Refund Quote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send one or more ticket numbers for a Refund Quote to determine what, if any, refund value may be available on the ticket(s). You can send multiple tickets only if all tickets sent in the request belong to the same PNR and use the same filed fare. The response includes a detailed refund quote with refundable amounts, penalties, tax breakdowns, and related details. Use the following endpoint.   The information returned in the response payload is similar whether the request was by a record locator or by a ticket number.   Refund Quote price details are provided in the following objects. All objects provide a total amount and a breakdown by base fare, price, and taxes as applicable:   -  Price - Amount paid for the ticket.   -  ModifyPrice - Any amount eligible for refund.   -  SupplierRetainedPrice - Any amount forfeited.  "},{"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":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryDocumentRefundQuote"}},"schemaId":"components/schemas/OfferQueryDocumentRefundQuote","pointer":"/paths/~1air~1book~1airoffer~1offers~1documentrefundquote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/offers/documentrefundquote","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryDocumentRefundQuote"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/offers/documentrefundquote","href":"gds-exchanges/documentrefundquote","openApiOperationId":"DocumentRefundQuote","summary":"Document Refund Quote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryDocumentRefundQuote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryDocumentRefundQuote"}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1offers~1documentrefundquote/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/documentrefundquote"}],"panels":[]}]},"httpPath":"/air/book/airoffer/offers/documentrefundquote"},{"label":"Add/Modify Offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/tripchangebuildfromcatalogofferings","routeSlug":"/apis/flights/gds-exchanges/tripchangebuildfromcatalogofferings","metadata":{"seo":{"title":"Add/Modify Offer","description":"Use the Add Offer reference payload request to add an offer to the reservation workbench as part of the booking workflow. The reference payload request sends identifiers from the Exchange Search response instead of full itinerary details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"TripChangeBuildFromCatalogOfferings","name":"Add/Modify Offer","isWebhook":false,"pointer":"/paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add/Modify Offer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the Add Offer reference payload request to add an offer to the reservation workbench as part of the booking workflow. The reference payload request sends identifiers from the Exchange Search response instead of full itinerary 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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer"]}},"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer"],"pointer":"/paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/offer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/offer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings","href":"gds-exchanges/tripchangebuildfromcatalogofferings","openApiOperationId":"TripChangeBuildFromCatalogOfferings","summary":"Add/Modify Offer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer"]}},"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/ExchangeOfferListResponseWrapper"}},"schemaId":"components/schemas/ExchangeOfferListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeOfferListResponseWrapper"}},"schemaId":"components/schemas/ExchangeOfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeOfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeOfferListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/ExchangeOfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeOfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/tripchangebuildfromcatalogofferings"}],"panels":[]}]},"httpPath":"/air/book/offer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings"},{"label":"Add Form of Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/addformofpayment","routeSlug":"/apis/flights/gds-exchanges/addformofpayment","metadata":{"seo":{"title":"Add Form of Payment","description":"You can send an Add Form of Payment (FOP) request in either a booking or ticketing workbench session. FOPs of cash and credit are supported. FOPs of agent invoice and non-standard credit card are supported for GDS only. The form of payment will only be added to the reservation when an itinerary exists. If no itinerary exists the form of payment will be ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddFormOfPayment","name":"Add Form of Payment","isWebhook":false,"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Form of Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"You can send an Add Form of Payment (FOP) request in either a booking or ticketing workbench session. FOPs of cash and credit are supported. FOPs of agent invoice and non-standard credit card are supported for GDS only.  \nThe form of payment will only be added to the reservation when an itinerary exists. If no itinerary exists the form of payment will be ignored."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add form of payment to","required":true}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"authorizePaymentInd","in":"query","schemaId":"schema_409","description":"If true payment card approval will be obtained."}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"]}},"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"authorizePaymentInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment","href":"gds-exchanges/addformofpayment","openApiOperationId":"AddFormOfPayment","summary":"Add Form of Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FormOfPaymentID","exampleIds":["paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver","paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"]}},"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/FormOfPaymentResponseWrapper"}},"schemaId":"components/schemas/FormOfPaymentResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FormOfPaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FormOfPaymentResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/addformofpayment"}],"panels":[]}]},"httpPath":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment"},{"label":"Add Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/gds-exchanges/addpayment","routeSlug":"/apis/flights/gds-exchanges/addpayment","metadata":{"seo":{"title":"Add Payment","description":"The Payment step takes place in a ticketing workbench session and applies the payment sent previously in the Form of Payment request to the offer/s specified in the Payment request payload. Payment can be sent for any type of offer, including air, seats, and ancillaries. Payment can be made for multiple offers and multiple types of offers in the same request. Form of payment information must either already be present in the reservation or the workbench. At workbench commit, tickets or EMDs are issued for any offer payment has been sent for. Payment is also required prior to ticketing when exchanging tickets in the case of an even exchange, or an add collect (price of new itinerary is greater than existing itinerary). In the case of an add collect, send Payment with a zero amount in Amount/value. See the Exchange, Refund, and Void Guide for details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddPayment","name":"Add Payment","isWebhook":false,"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Payment step takes place in a ticketing workbench session and applies the payment sent previously in the Form of Payment request to the offer/s specified in the Payment request payload. Payment can be sent for any type of offer, including air, seats, and ancillaries. Payment can be made for multiple offers and multiple types of offers in the same request. Form of payment information must either already be present in the reservation or the workbench. At workbench commit, tickets or EMDs are issued for any offer payment has been sent for. Payment is also required prior to ticketing when exchanging tickets in the case of an even exchange, or an add collect (price of new itinerary is greater than existing itinerary). In the case of an add collect, send Payment with a zero amount in Amount/value. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/exchange-refund-and-void-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange, Refund, and Void Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the payment to","required":true}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"]}},"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments","href":"gds-exchanges/addpayment","openApiOperationId":"AddPayment","summary":"Add Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment","exampleIds":["paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer","paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"]}},"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/PaymentResponseWrapper"}},"schemaId":"components/schemas/PaymentResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}},"schemaId":"components/schemas/PaymentResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/PaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gds-exchanges/addpayment"}],"panels":[]}]},"httpPath":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments"}],"content":{"contentType":"group","meta":{"name":"GDS Exchanges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"GDS Exchanges","showPageActions":true},{"nodeType":"markdoc","content":"GDS ticket exchange workflow from exchange search, modify, and ticket exchange."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/eligibility/ticketchangeeligibilities","summary":"Exchange Eligibility","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gds-exchanges/geteligibility","deprecated":false},{"title":"/exchangesearch/catalogofferingsairchange","summary":"Exchange Search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/createexchangesearch","deprecated":false},{"title":"/air/book/reservation/reservations/{Identifier}","summary":"Workbench Commit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/commitreservation","deprecated":false},{"title":"/air/receipt/receipts/documentrefundfromofferlist","summary":"Refund Commit from Document Refund Quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/refundfromofferlist","deprecated":false},{"title":"/air/book/airoffer/offers/documentrefundquote","summary":"Document Refund Quote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/documentrefundquote","deprecated":false},{"title":"/air/book/offer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings","summary":"Add/Modify Offer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/tripchangebuildfromcatalogofferings","deprecated":false},{"title":"/air/payment/reservationworkbench/{ReservationResource_Identifier}/formofpayment","summary":"Add Form of Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/addformofpayment","deprecated":false},{"title":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments","summary":"Add Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gds-exchanges/addpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"NDC Modify Cancel Exchange","link":"/apis/flights/ndc-modify-cancel-exchange","routeSlug":"/apis/flights/ndc-modify-cancel-exchange","items":[{"label":"NDC Refund Quote and Seat/Ancillary Cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/cancelworkbenchoffer","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/cancelworkbenchoffer","metadata":{"seo":{"title":"NDC Refund Quote and Seat/Ancillary Cancel","description":"The NDC Refund Quote API determines what if any refund value may be available on a ticket. It is part of the NDC cancel workflow: Create a workbench session, send Refund Quote, then send Cancel to cancel the ticket and issue any refund. For supporting NDC carriers only, you can cancel only specified segments in Refund Quote instead of the entire itinerary. In this case, the ticket value is retained at Cancel. Refund Quote is mandatory when canceling a ticket outside the void period and there is any difference between a refund due and the purchase price. If Refund Quote is not sent, and a refund is not available for the exact amount of the purchase price, Cancel returns the error message 'OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN'.The Ancillary Cancel API supports canceling baggage and/or paid seats for both GDS and NDC, and canceling non-baggage ancillaries for NDC. Canceling non-baggage ancillaries for GDS is not supported. Ancillary Cancel must be sent in a workbench session: Create a workbench, send Ancillary Cancel, and commit the workbench. You can cancel ancillaries booked in the same or a previous session. Seat and ancillary cancel support varies in the booking workflow. See the Seats Guide and Ancillary Guide for support details. Only one paid seat per workbench session can be canceled. To cancel multiple seats, send one cancel request, commit the workbench, and start a new workbench to cancel the next seat. For paid bags, you can send multiple cancel requests in a post-commit workbench session. You cannot cancel ancillaries or seats from a ticketed itinerary."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelWorkbenchOffer","name":"NDC Refund Quote and Seat/Ancillary Cancel","isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NDC Refund Quote and Seat/Ancillary Cancel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The NDC Refund Quote API determines what if any refund value may be available on a ticket. It is part of the NDC cancel workflow: Create a workbench session, send Refund Quote, then send Cancel to cancel the ticket and issue any refund. For supporting NDC carriers only, you can cancel only specified segments in Refund Quote instead of the entire itinerary. In this case, the ticket value is retained at Cancel. Refund Quote is mandatory when canceling a ticket outside the void period and there is any difference between a refund due and the purchase price. If Refund Quote is not sent, and a refund is not available for the exact amount of the purchase price, Cancel returns the error message 'OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN'."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Ancillary Cancel API supports canceling baggage and/or paid seats for both GDS and NDC, and canceling non-baggage ancillaries for NDC. Canceling non-baggage ancillaries for GDS is not supported. Ancillary Cancel must be sent in a workbench session: Create a workbench, send Ancillary Cancel, and commit the workbench. You can cancel ancillaries booked in the same or a previous session. Seat and ancillary cancel support varies in the booking workflow. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/seats-and-ancillaries/seats-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seats Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/seats-and-ancillaries/ancillaries-and-emd-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ancillary Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for support details. Only one paid seat per workbench session can be canceled. To cancel multiple seats, send one cancel request, commit the workbench, and start a new workbench to cancel the next seat. For paid bags, you can send multiple cancel requests in a post-commit workbench session. You cannot cancel ancillaries or seats from a ticketed itinerary."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"]}},"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer","href":"ndc-modify-cancel-exchange/cancelworkbenchoffer","openApiOperationId":"CancelWorkbenchOffer","summary":"NDC Refund Quote and Seat/Ancillary Cancel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryCancelOffer","exampleIds":["paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote","paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/cancelworkbenchoffer"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer"},{"label":"NDC Reshop","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/createndcexchangesearch","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/createndcexchangesearch","metadata":{"seo":{"title":"NDC Reshop","description":"NDC only; not supported for GDS.The Reshop API searches for a new itinerary when modifying a held booking or exchanging a ticket for NDC.Reshop is part of the NDC modify/exchange workflow. Create a post-commit workbench, Reshop with this API call, Reprice to confirm pricing, and commit the workbench to confirm the changes. See the NDC Exchanges and Refunds guide for more details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateNDCExchangeSearch","name":"NDC Reshop","isWebhook":false,"pointer":"/paths/~1air~1change~1catalogofferingsairchange/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NDC Reshop","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC only; not supported for GDS."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Reshop API searches for a new itinerary when modifying a held booking or exchanging a ticket for NDC."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reshop is part of the NDC modify/exchange workflow. Create a post-commit workbench, Reshop with this API call, Reprice to confirm pricing, and commit the workbench to confirm the changes. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/ndc/ndc-exchanges-and-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC Exchanges and Refunds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for more details."},"children":[]}]}]}]},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1change~1catalogofferingsairchange/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop"]}},"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop"],"pointer":"/paths/~1air~1change~1catalogofferingsairchange/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/change/catalogofferingsairchange","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/change/catalogofferingsairchange","href":"ndc-modify-cancel-exchange/createndcexchangesearch","openApiOperationId":"CreateNDCExchangeSearch","summary":"NDC Reshop"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsQueryAirChange","exampleIds":["paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop"]}},"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/CatalogOfferingsAirChangeResponseWrapper"}},"schemaId":"components/schemas/CatalogOfferingsAirChangeResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1change~1catalogofferingsairchange/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CatalogOfferingsAirChangeResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CatalogOfferingsAirChangeResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/createndcexchangesearch"}],"panels":[]}]},"httpPath":"/air/change/catalogofferingsairchange"},{"label":"Modify","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/ndcmodifyreservation","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/ndcmodifyreservation","metadata":{"seo":{"title":"Modify","description":"After all required changes any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the order changes in the workbench."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"NDCModifyReservation","name":"Modify","isWebhook":false,"pointer":"/paths/~1air~1modify~1reservations~1{Identifier}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"After all required changes any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the order changes in the workbench."},{"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_388","description":"The Reservation Workbench Identifier you wish to modify NDC content","required":true}],"pointer":"/paths/~1air~1modify~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"autoDeleteDate","in":"query","schemaId":"schema_405","description":"Acts as a retention segment to hold the reservation open past the last date of travel purge date. Sending a new autoDeleteDate at commit step will update the existing autoDeleteDate. Sending 000/00/00 will delete an existing autoDeleteDate."},{"name":"Issuance","in":"query","schemaId":"schema_410","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of issuance that should be performed at commit. (Ticket, BackOffice (MIR/TAIR))"},"children":[]}]}]}]},{"name":"DocumentValue","in":"query","schemaId":"schema_411","description":"Indicates of the value of the document should be refunded or retained following a CancelOffer action"},{"name":"payLaterInd","in":"query","schemaId":"schema_409","description":"If true, the Reservation will be fulfilled at a later date"}],"pointer":"/paths/~1air~1modify~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1modify~1reservations~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation"}},"schemaId":"components/schemas/ReservationQueryCommitReservation","pointer":"/paths/~1air~1modify~1reservations~1{Identifier}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/modify/reservations/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"autoDeleteDate","in":"query","required":false,"schemaId":"schema_405"},{"name":"Issuance","in":"query","required":false,"schemaId":"schema_410"},{"name":"DocumentValue","in":"query","required":false,"schemaId":"schema_411"},{"name":"payLaterInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation"}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/modify/reservations/{Identifier}","href":"ndc-modify-cancel-exchange/ndcmodifyreservation","openApiOperationId":"NDCModifyReservation","summary":"Modify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationQueryCommitReservation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationQueryCommitReservation"}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1modify~1reservations~1{Identifier}/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/ndcmodifyreservation"}],"panels":[]}]},"httpPath":"/air/modify/reservations/{Identifier}"},{"label":"Reservation Cancel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/cancelreservation","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/cancelreservation","metadata":{"seo":{"title":"Reservation Cancel","description":"Create a set of offer cancellation receipts for every offer in the reservation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelReservation","name":"Reservation Cancel","isWebhook":false,"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reservation Cancel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a set of offer cancellation receipts for every offer in the 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":"ReservationResource_Identifier","in":"path","schemaId":"schema_394","description":" The Reservation Identifier you wish to cancel","required":true}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"OfferIdentifier","in":"query","schemaId":"schema_427","description":"The Offer Identifier you wish to cancel"},{"name":"agencySettlementNotReportedInd","in":"query","schemaId":"schema_409","description":"If true, this refund is settled by the agency directly with the traveler. Transaction is not reported to BSP or ARC. Ticket coupon is updated to RFND status"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_394"}],"query":[{"name":"OfferIdentifier","in":"query","required":false,"example":"offer_1","schemaId":"schema_427"},{"name":"agencySettlementNotReportedInd","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","href":"ndc-modify-cancel-exchange/cancelreservation","openApiOperationId":"CancelReservation","summary":"Reservation Cancel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ReceiptListResponseWrapper"}},"schemaId":"components/schemas/ReceiptListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReceiptListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceiptListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/cancelreservation"}],"panels":[]}]},"httpPath":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts"},{"label":"NDC Reprice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/workbenchndcbuildfromcatalogofferings","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/workbenchndcbuildfromcatalogofferings","metadata":{"seo":{"title":"NDC Reprice","description":"Use the Add Offer reference payload request to add an offer to the reservation workbench as part of the booking workflow. The reference payload request sends identifiers from the Search response instead of full itinerary details. NDC supports only the reference payload. For GDS, you can send either a reference payload or a full payload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"WorkbenchNDCBuildFromCatalogOfferings","name":"NDC Reprice","isWebhook":false,"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NDC Reprice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use the Add Offer reference payload request to add an offer to the reservation workbench as part of the booking workflow. The reference payload request sends identifiers from the Search response instead of full itinerary details.  \nNDC supports only the reference payload. For GDS, you can send either a reference payload or a full payload."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice","paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin"]}},"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice","paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin"],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice","paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin"]}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings","href":"ndc-modify-cancel-exchange/workbenchndcbuildfromcatalogofferings","openApiOperationId":"WorkbenchNDCBuildFromCatalogOfferings","summary":"NDC Reprice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice","paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromCatalogOfferings","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice","paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin"]}},"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/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"201","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/workbenchndcbuildfromcatalogofferings"}],"panels":[]}]},"httpPath":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings"},{"label":"Standalone Reprice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/repricebuildfromoffer","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/repricebuildfromoffer","metadata":{"seo":{"title":"Standalone Reprice","description":"NDC only; not supported for GDS. Not supported for all NDC carriers. Use the Standalone Reprice API to reprice an itinerary on a held booking for NDC. Standalone Reprice can be sent before or after the price guarantee expires. This request would typically be used to check if the price has changed before issuing a ticket. You can then either ticket the itinerary or hold the booking again. Standalone Reprice must be sent in a workbench session. It must be followed by a Modify request to commit the workbench and either ticket or hold the itinerary. If you want to ticket at Modify, send Form of Payment and Payment before Modify. For supporting NDC carriers, see NDC Carrier Support in the developer documentation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RepriceBuildFromOffer","name":"Standalone Reprice","isWebhook":false,"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Standalone Reprice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC only; not supported for GDS. Not supported for all NDC carriers. Use the Standalone Reprice API to reprice an itinerary on a held booking for NDC. Standalone Reprice can be sent before or after the price guarantee expires. This request would typically be used to check if the price has changed before issuing a ticket. You can then either ticket the itinerary or hold the booking again. Standalone Reprice must be sent in a workbench session. It must be followed by a Modify request to commit the workbench and either ticket or hold the itinerary. If you want to ticket at Modify, send Form of Payment and Payment before Modify. For supporting NDC carriers, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/ndc/ndc-guide#ndc-carrier-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC Carrier Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation."},"children":[]}]}]}]},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromOffer","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice"]}},"schemaId":"components/schemas/OfferQueryBuildFromOffer","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice"],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromoffer","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromOffer","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice"]}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromoffer","href":"ndc-modify-cancel-exchange/repricebuildfromoffer","openApiOperationId":"RepriceBuildFromOffer","summary":"Standalone Reprice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildFromOffer","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildFromOffer","exampleIds":["paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferResponseWrapper"}},"schemaId":"components/schemas/OfferResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OfferResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/repricebuildfromoffer"}],"panels":[]}]},"httpPath":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromoffer"},{"label":"Cancel Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/ndc-modify-cancel-exchange/cancelpayment","routeSlug":"/apis/flights/ndc-modify-cancel-exchange/cancelpayment","metadata":{"seo":{"title":"Cancel Payment","description":"NDC only; not supported for GDS. Supported only for Qantas (QF). For NDC on supporting carriers only, you can use the Cancel Payment API to cancel the payment on a ticket. This refunds the payment, cancels the ticket but retains the itinerary, and creates a held booking for later fulfillment. For example, you might want to use this workflow to use a different payment method than was sent in ticketing. You must establish a workbench session before sending the Cancel Payment request detailed here. After sending Cancel Payment, you must commit the workbench to implement the change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelPayment","name":"Cancel Payment","isWebhook":false,"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"NDC only; not supported for GDS. Supported only for Qantas (QF). For NDC on supporting carriers only, you can use the Cancel Payment API to cancel the payment on a ticket. This refunds the payment, cancels the ticket but retains the itinerary, and creates a held booking for later fulfillment. For example, you might want to use this workflow to use a different payment method than was sent in ticketing. You must establish a workbench session before sending the Cancel Payment request detailed here. After sending Cancel Payment, you must commit the workbench to implement the change."},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to cancel or void the payment","required":true},{"name":"id","in":"path","schemaId":"schema_429","description":"The Payment ID you wish to cancel or void","required":true}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments~1{id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments/{id}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"payment_1","schemaId":"schema_429"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments/{id}","href":"ndc-modify-cancel-exchange/cancelpayment","openApiOperationId":"CancelPayment","summary":"Cancel Payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/PaymentResponseWrapper"}},"schemaId":"components/schemas/PaymentResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ndc-modify-cancel-exchange/cancelpayment"}],"panels":[]}]},"httpPath":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments/{id}"}],"content":{"contentType":"group","meta":{"name":"NDC Modify Cancel Exchange"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NDC Modify Cancel Exchange","showPageActions":true},{"nodeType":"markdoc","content":"NDC modify and cancel flows."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/canceloffer","summary":"NDC Refund Quote and Seat/Ancillary Cancel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/cancelworkbenchoffer","deprecated":false},{"title":"/air/change/catalogofferingsairchange","summary":"NDC Reshop","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/createndcexchangesearch","deprecated":false},{"title":"/air/modify/reservations/{Identifier}","summary":"Modify","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/ndcmodifyreservation","deprecated":false},{"title":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts","summary":"Reservation Cancel","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/cancelreservation","deprecated":false},{"title":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromcatalogofferings","summary":"NDC Reprice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/workbenchndcbuildfromcatalogofferings","deprecated":false},{"title":"/air/reprice/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromoffer","summary":"Standalone Reprice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/repricebuildfromoffer","deprecated":false},{"title":"/air/paymentoffer/reservationworkbench/{ReservationResource_Identifier}/payments/{id}","summary":"Cancel Payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ndc-modify-cancel-exchange/cancelpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Queues","link":"/apis/flights/queues","routeSlug":"/apis/flights/queues","items":[{"label":"Queue Placement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/queues/create","routeSlug":"/apis/flights/queues/create","metadata":{"seo":{"title":"Queue Placement","description":"Queue Placement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create","name":"Queue Placement","isWebhook":false,"pointer":"/paths/~1air~1queue~1queue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queue Placement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1queue~1queue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement"]}},"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement"],"pointer":"/paths/~1air~1queue~1queue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/queue/queue","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/queue/queue","href":"queues/create","openApiOperationId":"Create","summary":"Queue Placement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement"]}},"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/BaseResponseWrapper"}},"schemaId":"components/schemas/BaseResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1queue~1queue/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaseResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/create"}],"panels":[]}]},"httpPath":"/air/queue/queue"},{"label":"Queue Remove","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/queues/queueremove","routeSlug":"/apis/flights/queues/queueremove","metadata":{"seo":{"title":"Queue Remove","description":"Queue Remove"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QueueRemove","name":"Queue Remove","isWebhook":false,"pointer":"/paths/~1air~1queue~1queue~1remove/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queue Remove","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1queue~1queue~1remove/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove"]}},"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove"],"pointer":"/paths/~1air~1queue~1queue~1remove/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/queue/queue/remove","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/queue/queue/remove","href":"queues/queueremove","openApiOperationId":"QueueRemove","summary":"Queue Remove"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove"]}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseResponseWrapper"}},"schemaId":"components/schemas/BaseResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1queue~1queue~1remove/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaseResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaseResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/queueremove"}],"panels":[]}]},"httpPath":"/air/queue/queue/remove"},{"label":"Queue List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/queues/createqueuelist","routeSlug":"/apis/flights/queues/createqueuelist","metadata":{"seo":{"title":"Queue List","description":"Queue List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateQueueList","name":"Queue List","isWebhook":false,"pointer":"/paths/~1air~1queue~1queue~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queue List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"retrieveAllInd","in":"query","schemaId":"schema_430","description":"If true, all reservations on queue will be retrieved when the maximum limit is reached for initial queue list."}],"pointer":"/paths/~1air~1queue~1queue~1list/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1queue~1queue~1list/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list"]}},"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list"],"pointer":"/paths/~1air~1queue~1queue~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/queue/queue/list","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"retrieveAllInd","in":"query","required":false,"example":true,"schemaId":"schema_430"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/queue/queue/list","href":"queues/createqueuelist","openApiOperationId":"CreateQueueList","summary":"Queue List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgencyQueueSummary","exampleIds":["paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list"]}},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgencyQueueResponseWrapper"}},"schemaId":"components/schemas/AgencyQueueResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1queue~1queue~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgencyQueueResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgencyQueueResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/createqueuelist"}],"panels":[]}]},"httpPath":"/air/queue/queue/list"}],"content":{"contentType":"group","meta":{"name":"Queues"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queues","showPageActions":true},{"nodeType":"markdoc","content":"Manage agency queues."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/queue/queue","summary":"Queue Placement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/queues/create","deprecated":false},{"title":"/air/queue/queue/remove","summary":"Queue Remove","prefix":{"name":"post","color":"post"},"badges":[],"link":"/queues/queueremove","deprecated":false},{"title":"/air/queue/queue/list","summary":"Queue List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/queues/createqueuelist","deprecated":false}]}]}]}]}},{"type":"group","label":"Travel Agency Details","link":"/apis/flights/travel-agency-details","routeSlug":"/apis/flights/travel-agency-details","items":[{"label":"Travel Agency Details (Single Payload)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/addagencydetails","routeSlug":"/apis/flights/travel-agency-details/addagencydetails","metadata":{"seo":{"title":"Travel Agency Details (Single Payload)","description":"Travel Agency Details (Single Payload)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddAgencyDetails","name":"Travel Agency Details (Single Payload)","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Details (Single Payload)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the travel agency details to","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail"]}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail"],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail"]}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency","href":"travel-agency-details/addagencydetails","openApiOperationId":"AddAgencyDetails","summary":"Travel Agency Details (Single Payload)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/addagencydetails"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency"},{"label":"Travel Agency Address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/addagencyaddress","routeSlug":"/apis/flights/travel-agency-details/addagencyaddress","metadata":{"seo":{"title":"Travel Agency Address","description":"Travel Agency Address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddAgencyAddress","name":"Travel Agency Address","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the travel agency details to","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add"]}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add"],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addaddress","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add"]}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addaddress","href":"travel-agency-details/addagencyaddress","openApiOperationId":"AddAgencyAddress","summary":"Travel Agency Address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/addagencyaddress"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addaddress"},{"label":"Travel Agency Address","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/updateagencyaddress","routeSlug":"/apis/flights/travel-agency-details/updateagencyaddress","metadata":{"seo":{"title":"Travel Agency Address","description":"Travel Agency Address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateAgencyAddress","name":"Travel Agency Address","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to update the travel agency details","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique Travel Agency ID","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update"]}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update"],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateaddress","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update"]}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateaddress","href":"travel-agency-details/updateagencyaddress","openApiOperationId":"UpdateAgencyAddress","summary":"Travel Agency Address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","exampleIds":["paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update"]}},"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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/updateagencyaddress"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateaddress"},{"label":"Travel Agency Address","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/deleteagencyaddress","routeSlug":"/apis/flights/travel-agency-details/deleteagencyaddress","metadata":{"seo":{"title":"Travel Agency Address","description":"Travel Agency Address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAgencyAddress","name":"Travel Agency Address","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteaddress~1{addressid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete the travel agency details","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique Travel Agency ID","required":true},{"name":"addressid","in":"path","schemaId":"schema_432","description":"The unique agency address id","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteaddress~1{addressid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteaddress~1{addressid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteaddress/{addressid}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"},{"name":"addressid","in":"path","required":true,"example":"address_001","schemaId":"schema_432"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteaddress/{addressid}","href":"travel-agency-details/deleteagencyaddress","openApiOperationId":"DeleteAgencyAddress","summary":"Travel Agency Address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"204","description":"No Content - Success"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteaddress~1{addressid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/deleteagencyaddress"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteaddress/{addressid}"},{"label":"Travel Agency Corporate ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/addcorporatecode","routeSlug":"/apis/flights/travel-agency-details/addcorporatecode","metadata":{"seo":{"title":"Travel Agency Corporate ID","description":"Travel Agency Corporate ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddCorporateCode","name":"Travel Agency Corporate ID","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addcorporatecode/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Corporate ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the travel agency details to","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addcorporatecode/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addcorporatecode/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper"}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper","pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addcorporatecode/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addcorporatecode","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper"}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addcorporatecode","href":"travel-agency-details/addcorporatecode","openApiOperationId":"AddCorporateCode","summary":"Travel Agency Corporate ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addcorporatecode/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/addcorporatecode"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addcorporatecode"},{"label":"Travel Agency Corporate ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/updatecorporatecode","routeSlug":"/apis/flights/travel-agency-details/updatecorporatecode","metadata":{"seo":{"title":"Travel Agency Corporate ID","description":"Travel Agency Corporate ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateCorporateCode","name":"Travel Agency Corporate ID","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatecorporatecode/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Corporate ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to update the travel agency details","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique travel agency id","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatecorporatecode/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatecorporatecode/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper"}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper","pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatecorporatecode/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatecorporatecode","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper"}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatecorporatecode","href":"travel-agency-details/updatecorporatecode","openApiOperationId":"UpdateCorporateCode","summary":"Travel Agency Corporate ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatecorporatecode/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/updatecorporatecode"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatecorporatecode"},{"label":"Travel Agency Corporate ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/deletecorporatecode","routeSlug":"/apis/flights/travel-agency-details/deletecorporatecode","metadata":{"seo":{"title":"Travel Agency Corporate ID","description":"Travel Agency Corporate ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCorporateCode","name":"Travel Agency Corporate ID","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletecorporatecode/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Corporate ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete the travel agency details from","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique travel agency id","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletecorporatecode/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletecorporatecode/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletecorporatecode","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletecorporatecode","href":"travel-agency-details/deletecorporatecode","openApiOperationId":"DeleteCorporateCode","summary":"Travel Agency Corporate ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"204","description":"No Content - Success"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletecorporatecode/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/deletecorporatecode"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletecorporatecode"},{"label":"Travel Agency Email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/addagencyemail","routeSlug":"/apis/flights/travel-agency-details/addagencyemail","metadata":{"seo":{"title":"Travel Agency Email","description":"Travel Agency Email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddAgencyEmail","name":"Travel Agency Email","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addemail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the travel agency details to","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addemail/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addemail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper"}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper","pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addemail/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addemail","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper"}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addemail","href":"travel-agency-details/addagencyemail","openApiOperationId":"AddAgencyEmail","summary":"Travel Agency Email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addemail/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/addagencyemail"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addemail"},{"label":"Travel Agency Email","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/updateagencyemail","routeSlug":"/apis/flights/travel-agency-details/updateagencyemail","metadata":{"seo":{"title":"Travel Agency Email","description":"Travel Agency Email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateAgencyEmail","name":"Travel Agency Email","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateemail/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to update the travel agency details","required":true},{"name":"id","in":"path","schemaId":"schema_408","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.","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateemail/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateemail/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper"}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper","pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateemail/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateemail","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"schemaId":"schema_408"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateemail","href":"travel-agency-details/updateagencyemail","openApiOperationId":"UpdateAgencyEmail","summary":"Travel Agency Email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper"}},"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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateemail/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/updateagencyemail"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateemail"},{"label":"Travel Agency Email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/deleteagencyemail","routeSlug":"/apis/flights/travel-agency-details/deleteagencyemail","metadata":{"seo":{"title":"Travel Agency Email","description":"Travel Agency Email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAgencyEmail","name":"Travel Agency Email","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteemail~1{emailid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete the travel agency details from","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique travel agency id","required":true},{"name":"emailid","in":"path","schemaId":"schema_433","description":"The unique email id","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteemail~1{emailid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteemail~1{emailid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteemail/{emailid}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"},{"name":"emailid","in":"path","required":true,"example":"email_001","schemaId":"schema_433"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteemail/{emailid}","href":"travel-agency-details/deleteagencyemail","openApiOperationId":"DeleteAgencyEmail","summary":"Travel Agency Email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"204","description":"No Content - Success"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deleteemail~1{emailid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/deleteagencyemail"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteemail/{emailid}"},{"label":"Travel Agency Telephone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/addagencytelephone","routeSlug":"/apis/flights/travel-agency-details/addagencytelephone","metadata":{"seo":{"title":"Travel Agency Telephone","description":"Travel Agency Telephone"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddAgencyTelephone","name":"Travel Agency Telephone","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addtelephone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Telephone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to add the travel agency details to","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addtelephone/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addtelephone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper"}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper","pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addtelephone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addtelephone","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper"}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addtelephone","href":"travel-agency-details/addagencytelephone","openApiOperationId":"AddAgencyTelephone","summary":"Travel Agency Telephone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addtelephone/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/addagencytelephone"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addtelephone"},{"label":"Travel Agency Telephone","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/updateagencytelephone","routeSlug":"/apis/flights/travel-agency-details/updateagencytelephone","metadata":{"seo":{"title":"Travel Agency Telephone","description":"Travel Agency Telephone"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateAgencyTelephone","name":"Travel Agency Telephone","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatetelephone/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Telephone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to update the travel agency details","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique travel agency id","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatetelephone/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatetelephone/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper"}},"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper","pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatetelephone/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatetelephone","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatetelephone","href":"travel-agency-details/updateagencytelephone","openApiOperationId":"UpdateAgencyTelephone","summary":"Travel Agency Telephone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper"}},"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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updatetelephone/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/updateagencytelephone"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatetelephone"},{"label":"Travel Agency Telephone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/travel-agency-details/deleteagencytelephone","routeSlug":"/apis/flights/travel-agency-details/deleteagencytelephone","metadata":{"seo":{"title":"Travel Agency Telephone","description":"Travel Agency Telephone"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAgencyTelephone","name":"Travel Agency Telephone","isWebhook":false,"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletetelephone~1{telephoneid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Telephone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier you wish to delete the travel agency details from","required":true},{"name":"id","in":"path","schemaId":"schema_431","description":"The unique travel agency id","required":true},{"name":"telephoneid","in":"path","schemaId":"schema_434","description":"The unique telephone id","required":true}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletetelephone~1{telephoneid}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletetelephone~1{telephoneid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletetelephone/{telephoneid}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"},{"name":"id","in":"path","required":true,"example":"agency_001","schemaId":"schema_431"},{"name":"telephoneid","in":"path","required":true,"example":"telephone_001","schemaId":"schema_434"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","204","400","401","402","403","404","500","503"],"pointer":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletetelephone/{telephoneid}","href":"travel-agency-details/deleteagencytelephone","openApiOperationId":"DeleteAgencyTelephone","summary":"Travel Agency Telephone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/TravelAgencyResponse"}},"schemaId":"components/schemas/TravelAgencyResponse"},{"code":"204","description":"No Content - Success"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1deletetelephone~1{telephoneid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TravelAgencyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TravelAgencyResponse"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/travel-agency-details/deleteagencytelephone"}],"panels":[]}]},"httpPath":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletetelephone/{telephoneid}"}],"content":{"contentType":"group","meta":{"name":"Travel Agency Details"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Travel Agency Details","showPageActions":true},{"nodeType":"markdoc","content":"Manage travel agency details that can be attached to a booking."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency","summary":"Travel Agency Details (Single Payload)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/travel-agency-details/addagencydetails","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addaddress","summary":"Travel Agency Address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/travel-agency-details/addagencyaddress","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateaddress","summary":"Travel Agency Address","prefix":{"name":"put","color":"put"},"badges":[],"link":"/travel-agency-details/updateagencyaddress","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteaddress/{addressid}","summary":"Travel Agency Address","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/travel-agency-details/deleteagencyaddress","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addcorporatecode","summary":"Travel Agency Corporate ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/travel-agency-details/addcorporatecode","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatecorporatecode","summary":"Travel Agency Corporate ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/travel-agency-details/updatecorporatecode","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletecorporatecode","summary":"Travel Agency Corporate ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/travel-agency-details/deletecorporatecode","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addemail","summary":"Travel Agency Email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/travel-agency-details/addagencyemail","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updateemail","summary":"Travel Agency Email","prefix":{"name":"put","color":"put"},"badges":[],"link":"/travel-agency-details/updateagencyemail","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deleteemail/{emailid}","summary":"Travel Agency Email","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/travel-agency-details/deleteagencyemail","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/addtelephone","summary":"Travel Agency Telephone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/travel-agency-details/addagencytelephone","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/updatetelephone","summary":"Travel Agency Telephone","prefix":{"name":"put","color":"put"},"badges":[],"link":"/travel-agency-details/updateagencytelephone","deprecated":false},{"title":"/air/ticket/travelagency/reservationworkbench/{ReservationResource_Identifier}/travelagency/{id}/deletetelephone/{telephoneid}","summary":"Travel Agency Telephone","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/travel-agency-details/deleteagencytelephone","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Booking Rules","link":"/apis/flights/custom-booking-rules","routeSlug":"/apis/flights/custom-booking-rules","items":[{"label":"Custom Rule List and Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/custom-booking-rules/getcustomrules","routeSlug":"/apis/flights/custom-booking-rules/getcustomrules","metadata":{"seo":{"title":"Custom Rule List and Details","description":"Custom Rule List and Details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCustomRules","name":"Custom Rule List and Details","isWebhook":false,"pointer":"/paths/~1air~1book~1customrule~1customrules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Rule List and Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"PCC","in":"query","schemaId":"schema_435","description":"The owning pcc of the custom rules"},{"name":"RuleRecordName","in":"query","schemaId":"schema_436","description":"The name of the rule record for a detail view of the rule. For multiple rules send space delimited list of strings"}],"pointer":"/paths/~1air~1book~1customrule~1customrules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1customrule~1customrules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/air/book/customrule/customrules","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[],"query":[{"name":"PCC","in":"query","required":false,"example":"0XS4","schemaId":"schema_435","style":"form","explode":true},{"name":"RuleRecordName","in":"query","required":false,"schemaId":"schema_436"}],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/customrule/customrules","href":"custom-booking-rules/getcustomrules","openApiOperationId":"GetCustomRules","summary":"Custom Rule List and Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/CustomRuleResponseWrapper"}},"schemaId":"components/schemas/CustomRuleResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1customrule~1customrules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomRuleResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomRuleResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-booking-rules/getcustomrules"}],"panels":[]}]},"httpPath":"/air/book/customrule/customrules"},{"label":"Custom Rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/custom-booking-rules/addcustomrule","routeSlug":"/apis/flights/custom-booking-rules/addcustomrule","metadata":{"seo":{"title":"Custom Rule","description":"Custom Rule"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"AddCustomRule","name":"Custom Rule","isWebhook":false,"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationWorkbench_Identifier","in":"path","schemaId":"schema_388","description":"The unique reservation workbench Identifer from your active workbench session where the custom rules shall be updated","required":true}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"PCC","in":"query","schemaId":"schema_435","description":"The owning pcc of the custom rules"},{"name":"RuleRecordName","in":"query","schemaId":"schema_436","description":"The name of the rule record for a detail view of the rule. For multiple rules send space delimited list of strings"}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationWorkbench_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"PCC","in":"query","required":false,"example":"0XS4","schemaId":"schema_435","style":"form","explode":true},{"name":"RuleRecordName","in":"query","required":false,"schemaId":"schema_436"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}","href":"custom-booking-rules/addcustomrule","openApiOperationId":"AddCustomRule","summary":"Custom Rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomRuleResponseWrapper"}},"schemaId":"components/schemas/CustomRuleResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomRuleResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomRuleResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-booking-rules/addcustomrule"}],"panels":[]}]},"httpPath":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}"},{"label":"Remove Custom Rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/custom-booking-rules/deletecustomrule","routeSlug":"/apis/flights/custom-booking-rules/deletecustomrule","metadata":{"seo":{"title":"Remove Custom Rule","description":"Remove Custom Rule"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCustomRule","name":"Remove Custom Rule","isWebhook":false,"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove Custom Rule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationWorkbench_Identifier","in":"path","schemaId":"schema_388","description":"The unique reservation workbench Identifer from your active workbench session where the custom rules shall be updated","required":true}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"PCC","in":"query","schemaId":"schema_435","description":"The owning pcc of the custom rules"},{"name":"RuleRecordSequence","in":"query","schemaId":"schema_437","description":"The sequence of the rule record to delete a specific rule record. Leave blank to delete all rules."}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationWorkbench_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"PCC","in":"query","required":false,"example":"0XS4","schemaId":"schema_435","style":"form","explode":true},{"name":"RuleRecordSequence","in":"query","required":false,"example":1,"schemaId":"schema_437"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}","href":"custom-booking-rules/deletecustomrule","openApiOperationId":"DeleteCustomRule","summary":"Remove Custom Rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/CustomRuleResponseWrapper"}},"schemaId":"components/schemas/CustomRuleResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1customrule~1customrules~1{ReservationWorkbench_Identifier}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomRuleResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomRuleResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-booking-rules/deletecustomrule"}],"panels":[]}]},"httpPath":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}"}],"content":{"contentType":"group","meta":{"name":"Custom Booking Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Booking Rules","showPageActions":true},{"nodeType":"markdoc","content":"Manage custom rules set up for your PCC."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/customrule/customrules","summary":"Custom Rule List and Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-booking-rules/getcustomrules","deprecated":false},{"title":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}","summary":"Custom Rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-booking-rules/addcustomrule","deprecated":false},{"title":"/air/book/customrule/customrules/{ReservationWorkbench_Identifier}","summary":"Remove Custom Rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-booking-rules/deletecustomrule","deprecated":false}]}]}]}]}},{"type":"group","label":"Deprecated","link":"/apis/flights/deprecated","routeSlug":"/apis/flights/deprecated","items":[{"label":"Update a Reservation","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/updatereservation","routeSlug":"/apis/flights/deprecated/updatereservation","metadata":{"seo":{"title":"Update a Reservation","description":"Update a Reservation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateReservation","name":"Update a Reservation","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Reservation","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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_388","description":"The Reservation Identifier of the Reservation you wish to update","required":true}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~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"}},"schemaId":"components/schemas/ReservationDetailWrapper","pointer":"/paths/~1air~1book~1reservation~1reservations~1{Identifier}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/book/reservation/reservations/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper"}},"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/{Identifier}","href":"deprecated/updatereservation","openApiOperationId":"UpdateReservation","summary":"Update a Reservation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationDetailWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper"}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/updatereservation"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/{Identifier}"},{"label":"Cancel an Offer Within a Reservation","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/cancelreservationoffer","routeSlug":"/apis/flights/deprecated/cancelreservationoffer","metadata":{"seo":{"title":"Cancel an Offer Within a Reservation","description":"Cancel an Offer by modifying the Reservation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CancelReservationOffer","name":"Cancel an Offer Within a Reservation","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations~1{reservationIdentifier}~1canceloffer/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an Offer Within a Reservation","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel an Offer by modifying the 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_388","description":"The Reservation Identifier that contains the Offer you wish to cancel","required":true}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{reservationIdentifier}~1canceloffer/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"supplierLocator","in":"query","schemaId":"schema_438","description":"The supplier locator of the Reservation you wish to cancel"},{"name":"offerID","in":"query","schemaId":"schema_439","description":"The Offer ID you wish to cancel"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{reservationIdentifier}~1canceloffer/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~1reservations~1{reservationIdentifier}~1canceloffer/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/air/book/reservation/reservations/{reservationIdentifier}/canceloffer","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"supplierLocator","in":"query","required":false,"example":"ABC123456","schemaId":"schema_438"},{"name":"offerID","in":"query","required":false,"example":"offer_1","schemaId":"schema_439"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations/{reservationIdentifier}/canceloffer","href":"deprecated/cancelreservationoffer","openApiOperationId":"CancelReservationOffer","summary":"Cancel an Offer Within a Reservation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/cancelreservationoffer"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations/{reservationIdentifier}/canceloffer"},{"label":"Create a Reservation","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/createreservation","routeSlug":"/apis/flights/deprecated/createreservation","metadata":{"seo":{"title":"Create a Reservation","description":"Create a reservation on the core or with the vendor/provider."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateReservation","name":"Create a Reservation","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1book~1reservation~1reservations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Reservation","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a reservation on the core or with the vendor/provider."},{"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_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1reservation~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"}},"schemaId":"components/schemas/ReservationDetailWrapper","pointer":"/paths/~1air~1book~1reservation~1reservations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/reservation/reservations","servers":[{"url":"/_mock/apis/flights","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_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper"}},"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/reservation/reservations","href":"deprecated/createreservation","openApiOperationId":"CreateReservation","summary":"Create a Reservation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/ReservationDetailWrapper","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReservationDetailWrapper"}},"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1reservation~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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/createreservation"}],"panels":[]}]},"httpPath":"/air/book/reservation/reservations"},{"label":"ReceiptResource - BuildFromLocator","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/buildreceiptsfromlocator","routeSlug":"/apis/flights/deprecated/buildreceiptsfromlocator","metadata":{"seo":{"title":"ReceiptResource - BuildFromLocator","description":"Process all unprocessed offers and create ticket receipts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildReceiptsFromLocator","name":"ReceiptResource - BuildFromLocator","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts~1buildfromlocator/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ReceiptResource - BuildFromLocator","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Process all unprocessed offers and create ticket receipts"},{"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts~1buildfromlocator/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"view","in":"query","schemaId":"schema_440","description":"The view. Either detail or summary"},{"name":"ReservationLocator","in":"query","schemaId":"schema_400","description":"The Reservation confirmation locator"},{"name":"Issuance","in":"query","schemaId":"schema_441","description":"The type of fulfillment required after document issuance"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts~1buildfromlocator/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts~1buildfromlocator/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts/buildfromlocator","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"view","in":"query","required":false,"example":"detail","schemaId":"schema_440"},{"name":"ReservationLocator","in":"query","required":false,"example":"ABC123","schemaId":"schema_400"},{"name":"Issuance","in":"query","required":false,"example":"All","schemaId":"schema_441"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","500","503"],"pointer":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts/buildfromlocator","href":"deprecated/buildreceiptsfromlocator","openApiOperationId":"BuildReceiptsFromLocator","summary":"ReceiptResource - BuildFromLocator"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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/ReceiptListResponseWrapper"}},"schemaId":"components/schemas/ReceiptListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1receipt~1reservations~1{ReservationResource_Identifier}~1receipts~1buildfromlocator/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReceiptListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReceiptListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/buildreceiptsfromlocator"}],"panels":[]}]},"httpPath":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts/buildfromlocator"},{"label":"Create a Workbench for Existing Booking","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/createreservationworkbenchfromidentifier","routeSlug":"/apis/flights/deprecated/createreservationworkbenchfromidentifier","metadata":{"seo":{"title":"Create a Workbench for Existing Booking","description":"Initiate a post-commit workbench to create a session for ticketing or updating an existing reservation. This is a prerequisite step for any transaction that modifies, updates, or tickets any PNR."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateReservationWorkbenchFromIdentifier","name":"Create a Workbench for Existing Booking","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromidentifier~1{Identifier}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Workbench for Existing Booking","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiate a post-commit workbench to create a session for ticketing or updating an existing reservation. This is a prerequisite step for any transaction that modifies, updates, or tickets any PNR."},{"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_388","description":"The Reservation Identifier or the Record Locator you would like to view and/or update","required":true}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromidentifier~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"detailViewInd","in":"query","schemaId":"schema_409","description":"If true, ReservationDetail will be returned."},{"name":"viewBrandCompleteInfoInd","in":"query","schemaId":"schema_409","description":"If true, Brand complete information will be returned in Reservation Response"},{"name":"viewBaggageDetailInd","in":"query","schemaId":"schema_409","description":"if true, full baggage information will be returned in Reservation Response"},{"name":"identifierType","in":"query","schemaId":"schema_422","description":"The type of identifier key used to retrieve the reservation","example":"Locator"},{"name":"documentType","in":"query","schemaId":"schema_423","description":"When document is selected in IdentifierType, use documentType to identify the type of document","example":"Ticket"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromidentifier~1{Identifier}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromidentifier~1{Identifier}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/session/reservationworkbench/buildfromidentifier/{Identifier}","servers":[{"url":"/_mock/apis/flights","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,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"detailViewInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBrandCompleteInfoInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"viewBaggageDetailInd","in":"query","required":false,"schemaId":"schema_409"},{"name":"identifierType","in":"query","required":false,"example":"Locator","schemaId":"components/schemas/IdentifierTypeENUM"},{"name":"documentType","in":"query","required":false,"example":"Ticket","schemaId":"components/schemas/DocumentTypeEnum"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","201","400","401","402","403","404","500","503"],"pointer":"/air/book/session/reservationworkbench/buildfromidentifier/{Identifier}","href":"deprecated/createreservationworkbenchfromidentifier","openApiOperationId":"CreateReservationWorkbenchFromIdentifier","summary":"Create a Workbench for Existing Booking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","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":"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/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1session~1reservationworkbench~1buildfromidentifier~1{Identifier}/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/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/createreservationworkbenchfromidentifier"}],"panels":[]}]},"httpPath":"/air/book/session/reservationworkbench/buildfromidentifier/{Identifier}"},{"label":"Not Implemented","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/buildfromofferlist","routeSlug":"/apis/flights/deprecated/buildfromofferlist","metadata":{"seo":{"title":"Not Implemented","description":"Create and Offer by referencing the OfferList Identifier which is returned in the Price response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BuildFromOfferList","name":"Not Implemented","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromofferlist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Not Implemented","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create and Offer by referencing the OfferList Identifier which is returned in the Price 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":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromofferlist/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromofferlist/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildfromOfferList"}},"schemaId":"components/schemas/OfferQueryBuildfromOfferList","pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromofferlist/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromofferlist","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildfromOfferList"}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromofferlist","href":"deprecated/buildfromofferlist","openApiOperationId":"BuildFromOfferList","summary":"Not Implemented"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/OfferQueryBuildfromOfferList","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OfferQueryBuildfromOfferList"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromofferlist/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/buildfromofferlist"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromofferlist"},{"label":"Create Refund or Passive Offer","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/flights/deprecated/deprecatedcreatemanualoffer","routeSlug":"/apis/flights/deprecated/deprecatedcreatemanualoffer","metadata":{"seo":{"title":"Create Refund or Passive Offer","description":"Create Refund or Passive Offer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeprecatedCreateManualOffer","name":"Create Refund or Passive Offer","deprecated":true,"isWebhook":false,"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Refund or Passive Offer","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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":"ReservationResource_Identifier","in":"path","schemaId":"schema_388","description":"The Reservation Identifier","required":true}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offerType","in":"query","schemaId":"schema_442","description":"Specifies the type of Offer that is being created"},{"name":"offerIdentifier","in":"query","schemaId":"schema_443","description":"The offer ID you wish to refund or exchange. Use when multiple offers exist within a reservation."}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"TraceId","in":"header","schemaId":"schema_382","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_383","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_384","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_385","description":"Allows user to pass PCC instead of Access Group ID"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Offer"}},"schemaId":"components/schemas/Offer","pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers","servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"parameters":{"path":[{"name":"ReservationResource_Identifier","in":"path","required":true,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_388"}],"query":[{"name":"offerType","in":"query","required":false,"example":"AgencyCalculatedRefund","schemaId":"components/schemas/OfferTypeENUM"},{"name":"offerIdentifier","in":"query","required":false,"example":"offer_1","schemaId":"schema_443"}],"querystring":[],"header":[{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_382","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_383","style":"simple","explode":false},{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_384","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_385","style":"simple","explode":false}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Offer"}},"responseCodes":["201","400","401","402","403","404","500","503"],"pointer":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers","href":"deprecated/deprecatedcreatemanualoffer","openApiOperationId":"DeprecatedCreateManualOffer","summary":"Create Refund or Passive Offer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/flights","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11"},{"url":"https://api.travelport.net/11"}],"schemaId":"components/schemas/Offer","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Offer"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created - 201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}},"schemaId":"components/schemas/OfferListResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"503","description":"Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.","mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_386"}],"pointer":"/paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OfferListResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OfferListResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"503","schemaId":"schema_386","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_386"},"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/deprecated/deprecatedcreatemanualoffer"}],"panels":[]}]},"httpPath":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers"}],"content":{"contentType":"group","meta":{"name":"Deprecated"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deprecated","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/air/book/reservation/reservations/{Identifier}","summary":"Update a Reservation","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/deprecated/updatereservation","deprecated":true},{"title":"/air/book/reservation/reservations/{reservationIdentifier}/canceloffer","summary":"Cancel an Offer Within a Reservation","prefix":{"name":"put","color":"http-deprecated"},"badges":[],"link":"/deprecated/cancelreservationoffer","deprecated":true},{"title":"/air/book/reservation/reservations","summary":"Create a Reservation","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated/createreservation","deprecated":true},{"title":"/air/receipt/reservations/{ReservationResource_Identifier}/receipts/buildfromlocator","summary":"ReceiptResource - BuildFromLocator","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated/buildreceiptsfromlocator","deprecated":true},{"title":"/air/book/session/reservationworkbench/buildfromidentifier/{Identifier}","summary":"Create a Workbench for Existing Booking","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated/createreservationworkbenchfromidentifier","deprecated":true},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers/buildfromofferlist","summary":"Not Implemented","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated/buildfromofferlist","deprecated":true},{"title":"/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/offers","summary":"Create Refund or Passive Offer","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/deprecated/deprecatedcreatemanualoffer","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ReferenceListSeatingChart":{"id":"components/schemas/ReferenceListSeatingChart","kind":"json-schema","title":"ReferenceListSeatingChart","data":{"description":"ReferenceList is used to reduce the size of the payload when multiple occurrences of the same object appear in the response. SeatingChart is used in the Seat Availability Response","allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"SeatingChart":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/SeatingChart"}}}}]}},"components/schemas/CatalogProductOfferingsQueryRequest":{"id":"components/schemas/CatalogProductOfferingsQueryRequest","kind":"json-schema","title":"CatalogProductOfferingsQueryRequest","data":{"required":["@type","CatalogProductOfferingsRequest"],"properties":{"@type":{"type":"string","description":"Discriminator class CatalogProductOfferingsQueryRequest only","example":"CatalogProductOfferingsQueryRequest"},"CatalogProductOfferingsRequest":{"$ref":"#/components/schemas/CatalogProductOfferingsRequestAir"}},"description":"Used for an Air Search request. Defines the top-level request payload for searching flight offers, including itinerary, passenger, and optional search modifiers.  \nFor round-trip and multi-city requests, you can set the Search to return offers for the full itinerary (a journey-based search), or for only the first leg (a leg-based search) and follow it with a Next Leg Search. Any modifiers or indicators sent in the Search request carry over to the Next Leg Search request and are not re-sent."}},"components/schemas/CatalogProductOfferingsRequestAir":{"id":"components/schemas/CatalogProductOfferingsRequestAir","kind":"json-schema","title":"CatalogProductOfferingsRequestAir","data":{"required":["PassengerCriteria","SearchCriteriaFlight"],"description":"Used for an Air Search request. Defines the request-wide search options for the initial shopping call, including content source, option to use the cache, passenger and flight search criteria, optional search and pricing refinement modifiers, and more.","allOf":[{"$ref":"#/components/schemas/CatalogProductOfferingsRequest"},{"properties":{"offersPerPage":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported for AirSearch. Not suported for Air Availability."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This modifier has two functions:"},"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":"Maximum offers returned: sets the maximum number of offers returned. If sent with 0 or not sent, Search returns all offers. If fewer offers than specified in offersPerPage are available, all available offers are returned."},"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":"Enable caching: Sets whether to invoke caching so that journey-based search results can be referenced by subsequent reference payload requests. Send with any number equal to or greater than 1. No maximum value."},"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":"If offersPerPage is not sent for a journey-based search, the results are not cached and the response does not return a transaction identifier. Any subsequent reference payload requests fail, including the Flight Specific Search, AirPrice, and Add Offer reference payloads."},"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":"Does not affect leg-based search results, which are cached by default."},"children":[]}]}]}]}]}]}]}],"format":"int32","example":45},"contentSourceList":{"type":"array","description":"Supports requesting both or either GDS or NDC content. If not sent only GDS content is returned. Send both values to return aggregated GDS and NDC content","example":["NDC"],"items":{"$ref":"#/components/schemas/ContentSourceEnum"}},"maxNumberOfUpsellsToReturn":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the specified number of upsell fares for each base fare; upsell fares are the next highest fares in a different brand or cabin. You may request up to 4 for GDS, 99 for NDC, or as many filed by the airline if fewer than the value sent are available. Values greater than these supported values do not return an error message, but instead max out at the supported upsells per base fare."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value carries over to any follow-on Next Leg Search request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsells are not returned in a specific object but rather are presented along with the base fare as a higher level of service, usually a branded fare."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following differences for GDS and NDC:"},"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":"For GDS: when maxNumberOfUpsellsToReturn is either not sent or sent as 0, the lowest priced offer is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NDC: When maxNumberOfUpsellsToReturn is not sent, the response returns the lowest priced offer of each available brand or cabin. When maxNumberOfUpsellsToReturn=0, the response returns just the lowest priced offer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of upsells that can be requested are limited for multi-city itineraries: four to six O&Ds are limited to one upsell; three O&Ds are limited to two upsells; and one or two O&Ds (one-way or round-trip itineraries) can have up to four upsells for GDS or 99 for NDC."},"children":[]}]}]}],"format":"int32","example":3},"numberOfDownsellsToReturn":{"type":"integer","description":"Not supported. Use BrandOptions.","format":"int32","example":2,"deprecated":true},"sortBy":{"$ref":"#/components/schemas/SortByEnum"},"PassengerCriteria":{"maxItems":10,"type":"array","description":"Defines the type of passenger traveling. Send one instance of PassengerCriteria for each passenger type code (PTC).  \nSearch supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation. Can include optional traveler details such as age, birth date, loyalty, and geographic location when needed.  \nMay include the optional CustomerLoyalty object.","items":{"$ref":"#/components/schemas/PassengerCriteria"}},"SearchCriteriaFlight":{"maxItems":20,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each instance defines one leg of the itinerary by specifying an origin and destination (O&D) pair, aka departure and arrival location, for that leg. Optionally includes travel timing. Send one instance of SearchCriteriaFlight for each leg of the itinerary. You must specify all O&D pairs for all legs of the itinerary, even for a leg-based search. Search, Next Leg Search, and Flight Specific Search support a maximum of 6 O&D pairs for both GDS and NDC."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/SearchCriteriaFlight"}},"SearchModifiersAir":{"$ref":"#/components/schemas/SearchModifiersAir"},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"SearchType":{"$ref":"#/components/schemas/SearchTypeEnum"},"inhibitBrandContentInd":{"type":"boolean","description":"Deprecated. Not supported as part of Air Search request.","example":true,"deprecated":true},"detailViewInd":{"type":"boolean","description":"Deprecated. Not supported as part of Air Search request.","example":true,"deprecated":true},"excludeMixedBrandsInd":{"type":"boolean","description":"Deprecated. Not supported as part of Air Search request.","example":true,"deprecated":true}}}]}},"components/schemas/CatalogProductOfferingsRequest":{"id":"components/schemas/CatalogProductOfferingsRequest","kind":"json-schema","title":"CatalogProductOfferingsRequest","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes CatalogProductOfferingsRequest and CatalogProductOfferingsRequestAir","example":"CatalogProductOfferingsRequestAir"},"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/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/SortByEnum":{"id":"components/schemas/SortByEnum","kind":"json-schema","title":"SortByEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorts offers in order by the value in BestCombinablePrice/TotalPrice."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported value:"},"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":"Price-LowToHigh: Sorts the offers returned from lowest to highest price."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported for GDS, NDC, and combined GDS and NDC content. If sent, this sorting also applies to any following Next Leg Search. Upsell offers are not sorted."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travelport recommends as best practice that when sending sortBy and requesting NDC content, do not also send offersPerPage. If sent together some offers may be incomplete. SortBy cannot be requested in conjunction with premium flex search and will be ignored."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following when requesting NDC content:"},"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":"NDC-only content when multiple NDC carriers return offers:"},"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":"Without sorting: Search returns NDC offers consecutively by carrier; for example, all NDC AA offers, followed by all NDC UA offers."},"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":"With sorting: Search returns all offers in ascending price order regardless of carrier."},"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":"GDS and NDC combined content:"},"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":"Without sorting: Search returns offers by carrier. First for GDS and then for NDC; for example, GDS AA offers, NDC AA offers, GDS UA offers, NDC UA offers."},"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":"With sorting: Search returns all offers in ascending price order regardless of carrier or content source."},"children":[]}]}]}]}]}]}]}],"example":"Price-LowToHigh","enum":["Price-LowToHigh"]}},"components/schemas/PassengerCriteria":{"id":"components/schemas/PassengerCriteria","kind":"json-schema","title":"PassengerCriteria","data":{"required":["@type","number"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"PassengerCriteria"},"number":{"type":"integer","description":"The amount of passengers associated with this passenger type code. Default is 1.","format":"int32","example":1},"age":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The age of the passenger."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes on PTC and age:"},"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":"Travelport recommends sending age only with PTCs that require age for pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the age is sent in the request, for NDC only, the age is returned in the pricing response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Not all fares cannot be quoted for CHD."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The age for INF must be either 0 or 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate)."},"children":[]}]}]}]}],"format":"int32","example":26},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The passenger type code (PTC) for the passengers on the itinerary. Required field for Air Search and Flight specific search."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common PTCs are:"},"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":"ADT: adult"},"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":"CHD: child of unknown age"},"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":"For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD."},"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":"CNN: child when age is known"},"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":"The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country."},"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":"INF: infant without a seat"},"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":"INS: infant with a seat"},"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":"UNN: unaccompanied child."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See API guides to download a full list of PTCs. NDC carriers AF, KL, SQ, QR, AV, MH, SK, AY, BR, CX, EY, AA, QF, UA, EK, LHG, BA, AC, TO, NH, SV, and RJ offer teen/young adult tax exemptions from the UK Air Passenger Duty (GB tax). Send PTC with the value YTH and send the passengers age per below. The PTC may be returned as ADT, or Cxx in which xx is the age, but the tax exemption is applied in the pricing on these NDC carriers."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For marine fares, send the PTC value SEA. You must also send OSI remarks at Add Traveler with the vessel name and location. Marine fares are private fares for travelers going to or from a vessel. NDC only; not supported for GDS."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When running a multiple passenger search for NDC on Qantas, Qantas supports only these PTCs: ADT, CHD, CNN, INF. Sending any other PTC may result in an error at ticketing."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any traveler sent without a PTC value is defaulted to ADT. PTC can be sent or omitted for ADT passenger. AirReservation defaults the PTC to ADT and returns it in the Reservation Retrieve."},"children":[]}]}]}],"example":"ADT"},"birthDate":{"type":"string","description":"The date of birth of the passenger. May be used in age validation for fares with age restrictions.","format":"Date","example":"2020-01-16"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AirSearch: NDC only, not supported for GDS. Required when using Air Canada flight pass to pay for NDC flight."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AirPrice: supported for both GDS and NDC with unique functionality."},"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":"For NDC: use id in the AirSearch and AirPrice (both full and reference payloads) to assign a custom passenger id to be returned in the response, which supports matching that specific passenger to the PriceBreakdown in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For GDS: in the full payload AirPrice request only, use id to send a custom passenger id only when requesting pricing for one or more specific passengers with OfferConstruction. If not sent, pricing for all passengers is returned. GDS only; not supported for this use in NDC."},"children":[]}]}]}]}],"example":"passengercriteria_001"},"CustomerLoyalty":{"maxItems":100,"type":"array","description":"NDC only; not supported for GDS.  \nOptional object for sending customer loyalty information, such as for a frequent flyer program.  \nRequired when using Air Canada flight pass to pay for NDC flight. Must contain flight pass owner's information, including value, supplier, given name, and surname (or cardholder name). Optional for other passengers in the booking.  \nIf CustomerLoyalty is sent in the Search request, it must also be sent in the Air Price request and the Add Traveler request. As some carriers validate frequent traveler data through the workflow, failing to send the same CustomerLoyalty details, even if invalid, may cause a booking failure. If an invalid number is sent, the response returns a warning message that the FQTV is invalid, and the invalid number is cached to prevent a potential booking failure.  ","items":{"$ref":"#/components/schemas/CustomerLoyalty"}},"TravelerGeographicLocation":{"$ref":"#/components/schemas/TravelerGeographicLocation"},"specifiedPassengerTypeCodeOnlyInd":{"type":"boolean","description":[{"$$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":"If true: returns only offers for the specified PTC. If no fares are available for the specified PTC, returns an error message that there is no valid fare."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): If no fares are available for the specified PTC, returns fares for the default ADT (adult) PTC instead."},"children":[]}]}]}]}],"example":true}},"description":"Defines the passenger criteria. Send one PassengerCriteria for each passenger type code (PTC).  \nSearch supports up to 9 total passengers. A maximum of 6 PTCs are supported for GDS. NDC does not have a PTC limitation.  \nAirPrice supports up to nine total passengers across all PTCs.  ","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/TravelerGeographicLocation":{"id":"components/schemas/TravelerGeographicLocation","kind":"json-schema","title":"TravelerGeographicLocation","data":{"properties":{"value":{"maxLength":32,"type":"string","description":"IATA code for the city, country, or state/province relevant to the local citizen//local resident fare.","example":"PMI"},"travelerGeographicLocationType":{"$ref":"#/components/schemas/TravelerGeographicTypeEnum"},"residentGeographicCode":{"type":"string","description":"Resident code for Spanish residency fares for NDC. Any discount will apply to all travelers, not only to the traveler in this instance of PassengerCriteria. Supported/validated only for NDC to support local citizen fares."},"generalLargeFamilyResidentDiscountInd":{"type":"boolean","description":"Send only if true and request qualifies for general large family resident discount, defined as general large families (up to three children) from Spain, from the EU/EEA, or of any other nationality whose residency in Spain is recognized and who are in possession of a large-family certificate issued by the autonomous community in which they live. Supported/validated only for NDC to support local citizen fares.","example":true},"specialLargeFamilyResidentDiscountInd":{"type":"boolean","description":"Send only if true and request qualifies for special large family resident discount, defined as special large families (four or more children) from Spain, from the EU/EEA, or of any other nationality whose residency in Spain is recognized and who are in possession of a large-family certificate issued by the autonomous community in which they live. Supported/validated only for NDC to support local citizen fares.","example":true}},"description":"For AirSearch: supported/validated only for NDC to support local citizen fares. For AirPrice and AirReservation: GDS only; not supported for NDC.  \nOptional object for requesting local citizen/local resident fares for Spain and associated islands.  \nYou must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident.  \nAny discount applied through TravelerGeographicLocation applies to all travelers, not only to the traveler in this instance of PassengerCriteria. If the discount must apply only to an individual traveler, that traveler requires a separate search and book workflow."}},"components/schemas/TravelerGeographicTypeEnum":{"id":"components/schemas/TravelerGeographicTypeEnum","kind":"json-schema","title":"TravelerGeographicTypeEnum","data":{"type":"string","description":"The type of location where the fare is valid.","example":"City","enum":["Country","StateProvince","City"]}},"components/schemas/SearchCriteriaFlight":{"id":"components/schemas/SearchCriteriaFlight","kind":"json-schema","title":"SearchCriteriaFlight","data":{"required":["From","To"],"properties":{"departureDate":{"type":"string","description":"Preferred local departure date in YYYY-MM-DD format.  \nFor GDS, send either departureDate or arrivalDate. If both departureDate and arrivalDate are sent, departureDate is ignored.   \nFor NDC, departureDate is required.  ","format":"date"},"daysBeforeDeparture":{"type":"integer","description":"GDS only; not supported for NDC. Available for flex search only; must append /premiumflex to the endpoint.  \nSend to specify a number of days to search before the date in departureDate, up to three days. ","format":"int32","example":1},"daysAfterDeparture":{"type":"integer","description":"GDS only; not supported for NDC. Available for flex search only; must append /premiumflex to the endpoint.  \nSend to specify a number of days to search after the date in departureDate, up to three days.","format":"int32","example":2},"departureTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns NDC offers with flights between two hours before and two hours after the departure time."},"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":"Ex: for departureTime of 10:00:00, Search returns available flights between 8:00 and 12:00."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NDC content, if multiple time options are sent in the same instance of SearchCriteriaFlight, they are applied in the order DepartureTimeRange, departureTime, and arrivalTime."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not use for GDS; instead, use DepartureTimeRange."},"children":[]}]}]}],"format":"time","example":"07:00:00"},"arrivalDate":{"type":"string","description":"Date of arrival in YYYY-MM-DD format.  \nFor GDS, send either arrivalDate or departureDate. If both departureDate and arrivalDate are sent, departureDate is ignored.  \nFor NDC, arrivalDate is optional and departureDate is always required; if sent, offers returned are filtered by both arrivalDate and departureDate.","format":"date"},"arrivalTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns NDC offers with flights between two hours before and two hours after the arrival time."},"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":"Ex: for arrivalTime of 10:00:00, Search returns available flights between 8:00 and 12:00."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not use for GDS; instead, use ArrivalTimeRange."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported only by specific NDC carriers. For detailed NDC support by carrier, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/ndc/ndc-guide#ndc-carrier-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC Carrier Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation."},"children":[]}]}]}],"format":"time","example":"09:15:00"},"legSequence":{"type":"integer","description":"Recommended to send when requesting cabin, class of service, and/or connection preferences at the leg level. Do not send if requesting preferences at itinerary level.","format":"int32"},"From":{"$ref":"#/components/schemas/FromTo"},"To":{"$ref":"#/components/schemas/FromTo"},"AdditionalFrom":{"maxItems":5,"type":"array","description":"Available for flex search only. Select additional origin cities to expand your flight options.","items":{"$ref":"#/components/schemas/AdditionalFromTo"}},"AdditionalTo":{"maxItems":5,"type":"array","description":"Available for flex search only. Select additional destination cities to expand your flight options.","items":{"$ref":"#/components/schemas/AdditionalFromTo"}},"DepartureTimeRange":{"$ref":"#/components/schemas/TimeRange"},"ArrivalTimeRange":{"$ref":"#/components/schemas/TimeRange"}},"description":"Flight search criteria."}},"components/schemas/FromTo":{"id":"components/schemas/FromTo","kind":"json-schema","title":"FromTo","data":{"properties":{"value":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The IATA airport or city code for the departure or arrival airport/city for this leg.","example":"MEX"},"cityOrAirport":{"$ref":"#/components/schemas/CityOrAirportEnum"},"radius":{"type":"integer","description":"Available for flex search only. Return offers from airports within a specified distance from the origin and/or destination.","format":"int32","example":50},"radiusMeasurement":{"$ref":"#/components/schemas/UnitOfDistanceEnum"}},"description":"Origin Destination Information"}},"components/schemas/CityOrAirportEnum":{"id":"components/schemas/CityOrAirportEnum","kind":"json-schema","title":"CityOrAirportEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options."},"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":"Airport code with no cityOrAirport value: expands the availability selection to the city while giving preference to the requested airport."},"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":"For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA."},"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":"City code with no cityOrAirport value: returns an unweighted selection of inventory for all airports in the city."},"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":"For example, NYC would search content equally between LGA, EWR, and JFK."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This behavior also applies to:"},"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":"City code with Airport Only"},"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":"Note: For NDC, do not use the Airport Only value, as any flight segment that does not match the search criteria are removed."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City code with City Only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"City or Airport code with City or Airport."},"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":"Note: Use this value when sending metro codes, such as PAR, LON, and NYC."},"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":"Airport code with cityOrAirport value Airport Only: returns content only from the specified airport."},"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":"For example, LGA will return content from only LGA."},"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":"Airport code with cityOrAirport value City: expands the availability selection to the city without giving preference to the requested airport."},"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":"For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This behavior is equivalent to searching by the airport city code."},"children":[]}]}]}]}]}]}],"example":"City or Airport","enum":["Airport Only","City or Airport","City Only","Use Default"]}},"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/AdditionalFromTo":{"id":"components/schemas/AdditionalFromTo","kind":"json-schema","title":"AdditionalFromTo","data":{"properties":{"value":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The additional IATA airport or city codes for the departure or arrival airport/city for this leg.","example":"LGW"},"cityOrAirport":{"$ref":"#/components/schemas/CityOrAirportEnum"}},"description":"Available for flex search only. Select additional origin and destination cities to expand your flight options."}},"components/schemas/TimeRange":{"id":"components/schemas/TimeRange","kind":"json-schema","title":"TimeRange","data":{"properties":{"start":{"type":"string","description":"The start time of the departure or arrival time window to search. Either start or end is required.","example":"06:15:00"},"end":{"type":"string","description":"The end time of the departure or arrival time window to search. Either start or end is required.","example":"09:15:00"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Air Search API supports searching by a departure or arrival time window for any leg of the itinerary."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NDC, supported only by specific NDC carriers. For detailed NDC support by carrier, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/ndc/ndc-guide#ndc-carrier-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC Carrier Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation."},"children":[]}]}]}]}},"components/schemas/SearchModifiersAir":{"id":"components/schemas/SearchModifiersAir","kind":"json-schema","title":"SearchModifiersAir","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"discriminator","example":"SearchModifiersAir"},"excludeGround":{"$ref":"#/components/schemas/ExcludeGroundTypeEnum"},"CarrierPreference":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/CarrierPreference"}},"CabinPreference":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/CabinPreference"}},"ClassOfServicePreference":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/ClassOfServicePreference"}},"ProductInclusionPreference":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/ProductInclusionPreference"}},"ConnectionPreferences":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/ConnectionPreferencesAir"}},"prohibitChangeOfAirportInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suppresses return of offers that require a change of airport at connection."},"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":"If true: excludes itineraries that require changing airports during connections."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): may return itineraries that require change of airport."},"children":[]}]}]}]}],"example":true}},"description":"Add one or more optional modifiers to filter search results by criteria related to the journey itself.  \nAll journey modifiers are in CatalogProductOfferingsQueryRequest/CatalogProductOfferingsRequest/SearchModifiersAir.  \nAny modifiers sent in the initial Search request are applied to any subsequent Next Leg Search request.  \nAll modifiers apply to the entire itinerary, not at the leg level, unless otherwise specified with legSequence per below."}},"components/schemas/ExcludeGroundTypeEnum":{"id":"components/schemas/ExcludeGroundTypeEnum","kind":"json-schema","title":"ExcludeGroundTypeEnum","data":{"type":"string","description":"GDS only, not supported for NDC.  \nExcludes certain ground transportation from the response. By default, the response may return ground transportation options such as trains and buses, depending on the routing.  \nIn the response, ground transportation options are identified in ReferenceList/Flight by the TRN, TRS, or BUS equipment codes.","example":"Train","enum":["Train","All"],"x-enumDescriptions":{"Train":"Excludes only train travel but not other types of ground transportation.","All":"Excludes all ground transportation."}}},"components/schemas/CarrierPreference":{"id":"components/schemas/CarrierPreference","kind":"json-schema","title":"CarrierPreference","data":{"required":["@type","carriers","preferenceType"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes exist","example":"CarrierPreference"},"preferenceType":{"$ref":"#/components/schemas/CarrierPreferenceTypeEnum"},"carriers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more carrier codes to permit, prohibit, or prefer. Preferred alliances are also supported; send the alliance code (e.g., /*A) instead of the carrier code."},"children":[]}]}]}],"items":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","example":"BA"}},"legSequence":{"type":"array","description":"Applies the carrier/alliance preference to only specific legs of the itinerar referencing legSequence sent in SearchCriteriaFlight. Do not send if requesting preference at itinerary level. GDS only, not supported for NDC.","example":[1,2],"items":{"type":"integer","format":"int32"}}},"description":"Preference for specific airline/s, allowing you to limit, exclude, or weight toward one or more carriers. Only one carrier preference type is allowed per request, but there is no limit to the number of carriers that can be permitted, prohibited, or preferred. Any preferences sent in the initial Search request are applied to any subsequent Next Leg Search request."}},"components/schemas/CarrierPreferenceTypeEnum":{"id":"components/schemas/CarrierPreferenceTypeEnum","kind":"json-schema","title":"CarrierPreferenceTypeEnum","data":{"type":"string","description":"The type of carrier preference","example":"Preferred","enum":["Preferred","Permitted","Prohibited"],"x-enumDescriptions":{"Preferred":"Includes preferred carrier or carriers as well as interline connections with other carriers. If you request a carrier without any service on the requested route, the response returns no offers. Preferred alliances are supported for GDS only. Not supported for NDC. Send the alliance code instead of the carrier code.","Permitted":"Returns only results on the specified carrier or carriers. An error is returned if the carrier/s do not have any availability within the requested search parameters.","Prohibited":"Excludes results from the specified marketing carrier or carriers. GDS only. NDC does not supported prohibited carriers."}}},"components/schemas/CabinPreference":{"id":"components/schemas/CabinPreference","kind":"json-schema","title":"CabinPreference","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes exist","example":"CabinPreference"},"preferenceType":{"$ref":"#/components/schemas/CabinPreferenceTypeEnum"},"cabins":{"type":"array","description":"A space-delimited list of cabins.","items":{"$ref":"#/components/schemas/CabinAirEnum"}},"legSequence":{"type":"array","description":"Leg level preference is supported only for CarrierPreference, CabinPreference, and ClassOfServicePreference. Not supported at AirPrice or Book.  \nLimits preference to the specified leg.  You can apply the preference to only some legs of the itinerary, or different preferences to different legs. Best practice is to also send legSequence in SearchCriteriaFlight. To apply preference to the entire itinerary, do not send legSequence.  ","example":[1,2],"items":{"type":"integer","format":"int32"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent."},"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 CabinPreference in the initial Search request is applied to any subsequent Next Leg Search and reference Flight Specific Search requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In AirPrice and AirReservation only one cabin preference type is allowed per request, but there is no limit to the number of cabins that can be sent. If CabinPreference was sent in the Search request, it is cached and sent with the AirPrice reference payload request. If you send CabinPreference in the AirPrice request, all cached modifiers are discarded and only the modifiers sent in the AirPrice request are used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can be combined with lowFareFinderInd=true to return lowest fare in the requested cabin or cabins. When using CabinPreference and lowFareFinderInd, if both CabinPreference and a class of service are sent, class of service is ignored. If CabinPreference is sent without a class of service, the response returns the lowest fare in the cabin requested. If that cabin is not available, the response may upgrade or downgrade to a different cabin. If a different cabin than requested is returned, the response returns the message that the cabin class may differ from the class requested. If lowFareFinderInd=false and CabinPreference are sent in the request, AirPrice ignores the preferred cabin and returns a message that the preferred cabin was ignored."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If CabinPreference is set to All, no cabin preference is applied."},"children":[]}]}]}]}},"components/schemas/CabinPreferenceTypeEnum":{"id":"components/schemas/CabinPreferenceTypeEnum","kind":"json-schema","title":"CabinPreferenceTypeEnum","data":{"type":"string","description":"Type of cabin preference.  \nSending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference.  \nNote that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted.","example":"Preferred","enum":["Preferred","Permitted","PreferredWithUpgrade","Prohibited"],"x-enumDescriptions":{"Permitted":"Searches for only the specified class or classes. If that class is not available, the response does not return any offers.","Preferred":"Searches for the specified class or classes, but will return lower classes if the specified class is not available.","PreferredWithUpgrade":"Searches for the specified class or classes, and will return higher classes if the specified class is not available.","Prohibited":"Not supported"}}},"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/ClassOfServicePreference":{"id":"components/schemas/ClassOfServicePreference","kind":"json-schema","title":"ClassOfServicePreference","data":{"required":["ClassesOfService"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes exist","example":"ClassOfServicePreference"},"legSequence":{"type":"array","description":"Applies preference to specified leg/s of the itinerary, referencing the leg sequence in SearchCriteriaFlight. Do not send if requesting preference at itinerary level.","example":[1,2],"items":{"type":"integer","format":"int32"}},"ClassesOfService":{"type":"array","description":"One or more classes of service to permit or prohibit.","example":["F"],"items":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","example":"F"}},"PreferenceType":{"$ref":"#/components/schemas/ClassOfServicePreferenceTypeEnum"}},"description":"Specifies preference around a class of service."}},"components/schemas/ClassOfServicePreferenceTypeEnum":{"id":"components/schemas/ClassOfServicePreferenceTypeEnum","kind":"json-schema","title":"ClassOfServicePreferenceTypeEnum","data":{"type":"string","description":"Class of Service preference options.  ","example":"Preferred","enum":["Preferred","Permitted","Prohibited"],"x-enumDescriptions":{"Permitted":"Searches for ONLY the specified class of service. No offers returned if not available.","Prohibited":"Excludes class of service from offers returned.","Preferred":"Not supported"}}},"components/schemas/ProductInclusionPreference":{"id":"components/schemas/ProductInclusionPreference","kind":"json-schema","title":"ProductInclusionPreference","data":{"required":["Classification"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes exist","example":"ProductInclusionPreference"},"legSequence":{"type":"array","description":"Leg sequence is not supported for ProductInclusionPreference. Preference will be applied to the whole journey.","example":[1,2],"deprecated":true,"items":{"type":"integer","format":"int32"}},"Classification":{"maxItems":10,"minItems":1,"type":"array","description":"Send one or more of the enumerated values to return only fares that include those attributes in the price. For example, sending CarryOn returns only fares that include a carry-on bag in the price.","example":["CheckedBag"],"items":{"$ref":"#/components/schemas/BrandClassificationEnum"}},"AdditionalClassification":{"maxItems":10,"type":"array","description":"Currently unused. Only items enumerated in BrandClassificationENUM are currently supported. Any additional items sent are ignored and the lowest fares are returned regardless of associated brand attributes.","example":["PremiumDrinks"],"items":{"maxLength":512,"type":"string"}},"exactMatchInd":{"type":"boolean","description":"Will not implement. The default behavior will be to provide an exact match to the product inclusion preferences.","example":true,"deprecated":true},"bestMatchInd":{"type":"boolean","description":"Will not implement. The default behavior will be to provide an exact match to the product inclusion preferences.","example":true,"deprecated":true}},"description":"Object to limit offers returned to fares that include in the price the brand attributes specified in Classification. The response also returns information about other brand attributes, which may be included, chargeable, or not offered."}},"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/ConnectionPreferencesAir":{"id":"components/schemas/ConnectionPreferencesAir","kind":"json-schema","title":"ConnectionPreferencesAir","data":{"description":"Specifies search preferences about connections and stops.  \nWhen sending ConnectionPreferences for NDC, the request must include SearchCriteriaFlight/From/cityOrAirport with a value of either City Only or Airport Only; sending the City or Airport value is not supported. ","allOf":[{"$ref":"#/components/schemas/ConnectionPreferences"},{"properties":{"FlightType":{"$ref":"#/components/schemas/FlightType"}}}]}},"components/schemas/ConnectionPreferences":{"id":"components/schemas/ConnectionPreferences","kind":"json-schema","title":"ConnectionPreferences","data":{"required":["ConnectionPoint","preferenceType"],"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 classes ConnectionPreferences or ConnectionPreferencesAir. Must send “ConnectionPreferencesAir” when sending FlightType. If the @type value is not sent, FlightType is ignored for GDS; for NDC, a time out error is returned."},"children":[]}]}]}],"default":"ConnectionPreferences"},"legSequence":{"type":"array","description":"Applies preference to only specific leg/s of the itinerary referencing legSequence sent in SearchCriteriaFlight. Do not send for preference at itinerary level.","example":[1,2,4],"items":{"type":"integer","format":"int32"}},"maxConnectionDuration":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits results to itineraries that do not exceed a set length of time between flights on the same leg. Applies to all connections on the itinerary."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the format PT{x}H, in which P is the duration designator, T is the time designator, and {x}H is the number of hours the connection should not exceed . For minutes use {x}H{x}M."},"children":[]}]}]}],"example":"PT3H45M"},"maxOvernightDuration":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits results to itineraries that do not exceed a set length of time for any overnight connection. If the first flight in the connection arrives on one calendar date and the connecting flight arrives on another calendar date, this constitutes an overnight connection."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the format PT{x}H, in which P is the duration designator, T is the time designator, and {x}H is the number of hours the connection should not exceed. For minutes use {x}H{x}M."},"children":[]}]}]}],"example":"PT6H30M"},"preferenceType":{"$ref":"#/components/schemas/ConnectionPointPreferenceTypeENUM"},"ConnectionPoint":{"maxItems":5,"type":"array","description":"IATA code for the connecting location/s for a connection preference.  \nFor example, if you specify three locations, for GDS, any flights connecting in any one of those locations will be permitted/preferred/prohibited per the specified preferenceType.  \nFor NDC, only itineraries that match all connection location/s are returned.","items":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string"}},"cityOrAirport":{"$ref":"#/components/schemas/CityOrAirportEnum"}},"description":"Supports searching by connection preferences.","discriminator":{"propertyName":"@type"}}},"components/schemas/ConnectionPointPreferenceTypeENUM":{"id":"components/schemas/ConnectionPointPreferenceTypeENUM","kind":"json-schema","title":"ConnectionPointPreferenceTypeENUM","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of connection preference. Only one preference type can be requested for an O&D pair."},"children":[]}]}]}],"example":"Permitted","enum":["Preferred","Permitted","Prohibited"],"x-enumDescriptions":{"Preferred":"Weights results that connect through one or more of the specified locations in ConnectionPoint. Preferred is not permitted as a preference type and will be ignored","Permitted":"Returns only results that connect through one or more of the specified locations in ConnectionPoint. An error is returned if there is no availability through the specified connecting location/s.","Prohibited":"Excludes results that connect through one or more of the specified locations in ConnectionPoint."}}},"components/schemas/FlightType":{"id":"components/schemas/FlightType","kind":"json-schema","title":"FlightType","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"FlightType"},"connectionType":{"$ref":"#/components/schemas/ConnectionTypeEnum"},"excludeInterlineConnectionsInd":{"type":"boolean","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":"Excludes interline connectionsClosed from results."},"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":"If true: does not return offers with interline connections."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): may return interline connections in results."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a product contains multiple interline air segments, brand details return only the brand of the significant carrier, not the validating/plating carrier brand information. The IATA rules for determining the significant carrier on an itinerary are based on the areas in which the transportation takes place."},"children":[]}]}]}],"example":true}},"description":"The type of flight connection"}},"components/schemas/ConnectionTypeEnum":{"id":"components/schemas/ConnectionTypeEnum","kind":"json-schema","title":"ConnectionTypeEnum","data":{"type":"string","description":"Limits the connection type returned. Each value returns the specified type and all higher types. For example, StopDirect could return both flights that stop without a change of planes (StopDirect) and non-stop direct flights (NonStopDirect). SingleConnection or DoubleConnection will not exclude StopDirect flights from the journey. For example, SingleConnection could return an itinerary with two flight numbers, and either of these flights could have intermediate stops.","example":"StopDirect","enum":["NonStopDirect","StopDirect","SingleConnection","DoubleConnection","TripleConnection"],"x-enumDescriptions":{"NonStopDirect":"Direct flight from the origin to the destination without a stop.","StopDirect":"Direct flight from origin to destination with a stop that does not have a change in flight number.","SingleConnection":"Flight options requiring one change of planes.","DoubleConnection":"Flight options requiring two changes of planes."}}},"components/schemas/PaymentCriteria":{"id":"components/schemas/PaymentCriteria","kind":"json-schema","title":"PaymentCriteria","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"discriminator","example":"PaymentCriteria"},"IssuerIdentificationNumber":{"maxLength":32,"pattern":"[0-9]{6,16}","type":"string","description":"Required if PaymentCriteria sent; 6 to 16 characters inclusive are accepted.  \nThe BIN/IssuerIdentificationNumber (IIN) of the credit card to be used for payment and returning OB fees. OB fees are ticketing and form of payment (FOP) charges, including credit card fees. Returned in an instance of Price/PriceBreakdown/Fees/Fee with a feeCode of OB.  \nFor NDC carrier BA, you must send the complete 16-digit credit card number to return the surcharge amount.","example":"123456"},"PaymentCardCode":{"maxLength":2,"pattern":"([A-Z0-9]+)?","type":"string","description":"A two character code for a credit card","example":"VI"},"DocumentNumber":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DocumentNumber"}},"FlightPass":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Search API, for NDC flight pass bookings this is a required field and must reference the owner in PassengerCriteria. Only one permitted per Search request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"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":" section of the NDC Guide for more information"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/FlightPass"}},"agencyAccountInd":{"type":"boolean","description":"If true, payment will be made by agency account","example":true},"bspInd":{"type":"boolean","description":"If true, payment will be made by BSP","example":true},"cashInd":{"type":"boolean","description":"If true, payment will be made by cash","example":true},"invoiceInd":{"type":"boolean","description":"If true, payment will be made by invoice","example":true}},"description":"Optional object to send the BIN/INN (IssuerIdentificationNumber) of the credit card to be used for payment; sending the BIN returns OB fees in the response  \nRequired when using Air Canada flight pass."}},"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/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/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/PricingModifiersAir":{"id":"components/schemas/PricingModifiersAir","kind":"json-schema","title":"PricingModifiersAir","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes PricingModifiersAir and PricingModifersAirDetail","example":"PricingModifiersAir"},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"In an API request, send the currency type to return if you want to override the default currency specified with your PCC.","example":"GBP"},"FareSelection":{"$ref":"#/components/schemas/FareSelection"},"OrganizationInformation":{"$ref":"#/components/schemas/OrganizationInformation"},"TaxExemption":{"$ref":"#/components/schemas/TaxExemption"},"PromotionalCode":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PromotionalCode"}},"SellCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"GDS only, not supported for NDC.\nThe IATA location code for a city. Overrides the sell city of the requester to specify an alternate sale location and return fares based on that location. The response returns pricing in the local currency for the specified sell city instead of the PCC's default currency.","example":"NYC"},"TicketCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"GDS only, not supported for NDC.\nThe IATA location code for a city. Overrides the ticketing city of the requester to specify an alternate ticket location and return fares based on that location; the response returns pricing in the local currency for the specified ticket city instead of the PCC's default currency.","example":"NYC"},"PricingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","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":"Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly return results as follows:"},"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":"PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and any available private fares are returned for the requesting and providing PCC."},"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":"If no selective access or group agreement exists, only public fares are returned."},"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":"PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, only available private fares are returned for the requesting and providing PCC."},"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":"If no agreement exists, or if an agreement exists but does not allow private fares access, an error is returned."},"children":[]}]}]}]}]}]}],"example":"0Bx3"},"FareBasisCodeOverride":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/FareBasisCodeOverride"}},"MultiPricingAgency":{"type":"array","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":"Invokes Premium Flex Search POS feature. Send up to three PCCs to return offers for those point of sale agencies in addition to your provisioned PCC. If a you send more than 3 PCCs in MultiPricingAgency, only the first 3 are validated."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must append /buildpremiumflexoptions to the endpoint. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/flights-search-guide#premium-flex-search"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Premium Flex Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation for usage and examples, and usage of the Accept header value to specify returning aggregated or streamed content."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both PricingPCC and MultiPricingAgency are sent with PCCs, the PCC in PricingPCC is ignored."},"children":[]}]}]}],"items":{"maxLength":32,"type":"string","example":"[\"0XS4\",\"0YBZ\",\"J80K\"]"}},"TicketingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"GDS only, not supported for NDC.  \nIn an API request, overrides the ticketing PCC associated with your account to specify an alternate PCC and return fares based on that PCC.","example":"0XS4"},"CalculatedFareAdjustment":{"$ref":"#/components/schemas/CalculatedFareAdjustment"},"ManualFareAdjustment":{"maxItems":10,"type":"array","description":"Send to manually adjust the base fare amount on all fares for a specific PTC.","items":{"$ref":"#/components/schemas/ManualFareAdjustment"}},"BrandPreference":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/BrandPreference"}},"includeSplitPaymentInd":{"type":"boolean","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":"Split ticketing is available only for customers specifically provisioned for split ticketing. If your account is not configured for split ticketing, sending includeSplitPaymentInd returns a response without split ticket offers and a warning message."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests request split ticketing, which returns outbound and inbound one-way fares in addition to round trip options in the Search API response. This may result in lower fares than the same or similar round-trip itinerary."},"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":"If true: requests split ticketing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): split ticketing options are not returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When split ticketing is requested, the Search response returns offers in the following order:"},"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":"Outbound one-way offers - Inbound one-way offers -  Round trip offers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response identifies all one-way outbound and inbound offers with CombinabilityCode j0. CombinabilityCode values for round trip offers start at j1 and increment by one for each offer."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the following are supported for split ticketing:"},"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":"Search (not supported for Next Leg Search or Flight Specific Search)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Round-trip journey-based offerings ( isJourney header not sent or sent as true, or CustomResponseModifiersAir/SearchRepresentation not sent or sent with value Journey)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsells."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split ticketing is not supported for round-trip leg-based searches, virtual interlining, or NDC."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split ticketing returns one-way outbound and one-way inbound fares in addition to round-trip offers. Split ticket offers are identified with CombinabilityCode j0."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Air Price: for split ticketing the request must send offers that are identified in the Search response with CombinabilityCode j0, which identifies those offers as one-way outbound and one-way inbound split ticketing offers. A combination of j0 and any non-j0 value offer returns an error message that split pricing is not supported."},"children":[]}]}]}]},"returnMostRestrictiveBrandInd":{"type":"boolean","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":"In Search API, when there are different brands on a connecting flight, return information for either the most restrictive brand or the brand on the most significant segment on the itinerary."},"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":"If true: return the offer brand of the most restrictive brand."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): return the offer brand of the most significant segment of the itinerary."},"children":[]}]}]}]}]},"splitPaymentOfferings":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number between 0 and 99. Send with includeSplitPaymentInd to configure the percentage of round trip offers to return in a split ticketing response."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, Search divides the split ticketing response into 34% round-trip offerings and the remainder as split ticketing offers, which are combined outbound and inbound one-way fares. To change this percentage, send splitPaymentOfferings with the percentage value of round trip offers to return."},"children":[]}]}]}],"format":"float","example":25}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A selection of Pricing Modifiers that can be used to influence the Price of an Offer."},"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":"For the AirPrice reference payload request, if any price modifiers were included in the preceding Search request and no price modifiers are sent in the AirPrice request, the cached price modifiers sent at Search are sent with the AirPrice request. If any price modifiers are sent in the AirPrice reference payload request, all cached Search modifiers are discarded and only the modifiers sent in that AirPrice request are used."},"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":"For the Add Offer request, you may optionally store fares with one or more pricing modifiers. If a pricing modifier is not added, the auto stored fare is added to the reservation. There is no change in the AirReservation response when pricing modifiers are requested. AirReservation applies modifiers from Add Offer and earlier steps as follows:"},"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":"Modifiers sent in the Add Offer request (supported for both full and reference payload)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no modifiers were sent in AirPrice, or if AirPrice was not sent, any pricing modifiers sent in Search are applied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDS only; pricing modifiers not supported for NDC."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the requested modifier does not have any fares associated with it, the workbench commit fails and returns the error message 'No Fare Found'. Pricing happens at commit, not at Add Offer."},"children":[]}]}]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/FareSelection":{"id":"components/schemas/FareSelection","kind":"json-schema","title":"FareSelection","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child class FareSelectionDetail.","example":"FareSelection"},"fareType":{"$ref":"#/components/schemas/FaresFilterEnum"},"RefundOptions":{"$ref":"#/components/schemas/RefundOptions"},"ChangeOptions":{"$ref":"#/components/schemas/ChangeOptions"},"FareQualifier":{"maxItems":5,"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/FareQualifierENUM"}},"FareQualiferString":{"maxItems":5,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request specific private leisure fares."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values vary by NDC carrier. For detailed NDC support by carrier, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/ndc/ndc-guide#ndc-carrier-support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC Carrier Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is returned in FlightProduct.FareQualifierString if supplied by the airline. (Note the misspelling in request parameter)\""},"children":[]}]}]}],"example":["Tour"],"items":{"maxLength":32,"type":"string"}}},"description":"Requests the return of fare types including private fares (negotiated), public fares (published), or net fares (consolidator fares, or any negotiated wholesale price that is further marked up for sale to customers). May be used to request fares with specific restrictions, change, or refund options.  ","discriminator":{"propertyName":"@type"}}},"components/schemas/FaresFilterEnum":{"id":"components/schemas/FaresFilterEnum","kind":"json-schema","title":"FaresFilterEnum","data":{"type":"string","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 fares to return (only public fares, only private fares, only agency private fares, etc.). These can be combined."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response identifies the type of fare returned for each Product in PassengerFlight/FlightProduct @fareType. Possible values in the response are AirlinePrivateFare, AgencyPrivateFare, NetFare, or PublicFare."},"children":[]}]}]}],"example":"PrivateFaresOnly","enum":["PublicFaresOnly","PrivateFaresOnly","AgencyPrivateFaresOnly","AirlinePrivateFaresOnly","PublicAndPrivateFares","NetFaresOnly","AllFares"],"x-enumDescription":{"PublicFaresOnly":"Only public fares for specified itinerary.","PrivateFaresOnly":"Only private fares for the itinerary.","PublicAndPrivateFares":"Lowest of all public and private fares (default behavior).","NetFaresOnly":"Only net fares. (Net fares are returned for GDS if available even if not requested. NDC does not support net fares.)","AllFares":"Public, private, and fare offers."}}},"components/schemas/RefundOptions":{"id":"components/schemas/RefundOptions","kind":"json-schema","title":"RefundOptions","data":{"required":["@type","refundTypes"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"RefundOptions"},"refundTypes":{"type":"array","items":{"$ref":"#/components/schemas/RefundTypeEnum"}},"RefundPenaltyRange":{"$ref":"#/components/schemas/RefundPenaltyRange"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports requesting only fares that meet certain refund criteria. GDS only; not supported for NDC. Search supports sending up to 12 refundability options. The following combinations are mutually exclusive; if sent, Search ignores them and returns a warning message: NonRefundable cannot also be sent with PartialRefund. Refundable cannot also be sent with ChangeOptions/changeTypes=PenaltyToChange"},"children":[]}]}]}]}},"components/schemas/RefundTypeEnum":{"id":"components/schemas/RefundTypeEnum","kind":"json-schema","title":"RefundTypeEnum","data":{"type":"string","description":"Returns only fares with the specified refund criteria","example":"Refundable","enum":["Refundable","NonRefundable","PartialRefund"],"x-enumDescriptions":{"Refundable":"Fully refundable fares.","NonRefundable":"Non refundable fares. NonRefundable cannot be combined with PartialRefund","PartialRefund":"Fares that allow for a partial refund, defined as a refund penalty that is 98 percent or less of the fare component amount. PartialRefund cannot be combined with NonRefundable."}}},"components/schemas/RefundPenaltyRange":{"id":"components/schemas/RefundPenaltyRange","kind":"json-schema","title":"RefundPenaltyRange","data":{"properties":{"@type":{"type":"string","example":"RefundPenaltyRange"},"Minimum":{"$ref":"#/components/schemas/AmountPercent"},"Maximum":{"$ref":"#/components/schemas/AmountPercent"}},"description":"Not currently supported. User can express a minimum and maximum Refund penalty range that will be included in the result set."}},"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/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/ChangeOptions":{"id":"components/schemas/ChangeOptions","kind":"json-schema","title":"ChangeOptions","data":{"required":["changeTypes"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"ChangeOptions"},"changeTypes":{"type":"array","items":{"$ref":"#/components/schemas/ChangeTypeENUM"}},"ChangePenaltyRange":{"$ref":"#/components/schemas/ChangePenaltyRange"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports requesting only fares that meet certain change criteria. GDS only; not supported for NDC. Search supports sending up to 12 changeability options. ChangeOptions.changeTypes=PenaltyToChange cannot be sent with RefundOptions.Refundable. If sent, Search ignores them and returns a warning message"},"children":[]}]}]}]}},"components/schemas/ChangeTypeENUM":{"id":"components/schemas/ChangeTypeENUM","kind":"json-schema","title":"ChangeTypeENUM","data":{"type":"string","description":"Returns only fares with the specified change type","example":"Changeable","enum":["Changeable","NonChangeable","PenaltyToChange"],"x-enumDescriptions":{"Changeable":"Changeable fares.","NonChangeable":"Non Changeable fares.","PenaltyToChange":"Changeable with a penalty."}}},"components/schemas/ChangePenaltyRange":{"id":"components/schemas/ChangePenaltyRange","kind":"json-schema","title":"ChangePenaltyRange","data":{"properties":{"@type":{"type":"string","example":"ChangePenaltyRange"},"Minimum":{"$ref":"#/components/schemas/AmountPercent"},"Maximum":{"$ref":"#/components/schemas/AmountPercent"}},"description":"Not currently supported. User can express a minimum and maximum Change penalty range that will be included in the result set"}},"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/OrganizationInformation":{"id":"components/schemas/OrganizationInformation","kind":"json-schema","title":"OrganizationInformation","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes","example":"OrganizationInformation"},"OrganizationIdentifier":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of account codes to return negotiated fares. The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each account code sent."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When FareSelection/fareType=PrivateFaresOnly and an account code is sent in OrganizationIdentifier, AirPrice ignores the account code. Instead, AirPrice returns any private fares available for that market and a booking code for your PCC. This prevents the return of an error message when no specific fare has been filed for that account code."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrganizationIdentifier"}},"GSTRegistrationNumber":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send to add India GST (Goods and Services Tax) Special Service Requests. In this case country should be IND. Supported during book 'Add Offer' workflow."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#india-gst-ssr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"India GST SSRs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Remarks & Service Requests Guide for important details."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/GSTRegistrationNumber"}}},"description":"Use to send account codes for negotiated fares or to send optional India GST SSR Remarks in GSTRegistrationNumber.  \nFor NDC supports corporate loyalty program and GST Information. This information is returned in TermsAndConditions."}},"components/schemas/OrganizationIdentifier":{"id":"components/schemas/OrganizationIdentifier","kind":"json-schema","title":"OrganizationIdentifier","data":{"properties":{"value":{"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":"The value of the code to apply."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note for AirSearch account codes:"},"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":"For GDS, up to 15 account codes are supported. Account codes are alphanumeric and must start with an alphabetic character."},"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":"For NDC, 1 account code per carrier is supported"},"children":[]}]}]}]}]}],"example":"JBD123456"},"supplier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The IATA code for the airline on which the code is applicable.","example":"AA"},"organizationCodeType":{"$ref":"#/components/schemas/OrganizationCodeTypeEnum"},"segmentSequenceList":{"type":"array","description":"Returned in response when the code is applicable to a specified segment sequence","example":[1,2,3],"items":{"type":"integer","format":"int32"}},"productRef":{"type":"array","description":"Returned in response when the code is applicable to a specified product","example":["product_1"],"items":{"type":"string"}},"accountCodeFaresOnlyInd":{"type":"boolean","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. Not supported in Standalone Price."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator to limit the fares returned to only fares filed for the specified account code."},"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":"If true: Limits the fares returned to only fares filed for that account code; must send with one or more account codes in OrganizationIdentifier/value. If sending multiple account codes, send each instance with accountCodeFaresOnlyInd set to true."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): does not limit fares returned to any account code sent."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an account code is sent without accountCodeFaresOnlyInd=true, the response includes any fares filed for that account code plus fares that are not specific to the account code."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If accountCodeFaresOnlyInd=true and no account code is sent, the indicator is ignored and the response returns all fares and a warning message that the request must include an account code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following when also requesting private fares only:"},"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":"FareSelection/fareType=PrivateFaresOnly and account code: Private fares are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FareSelection/fareType=PrivateFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any private fares specific to that account code are returned if available. If no private fares exist for that account code, an error message is returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following when also requesting net fares:"},"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":"FareSelection/fareType=NetFaresOnly and account code: Net fares are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FareSelection/fareType=NetFaresOnly, accountCodeFaresOnlyInd=true, and account code: Any net fares specific to that account code are returned if available. If no net fares exist for that account code, an error message is returned."},"children":[]}]}]}]}],"example":true}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In AirSearch and AirPrice, this request supports multiple corporate rate codes (such as account and tour) to return negotiated fares. Also supports business loyalty programs."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response returns an instance of TermsAndConditions/OrganizationInformation/OrganizationIdentifier for each code type sent."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When FareSelection/fareType=PrivateFaresOnly and an account code is sent in OrganizationIdentifier, AirPrice ignores the account code. Instead, AirPrice returns any private fares available for that market and a booking code for your PCC. This prevents the return of an error message when no specific fare has been filed for that account code."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Qantas Airlines supports only one account code. If multiple codes are sent, only the first code is processed."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For NDC only, if the account code/organizationLoyaltyProgram value is sent as a pricing modifier in the Search request, that number is retained and sent at workbench commit without having to enter it in any additional steps after Search. The account code/organizationLoyaltyProgram value is returned in the workbench commit and reservation retrieve responses under Offer/TermsAndConditionsAir/OrganizationInformation."},"children":[]}]}]}]}},"components/schemas/OrganizationCodeTypeEnum":{"id":"components/schemas/OrganizationCodeTypeEnum","kind":"json-schema","title":"OrganizationCodeTypeEnum","data":{"type":"string","description":"Sends a description for the OrganizationIdentifer value.  \nFor AirPrice, always send with a value of Account.","example":"Account","enum":["Account","OrganizationLoyaltyProgram","Tour","TicketDesignator"],"x-enumDescriptions":{"Account":"The corporate account code. For GDS, up to 15 account codes are supported. For NDC, 1 account code per carrier is supported.","OrganizationLoyaltyProgram":"NDC only. The corporate loyalty program, such as BA On Business, AA AAdvantag, QF Business Rewards.","Tour":"NDC Only. The tour code to be applied to the NDC fare.","TicketDesignator":"NDC only. The ticket designator to be applied to the NDC fare."}}},"components/schemas/GSTRegistrationNumber":{"id":"components/schemas/GSTRegistrationNumber","kind":"json-schema","title":"GSTRegistrationNumber","data":{"required":["address","companyName","country","email","telephone","value"],"properties":{"value":{"maxLength":512,"type":"string","description":"The GST registered number for the business.","example":"07AAGFF2194N1Z1"},"telephone":{"maxLength":32,"type":"string","description":"Business telephone number","example":"222-222-222"},"address":{"maxLength":128,"type":"string","description":"Business address","example":"1122 sample trail, CO, USA, 21232"},"country":{"pattern":"[a-zA-Z]{2}","type":"string","description":"IATA country code of the business.","example":"IND"},"companyName":{"maxLength":512,"type":"string","description":"Business name","example":"Adecco"},"email":{"maxLength":128,"type":"string","description":"Business E-Mail address","example":"sample@adecco.com"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC book workflow only. Send to add India GST (Goods and Services Tax) SSRs. These are details for the business purchasing the goods and services in the GST. For further information see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/booking-and-reservations/remarks-and-service-requests#india-gst-ssr"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remarks & Service Request Guide"},"children":[]}]}]}]}]}},"components/schemas/TaxExemption":{"id":"components/schemas/TaxExemption","kind":"json-schema","title":"TaxExemption","data":{"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"TaxExemption"},"countries":{"type":"array","description":"One or more ISO codes for the countries in which the paired taxCodes sent are tax exempt. Must also send taxCodes object.","example":["GB","MX"],"items":{"pattern":"[a-zA-Z]{2}","type":"string"}},"taxCodes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more two-letter alphanumeric tax codes to mark as exempt in the paired country. Must also send countries object."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AirChange: send up to five tax codes to exempt. Exempted taxes are returned in the response as PriceBreakdown/Taxes/Tax/exemptInd=true."},"children":[]}]}]}],"example":["US"],"items":{"maxLength":32,"type":"string"}},"allTaxesExemptInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use to set all taxes as exempt."},"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":"If true: marks all taxes on the itinerary as tax exempt."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not send if false. Instead, use countries and taxCodes to specify which taxes to exempt."},"children":[]}]}]}]}],"example":true}},"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":"Use to mark some or all taxes as exempt."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify all taxes, only specific tax codes, or all taxes in specific countries."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include either allTaxesExemptInd OR both countries and taxCodes."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TaxExemption supports up to nine values for countries, taxCodes, or both combined. The response returns any exempt taxes with exemptInd=true and value=0."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AirChange: specify up to five taxes to exempt during exchange search."},"children":[]}]}]}]}},"components/schemas/PromotionalCode":{"id":"components/schemas/PromotionalCode","kind":"json-schema","title":"PromotionalCode","data":{"required":["supplierCode"],"properties":{"value":{"maxLength":32,"type":"string","description":"The promotional code to apply","example":"CDFRT"},"supplierCode":{"maxLength":5,"minLength":2,"pattern":"([a-zA-Z0-9]{2,5})","type":"string","description":"The IATA code for the airline on which the promotional code is applicable.","example":"AA"}},"description":"NDC only. Not supported for GDS. Any NDC airline designated promotional code."}},"components/schemas/FareBasisCodeOverride":{"id":"components/schemas/FareBasisCodeOverride","kind":"json-schema","title":"FareBasisCodeOverride","data":{"properties":{"value":{"maxLength":32,"type":"string"},"specificFlightCriteriaRefs":{"type":"array","description":"Reference the specificFlightCriteria you want to override. If blank, all segments will be overridden.","example":"s1, s2","items":{"type":"string"}},"unpricedFlightSegmentRefs":{"type":"array","description":"Reference the unpricedFlightSegment you want to override. If blank, all segments will be overridden.","example":"up1, up2","items":{"type":"string"}}},"description":"Override the fare basis using the value. To override by segment use the specificFlightCriteriaRefs (for Full payload Price/Book) or the unpricedFlightSegmentRefs (for Standalone Price)"}},"components/schemas/CalculatedFareAdjustment":{"id":"components/schemas/CalculatedFareAdjustment","kind":"json-schema","title":"CalculatedFareAdjustment","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"CalculatedFareAdjustmentDiscount"}},"description":"Used in Exchange Search to modify the Price of the Fare. Discriminator classes CalculatedFareAdjustmentDiscount or CalculatedFareAdjustmentIncrease","discriminator":{"propertyName":"@type"}}},"components/schemas/ManualFareAdjustment":{"id":"components/schemas/ManualFareAdjustment","kind":"json-schema","title":"ManualFareAdjustment","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes ManualFareAdjustmentIncrease or ManualFareAdjustmentDiscount","example":"ManualFareAdjustmentIncrease"},"passengerTypeCodes":{"type":"array","description":"Send the PTC/s to be increased or decreased. This increases or discounts the fare for all passengers with the PTC/s. If not sent, ManualFareAdjustment applies to all PTCs.","example":["ADT","CHD"],"items":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string"}}},"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. Not supported for Standalone Price."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send to manually adjust the base fare amount on all fares. You can alter the base fare for all PTCs or only specified PTCs. You can increase or decrease the base fare by either an amount or a percentage."},"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":"Send with @type value ManualFareAdjustmentDiscount to decrease the base fare."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send with @type value ManualFareAdjustmentIncrease to increase the fare."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a fare is adjusted in Add Offer using ManualFareAdjustment, in the workbench commit and Reservation Retrieve responses, FareGuaranteePolicy/Code/value returns M to indicate the fare has been manipulated."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the PCC currency and the country of origin currency are different, then the amount or percentage of the filed amount base fare is converted into the PCC currency."},"children":[]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/BrandPreference":{"id":"components/schemas/BrandPreference","kind":"json-schema","title":"BrandPreference","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes exist","example":"BrandPreference"},"brandTier":{"type":"integer","description":"The brand tier","format":"int32","example":1},"legSequence":{"type":"array","description":"Correlates with legSequence in SearchCriteriaFlight","example":[1,2],"items":{"type":"integer","format":"int32"}}},"description":"Allows user to pass Brand tier as a pricing modifier.  \nFor Add Offer, send in PricingModifiersAir only if requesting to store a fare with brand details at the offer level."}},"components/schemas/CustomResponseModifiersAir":{"id":"components/schemas/CustomResponseModifiersAir","kind":"json-schema","title":"CustomResponseModifiersAir","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"discriminator","example":"CustomResponseModifiersAir"},"BrandAttributeInclusion":{"maxItems":10,"type":"array","description":"Supported in AirSearch and AirPrice. Returns only information about the brand attributes specified and does not return any other brand attributes.","items":{"$ref":"#/components/schemas/BrandAttributeInclusion"}},"SearchRepresentation":{"$ref":"#/components/schemas/SearchRepresentationENUM"},"excludePenaltiesInd":{"type":"boolean","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":"Indicator to omit change and cancel penalties."},"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":"If true: omits all penalty information from the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): returns any change and penalty details provided by carrier for each offer in TermsAndConditionsFullAir/Penalties."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If sent in Search but not in AirPrice, the value sent in Search is cached and applied to the AirPrice results. However, you can override the value sent in Search by sending excludePenaltiesInd in the AirPrice request with the opposite value. For example, if the Search request sends excludePenaltiesInd=true and the AirPrice request sends excludePenaltiesInd=false, the Search response does not return penalties and the AirPrice response does return penalties."},"children":[]}]}]}],"example":true},"excludeBaggageFeesInd":{"type":"boolean","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":"Indicator to exclude baggage details."},"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":"If true: excludes baggage fees, carry on fees, and embargo information from the response. Baggage quantity or weight is returned instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): baggage details returned in response. Default is false."},"children":[]}]}]}]}],"example":true},"includeFareCalculationInd":{"type":"boolean","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 or in the Flight Specific Search full payload request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator to request the return of the fare calculation ladder."},"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":"If true: returns the fare calculation ladder in BestCombinablePrice.PriceBreakdownAir.FareCalculation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): fare calculation ladder is not returned."},"children":[]}]}]}]}],"example":true},"excludeSurchargesInd":{"type":"boolean","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":"Indicator to exclude a surcharge breakdown."},"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":"If true: excludes a surcharge breakdown from the response. Baggage quantity or kilos is returned instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): surcharge breakdown returned in response."},"children":[]}]}]}]}],"example":true},"excludeUnbundledFaresInd":{"type":"boolean","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":"Sets whether to return unbundled fares. Supported in AirSearch and AirPrice."},"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":"If true: does not return unbundled fares."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): returns unbundled and bundled fares as available."},"children":[]}]}]}]}],"example":true},"includeCO2EmissionsDataInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator to return CO2 emission data in the Search and Next Leg Search responses."},"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":"If true: returns CO2 emission data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): CO2 emission data not returned."},"children":[]}]}]}]}],"example":true},"includeFlightAmenitiesInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator to return flight amenities from ATPCO RouteHappy data."},"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":"If true: includes amenities in the response if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false: Does not return ATPCO RouteHappy amenities."},"children":[]}]}]}]}],"example":true},"includeUniversalProductAttributesInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicator to return universal product attributes (UPAs), which include images, icons, and URLs as provided by ATPCO. Must also send includeFlightAmenitiesInd=true."},"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":"If true: returns universal product attributes if available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Universal product attributes not returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UPAs are not returned for direct flights with intermediate stops, non-flight segments such as trains, or for Premium Business class."},"children":[]}]}]}],"example":true},"includeBundledAncillariesInd":{"type":"boolean","description":"NDC only; not supported for GDS.  \nIf true: request NDC offers that include an ancillary service bundled with the cost of the air fare. This could be a discounted paid seat or any other ancillary service offered by the carrier.  \nSearch and Price responses will contain both ProductAir and ProductAncillary plus a new child class of PriceBreakdown, PriceBreakdownAncillaryAir, to define the ancillary inclusion and pricing.","example":true},"includeFullPenaltyDisclosureInd":{"type":"boolean","description":"If true, penalty information sourced from ATPCO Cat 31 and 33 will be disclosed. Penalties may be exposed at fare component level and include time windows."}},"description":"Contains additional modifiers to customize the result set. Includes optional indicators for returning or excluding specified response content.  \nValues sent at Search can carry forward into the Next Leg Search request and are not re-sent."}},"components/schemas/BrandAttributeInclusion":{"id":"components/schemas/BrandAttributeInclusion","kind":"json-schema","title":"BrandAttributeInclusion","data":{"properties":{"@type":{"type":"string","example":"BrandAttributeInclusion"},"legSequence":{"type":"array","description":"Leg sequence not supported for BrandAttributeInclusion.","example":[1,2],"deprecated":true,"items":{"type":"integer","format":"int32"}},"Classification":{"maxItems":10,"type":"array","description":"Send one or more of the supported values to return information about only the specified attributes. Fares may include other attributes but information about them is not returned.","items":{"$ref":"#/components/schemas/BrandClassificationEnum"}},"AdditionalClassification":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send one or more of the additional supported values to return information about only the specified additional attributes."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values:"},"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":"ChauffeurTransfer"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ExtraLegroom"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InFlightEntertainment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LoungeAccess"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PriorityBaggage"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PriorityBoarding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PriorityCheckIn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PrioritySecurity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PriorityServices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MileageAccrual"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upgrades"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"USB"},"children":[]}]}]}]}],"items":{"maxLength":512,"type":"string"}}},"description":"Supports returning only information about the brand attributes specified in Classification and does not return any other brand attributes for those fares."}},"components/schemas/SearchRepresentationENUM":{"id":"components/schemas/SearchRepresentationENUM","kind":"json-schema","title":"SearchRepresentationENUM","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies either a journey or leg-based response.This setting does not affect one-way itineraries, which have one leg and are always journey-based."},"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":"Journey returns offers for all legs of the itinerary. Journey is the default."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leg returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customize search result set as leg or journey based. Next Leg Search requests, and Flight Specific Search requests for less than the full itinerary, are supported only after a leg-based Search, not a journey-based Search. If these requests follow a journey-based Search request, an error message is returned."},"children":[]}]}]}],"example":"Leg","enum":["Leg","Journey","LegWithJourneyData"],"x-enumDescriptions":{"Journey":"Returns offers for all legs of the itinerary. Default.","Leg":"Returns offers for only the first leg of the itinerary. Must be followed with a Next Leg Search to select an offer for the first leg and return offers on the subsequent leg to combine with it."}}},"components/schemas/SearchTypeEnum":{"id":"components/schemas/SearchTypeEnum","kind":"json-schema","title":"SearchTypeEnum","data":{"type":"string","description":"List of search types.","example":"MetaSearch","deprecated":true,"enum":["MetaSearch","ProductSearch","OfferSearch"]}},"components/schemas/CatalogProductOfferingsResponseWrapper":{"id":"components/schemas/CatalogProductOfferingsResponseWrapper","kind":"json-schema","title":"CatalogProductOfferingsResponseWrapper","data":{"properties":{"CatalogProductOfferingsResponse":{"$ref":"#/components/schemas/CatalogProductOfferingsResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/CatalogProductOfferingsResponse":{"id":"components/schemas/CatalogProductOfferingsResponse","kind":"json-schema","title":"CatalogProductOfferingsResponse","data":{"required":["CatalogProductOfferings"],"properties":{"CatalogProductOfferings":{"$ref":"#/components/schemas/CatalogProductOfferings"}},"description":"Top level object for Search response. Includes CatalogProductOfferings, Result, and ReferenceList.","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 TripServices 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/CatalogProductOfferings":{"id":"components/schemas/CatalogProductOfferings","kind":"json-schema","title":"CatalogProductOfferings","data":{"description":"CatalogProductOfferings is the top level object that groups all the offers in the response. Each instance of CatalogProductOffering is one offer.","allOf":[{"$ref":"#/components/schemas/CatalogProductOfferingsID"},{"properties":{"CatalogProductOffering":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/CatalogProductOffering"}},"UpsellOffering":{"maxItems":100,"type":"array","description":"Not currently in use.","items":{"$ref":"#/components/schemas/UpsellOffering"}}}}]}},"components/schemas/CatalogProductOfferingsID":{"id":"components/schemas/CatalogProductOfferingsID","kind":"json-schema","title":"CatalogProductOfferingsID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes CatalogProductOfferingsID and CatalogProductOfferings","example":"CatalogProductOfferings"},"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"cpo_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"These identifiers must be sent in any subsequent Next Leg Search request as well as other steps in any reference payload workflow. If your workflow subsequently references a journey-based search result, the Search request must send offersPerPage set to any positive number. This setting invokes caching to allow subsequent requests to refer to these search results. If a journey-based Search request does not send offersPerPage, any subsequent reference payload requests will fail, including the Flight Specific Search, AirPrice, and Add Offer reference payloads.","discriminator":{"propertyName":"@type"}}},"components/schemas/CatalogProductOffering":{"id":"components/schemas/CatalogProductOffering","kind":"json-schema","title":"CatalogProductOffering","data":{"description":"Each instance of CatalogProductOffering returns one offer on one leg of the itinerary. In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. A product is the flight or connecting flights for one leg of the itinerary, plus a service level that includes the cabin class and any fare codes that may apply. At booking, the selected offer from the Search response - including the flight/s, service level, price, terms and conditions, and brand if applicable - is converted into a single Offer object that is subsequently returned for that booking. A leg-based Search response returns instance/s of CatalogProductOffering on only the first leg, indicated by sequence value 1. It must be followed by a Next Leg Search request. A journey-based Search response returns instance/s for all legs, each indicated with sequence values 1 or 2, or 3 for the third leg of multi-city itineraries. In a Next Leg Search response, the first instance of CatalogProductOffering is the offer chosen for the first leg (sequence 1). Subsequent instance/s are offers on the second leg (sequence value 2). Includes Departure, Arrival, Brand, and ProductBrandOptions objects. May include UpsellOffering for NDC.","allOf":[{"$ref":"#/components/schemas/CatalogProductOfferingID"},{"required":["ProductBrandOptions"],"properties":{"sequence":{"type":"integer","description":"Indicates the order of this leg in the itinerary: 1 for the first leg, 2 for the second leg, 3 for the third leg of multi-city itineraries. (Search supports up to three legs.)","format":"int32","example":1},"Departure":{"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":"LHR"},"Arrival":{"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":"LAX"},"FlexNextLeg":{"maxItems":20,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FlextNextLeg is only returned for leg based search and identifies the O&D and/or date that the initial offering can be combined with."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/FlexNextLeg"}},"Brand":{"maxItems":1000,"type":"array","description":"Lists reference numbers for brands returned. Only one instance of Brand is returned if no upsells are returned for that offer.","items":{"$ref":"#/components/schemas/BrandID"}},"ProductBrandOptions":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductBrandOptions"}}}}]}},"components/schemas/CatalogProductOfferingID":{"id":"components/schemas/CatalogProductOfferingID","kind":"json-schema","title":"CatalogProductOfferingID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes CatalogProductOfferingID or CatalogProductOffering","example":"CatalogProductOffering"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The internal id for the offers in this instance:"},"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":"For GDS: o1, o2, and so on."},"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":"NDC identifiers incorporate the carrier code into these types of IDs: QF_COPO0, SQb5, AAt5, etc."},"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":"Search merges offers for offers for the same itinerary at the same price from GDS and NDC sources. A merged offer returns a CatalogProductOffering/id value that combines the standard GDS and NDC id numbers."},"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":"For example: if a GDS offer that has id 03 is merged with an NDC offer that has id UA_CPO0, the merged id is 03-UA_CPO0."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/flights-search-guide#merged-gds-and-ndc-offers-content-curation-layer"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merged GDS and NDC Offers (Content Curation Layer)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation for details."},"children":[]}]}]}],"example":"cpo_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"CatalogProductOfferingRef":{"type":"string","description":"Not used. Allows referencing another instance of this object in the same message","example":"cpo_1"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/FlexNextLeg":{"id":"components/schemas/FlexNextLeg","kind":"json-schema","title":"FlexNextLeg","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"FlexNextLeg"},"Departure":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The departure location of the next leg option.","example":"LAX"},"Arrival":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The arrival location of the next leg option.","example":"LHR"},"DepartureDate":{"type":"string","description":"Departure date of the next leg option.","format":"date"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FlextNextLeg is only returned for leg based search and identifies the O&D and/or date that the initial offering can be combined with."},"children":[]}]}]}]}},"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/ProductBrandOptions":{"id":"components/schemas/ProductBrandOptions","kind":"json-schema","title":"ProductBrandOptions","data":{"required":["ProductBrandOffering"],"properties":{"@type":{"type":"string","example":"ProductBrandOptions"},"flightRefs":{"type":"array","description":"Reference to the Flights that are used within ProductBrandOptions. Returned for GDS offerings. Not supported for NDC.","example":["s1","s2","s3"],"items":{"type":"string"}},"SponsoredFlightAttributes":{"$ref":"#/components/schemas/SponsoredFlightAttributes"},"ProductBrandOffering":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductBrandOffering"}}},"description":"Each instance of ProductBrandOptions groups the products available on this offer."}},"components/schemas/SponsoredFlightAttributes":{"id":"components/schemas/SponsoredFlightAttributes","kind":"json-schema","title":"SponsoredFlightAttributes","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"SponsoredFlightAttributes"},"positionNumber":{"type":"integer","description":"The display position number of the sponsored option","format":"int32"},"adID":{"maxLength":32,"type":"string","description":"The advertisement ID"},"trackingID":{"type":"string","description":"Unique tracking ID for sponsored flights campaign required in end to end workflow."},"sponsoredFlightInd":{"type":"boolean","description":"If true, this option is a sponsored flight option."}},"description":"Coming soon. Contains marketing information for Sponsored Flight Options."}},"components/schemas/ProductBrandOffering":{"id":"components/schemas/ProductBrandOffering","kind":"json-schema","title":"ProductBrandOffering","data":{"required":["@type","BestCombinablePrice","Brand","Product"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"ProductBrandOffering"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"Price":{"$ref":"#/components/schemas/PriceDetail"},"Brand":{"$ref":"#/components/schemas/BrandID"},"Product":{"maxItems":1000,"type":"array","description":"GDS Air Search returns one instance of Product. NDC may return multiple instances in the case of ancillary bundles.","items":{"$ref":"#/components/schemas/ProductID"}},"TermsAndConditions":{"$ref":"#/components/schemas/TermsAndConditionsID"},"CombinabilityCode":{"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":"Code/s for the product/s on the other leg of the itinerary that can be combined with this product for the lowest available fare. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/flights-search-guide#combinabilitycode-and-bestcombinableprice"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CombinabilityCodes and BestCombinablePrice"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation for details."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For GDS only, a multi-city offer has jc in its CombinabilityCode, as in jc1, jc2. 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."},"children":[]}]}]}],"items":{"maxLength":32,"type":"string","example":"J1"}},"BestCombinablePrice":{"$ref":"#/components/schemas/BestCombinablePriceDetail"},"Desirability":{"type":"number","description":"The desirability of the offering expressed as a percentage. The higher the percentage the more desirable the offering.","format":"float","example":25},"MatchedAttributes":{"type":"integer","description":"If ProductInclusionPreference.Classification was sent in the request, this returns the number of those requested attributes that are available for this fare.","format":"int32","example":7},"BrandStatus":{"$ref":"#/components/schemas/BrandStatusEnum"},"ContentSource":{"$ref":"#/components/schemas/ContentSourceEnum"},"bestMatchInd":{"type":"boolean","description":"If true, All brand attributes requested in ProductInclusionPreference.Classification are available for this fare.","example":true},"CO2EmissionsData":{"$ref":"#/components/schemas/CO2EmissionsData"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one product in this offer and related details about it."},"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":"If no upsells are available or requested: each ProductBrandOptions returns one instance of ProductBrandOffering - one per product."},"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":"This instance is the base fare and usually is identified with the brandRef value b0."},"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":"In this case, every product in one offer shares the same price, brand, and terms and conditions."},"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":"If upsells are returned: each ProductBrandOptions returns multiple instances of ProductBrandOffering - one per brand."},"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":"In this case, each brand in one offer shares the same price but not necessarily products or terms and conditions."},"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":"Includes Brand, Product, TermsAndConditions, CombinabilityCode, BestCombinablePrice, ContentSource, and CO2EmissionsData if requested."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductBrandOffering.Price has been removed from all offerings and is not returned unless your PCC is provisioned to return it. 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. Pricing must be validated instead in ProductBrandOffering.BestCombinablePrice. You can opt out of this change by contacting your Travelport representative. If so, multi-city offers with stopovers are not returned for your PCC, and all offers return both Price and BestCombinablePrice."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ProductBrandOffering.Identifier is returned only for leg-based search responses when both GDS and NDC content is requested. Not returned for journey-based search responses or when only NDC or only GDS content is requested."},"children":[]}]}]}]}},"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/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/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/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/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/BestCombinablePriceDetail":{"id":"components/schemas/BestCombinablePriceDetail","kind":"json-schema","title":"BestCombinablePriceDetail","data":{"description":"Price details for the full itinerary when this product is combined with any other product sharing a CombinabilityCode. For example, if p6 on the outbound and p24 on the inbound both have a CombinabilityCode value of j2, both products return the same BestCombinablePrice when combined for the itinerary.  \nFor a one-way itinerary, CombinabilityCode is returned for consistency but the value has no use and can be ignored. The pricing in BestCombinablePrice applies to the one-way itinerary.  \nFor NDC leg-based responses on carrier AA, the PriceBreakdown amount is approximate. Because AA returns only a journey-based response, Search must convert the response to a leg-based response.  \nIf the TotatlTaxes amount isn't divisible by the number of segments, the PriceBreakdown may not be accurate. However, accurate pricing will be returned in the AirPrice response.  \nMay include FlightPassCredits (Air Canada NDC only).","allOf":[{"$ref":"#/components/schemas/BestCombinablePrice"},{"properties":{"PriceBreakdown":{"maxItems":50,"type":"array","description":"Price breakdown by PTC, one instance returned for each PTC type. AirSearch will return child class PriceBreakdownAir.","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/BestCombinablePrice":{"id":"components/schemas/BestCombinablePrice","kind":"json-schema","title":"BestCombinablePrice","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes BestCombinablePrice or BestCombinablePriceDetail","example":"BestCombinablePrice"},"id":{"type":"string","description":"Internally referenced id","example":"2"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"Base price for all passengers included in the offering before taxes and fees.  \nWhen Air Canada flight pass is being used, Base price will be 0 for the flight pass offer.","format":"float","example":20.2},"TotalTaxes":{"type":"number","description":"Sum of all taxes for all passenegers included in the offering","format":"float","example":34.4},"TotalFees":{"type":"number","description":"Sum of all fees for all passenegers included in the offering","format":"float","example":201},"TotalPrice":{"type":"number","description":"The total price for all passengers included in the offering in the currency indicated","format":"float","example":34},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/BrandStatusEnum":{"id":"components/schemas/BrandStatusEnum","kind":"json-schema","title":"BrandStatusEnum","data":{"type":"string","description":"alerts when a given brand is sold out of not offered for the journey","example":"SoldOut","enum":["NotOffered","SoldOut"]}},"components/schemas/CO2EmissionsData":{"id":"components/schemas/CO2EmissionsData","kind":"json-schema","title":"CO2EmissionsData","data":{"properties":{"@type":{"type":"string","example":"CO2EmissionsData"},"Actual":{"$ref":"#/components/schemas/Measurement"},"Typical":{"$ref":"#/components/schemas/Measurement"},"Variance":{"type":"integer","description":"The variance of CO2 emission from the typical emission value represented as a percent. If positive, the CO2 emission is higher than the industry average. If negative, it is lower than the industry average.","format":"int32"}},"description":"Contains the CO2 emissions data. Returned in Search and Next Leg Search responses when requested in CustomResponseModifiersAir. If CO2 data is not available for a flight or route, only available data is returned and these objects may be returned blank. CO2 data is not returned for non-flight segments (equipment codes BUS, HOV, LCH, LMO, TRN, TRS). Actual and Typical carbon emissions for the flight are returned as a measurement. Type of measurement for CO2 emissions is 'weight'. Unit of measure for CO2 emissions is 'kilograms'."}},"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/UpsellOffering":{"id":"components/schemas/UpsellOffering","kind":"json-schema","title":"UpsellOffering","data":{"description":"Additional Upsell Offerings to compliment the Flight Product Offerings","allOf":[{"$ref":"#/components/schemas/UpsellOfferingID"},{"required":["ProductBrandOptions"],"properties":{"productRefs":{"type":"array","description":"An unsolicited Offering, offered in conjunction with specified product(s)","items":{"type":"string"}},"sequence":{"type":"integer","description":"NumberDoubleDigit","format":"int32","example":1},"Departure":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Departure location","example":"LHR"},"Arrival":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Arrival location","example":"LAX"},"Brand":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/BrandID"}},"ProductBrandOptions":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductBrandOptions"}}}}]}},"components/schemas/UpsellOfferingID":{"id":"components/schemas/UpsellOfferingID","kind":"json-schema","title":"UpsellOfferingID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes UpsellOfferingID and UpsellOffering","example":"UpsellOffering"},"id":{"type":"string","description":"Local identifier within a given message for this object."},"Identifier":{"$ref":"#/components/schemas/Identifier"},"CatalogProductOfferingRef":{"type":"string","description":"Used to reference another instance of this object in the same message"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ErrorResponseWrapper":{"id":"components/schemas/ErrorResponseWrapper","kind":"json-schema","title":"ErrorResponseWrapper","data":{"properties":{"ErrorResponse":{"$ref":"#/components/schemas/ErrorResponse"}},"description":"Wrapper object"}},"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/CatalogProductOfferingsQueryBuildNext":{"id":"components/schemas/CatalogProductOfferingsQueryBuildNext","kind":"json-schema","title":"CatalogProductOfferingsQueryBuildNext","data":{"required":["@type","BuildFromCatalogProductOfferingsRequest"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes","example":"CatalogProductOfferingsQueryBuildNext"},"ignoreCabinPreferenceInd":{"type":"boolean","description":"If true, cabin preference sent in initial search request will be ignored. Offers/products will be returned for all cabins, starting with Economy, when applicable.  Up to 4 upsells can be returned, based on the maxNumberOfUpsellsToReturn sent in the Search req."},"BuildFromCatalogProductOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"},"BrandOptions":{"$ref":"#/components/schemas/BrandOptionsEnum"}},"description":"Used for a Next Leg Search request. Defines a request to retrieve offers for the next leg of an itinerary by referencing the preceding Search response and the selected offer and product for the prior leg. This request follows a leg-based Search and can be repeated for each remaining leg of a multi-city itinerary."}},"components/schemas/BuildFromCatalogProductOfferingsRequest":{"id":"components/schemas/BuildFromCatalogProductOfferingsRequest","kind":"json-schema","title":"BuildFromCatalogProductOfferingsRequest","data":{"required":["@type","CatalogProductOfferingSelection","CatalogProductOfferingsIdentifier"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes BuildFromCatalogProductOfferingsRequestAir, BuildFromCatalogProductOfferingsRequestAirSearch, and BuildFromCatalogProductOfferingsRequestAirChange","example":"BuildFromCatalogProductOfferingsRequestAir"},"CatalogProductOfferingsIdentifier":{"$ref":"#/components/schemas/CatalogProductOfferingsIdentifier"},"CatalogProductOfferingSelection":{"maxItems":16,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CatalogProductOfferingSelection"}},"UpsellOfferingIdentifier":{"maxItems":100,"type":"array","description":"Will not implement.","deprecated":true,"items":{"$ref":"#/components/schemas/UpsellOfferingIdentifier"}}},"description":"Used to reference Air Search requests, such as for a Next Leg, reference-payload Price and Add Offer, or other reference-based calls. Defines the identifiers and selections needed to continue a workflow from a preceding Search response, including the cached search result id and the chosen offer and product to carry forward into the next request.","discriminator":{"propertyName":"@type"}}},"components/schemas/CatalogProductOfferingsIdentifier":{"id":"components/schemas/CatalogProductOfferingsIdentifier","kind":"json-schema","title":"CatalogProductOfferingsIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"cpo_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Used to identify a cached Air Search result for subsequent reference-payload requests. Defines the transaction identifier returned from Search that is sent in later steps (such as Next Leg Search and other workflows) to reference a prior search response.  \nThe Search response does not return the CatalogProductOfferings/Identifier object if caching is not invoked with offersPerPage in the Search request. A subsequent reference payload request to those search results cannot be sent without caching and the CatalogProductOfferings/Identifier value."}},"components/schemas/CatalogProductOfferingSelection":{"id":"components/schemas/CatalogProductOfferingSelection","kind":"json-schema","title":"CatalogProductOfferingSelection","data":{"required":["CatalogProductOfferingIdentifier","ProductIdentifier"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"CatalogProductOfferingSelection"},"CatalogProductOfferingIdentifier":{"$ref":"#/components/schemas/CatalogProductOfferingIdentifier"},"ProductBrandOfferingIdentifier":{"$ref":"#/components/schemas/Identifier"},"ProductIdentifier":{"maxItems":10,"type":"array","description":"A list of values used to reference specific products.","items":{"$ref":"#/components/schemas/ProductIdentifier"}},"SegmentSequence":{"type":"array","example":[1,2],"items":{"type":"integer","format":"int32"}}},"description":"Used to select one or more offers and products from a preceding Air Search response for a follow-on reference-payload request. Defines the selected CatalogProductOfferingIdentifier and ProductIdentifier, and can optionally specify segment sequence information when segment-level selection is needed."}},"components/schemas/CatalogProductOfferingIdentifier":{"id":"components/schemas/CatalogProductOfferingIdentifier","kind":"json-schema","title":"CatalogProductOfferingIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"cpo_1"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"CatalogProductOfferingRef":{"type":"string","description":"Not used. Allows referencing another instance of this object in the same message.","example":"cpo_1"}},"description":"Top level object for offer identifier."}},"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/UpsellOfferingIdentifier":{"id":"components/schemas/UpsellOfferingIdentifier","kind":"json-schema","title":"UpsellOfferingIdentifier","data":{"properties":{"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"UpsellOffering"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"CatalogProductOfferingRef":{"type":"string","description":"Used to reference another instance of this object in the same message"}},"description":"Upsell Offering Identifier class"}},"components/schemas/BrandOptionsEnum":{"id":"components/schemas/BrandOptionsEnum","kind":"json-schema","title":"BrandOptionsEnum","data":{"type":"string","description":"Send with the value returnAllBrands to return all brands in a fare family regardless of the brand of the anchoring flight chosen from the initial Search response. GDS only; not supported for NDC. Not supported in the Flight Specific Search full payload request.","enum":["keepToBrand","returnAllBrands"],"x-enumDescriptions":{"keepToBrand":"When selecting this choice, the brand is kept for the anchored flight and all brands that pass combinability are returned for the next leg option.","returnAllBrands":"When selecting this choice, all brands that pass combinability are returned for the next leg option or journey."}}},"components/schemas/CatalogProductOfferingsQueryBuildOptions":{"id":"components/schemas/CatalogProductOfferingsQueryBuildOptions","kind":"json-schema","title":"CatalogProductOfferingsQueryBuildOptions","data":{"required":["@type","BuildOptions"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes","example":"CatalogProductOfferingsQueryBuildOptions"},"BuildOptions":{"$ref":"#/components/schemas/BuildOptions"}},"description":"Used for a Flight Specific Search request. Requires the identifiers for the transaction, offer, and product for which you want to return additional upsells. This request follows Search or Next Leg Search in the Air shopping workflow and is supported for GDS only."}},"components/schemas/BuildOptions":{"id":"components/schemas/BuildOptions","kind":"json-schema","title":"BuildOptions","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":"Reference Payload Flight Specific Search child class is BuildOptionsFromCatalogProductOptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full Payload Flight Specific Search child class is BuildOptionsFromProducts"},"children":[]}]}]}]}],"example":"BuildOptionsFromCatalogProductOptions"},"maxNumberOfUpsellsToReturn":{"type":"integer","description":"Number of upsells to return. Valid values are 0 to 99 inclusive. If the carrier has filed fewer upsells, all filed upsells are returned.","format":"int32","example":2},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"FareRuleType":{"$ref":"#/components/schemas/FareRuleEnum"},"FareRuleCategory":{"maxItems":10,"type":"array","description":"Not supported for flight specific search","deprecated":true,"items":{"$ref":"#/components/schemas/FareRuleCategoryEnum"}},"BrandOptions":{"$ref":"#/components/schemas/BrandOptionsEnum"},"returnBrandedFaresInd":{"type":"boolean","description":"Not supported in flight specific search","deprecated":true},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"}},"description":"Used for a Flight Specific Search request. Selects the specific flights and the maximum number of upsells to return.","discriminator":{"propertyName":"@type"}}},"components/schemas/FareRuleEnum":{"id":"components/schemas/FareRuleEnum","kind":"json-schema","title":"FareRuleEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use not recommended; request fare rules using the Fare Rules API request instead."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns fare rules in the offer response."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Structured rules limit the rules returned to one or more of these categories: advance reservation/ticketing requirements, minimum/maximum stay, stopovers, penalties, voluntary exchanges and refunds."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDS supports all categories; NDC supports only penalties. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/fare-rules-guide"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fare Rules Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details. Note that even if fare rules are not requested, for GDS only, change and cancel penalties are returned unless suppressed by sending CustomResponseModifiersAir/excludePenaltiesInd set to true."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not supported in BuildOptions (Flight Specific Search)."},"children":[]}]}]}],"enum":["Structured","ShortText","LongText"]}},"components/schemas/FareRuleCategoryEnum":{"id":"components/schemas/FareRuleCategoryEnum","kind":"json-schema","title":"FareRuleCategoryEnum","data":{"type":"string","description":"Use not recommended; request fare rules using the fare rule endpoints.  \nReturns selected fare rules in the offer response. GDS supports all categories; NDC supports only penalties.  \nNote that even if fare rules are not requested, for GDS only, change and cancel penalties are returned unless suppressed by sending CustomResponseModifiersAir/excludePenaltiesInd set to true.","enum":["AdvanceReservationsTicketing","MinimumStay","MaximumStay","Stopovers","Penalties","Eligibility","DayTime","Seasonality","FlightApplication","Transfers","Combinations","BlackoutDates","Surcharges","AccompaniedTravel","TravelRestrictions","SalesRestrictions","HIPMileageExeptions","TicketEndorsements","ChildrenDiscounts","TourConductorDiscounts","AgentDiscounts","AllOtherDiscounts","MiscellaneousProvisions","FareByRule","Groups","Tours","VisitAnotherCountry","Deposits","VoluntaryChanges","VoluntaryRefunds","NegotiatedFares","ApplicationAndOtherConditions"]}},"components/schemas/OfferQueryBuildFromCatalogProductOfferings":{"id":"components/schemas/OfferQueryBuildFromCatalogProductOfferings","kind":"json-schema","title":"OfferQueryBuildFromCatalogProductOfferings","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes","example":"OfferQueryBuildFromCatalogProductOfferings"},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"BuildFromCatalogProductOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"},"MaxNumberOfUpsellsToReturn":{"maximum":12,"minimum":1,"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC only; not supported for GDS."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports values from 0 to 99 inclusive. Send to request upsell offers along with pricing for the requested class of service or cabin, returned in ascending price order. An upsell is the next highest fare in a different brand or cabin than requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsells are returned as follows:"},"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":"If upsells not requested: Only the requested offer is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If one upsell requested: The lowest priced offer in the requested class of service or cabin plus one upsell offer are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If two or more upsells requested: The lowest priced offer in the requested class of service or cabin plus the requested number of upsell offers are returned."},"children":[]}]}]}]}],"format":"int32","example":4}},"description":"Used for AirPrice and Add Offer reference-payload requests. Defines a request that references selected results from a preceding Search response by sending the cached transaction identifier together with the selected offer and product identifiers.  \nTo use the reference payload requests, your initial Search request must send offersPerPage to invoke caching if that Search was journey-based (leg-based search results are always cached).  \nIn pricing workflows, this request is used to confirm pricing on selected search results. While air pricing is generally an optional but recommended step, it is required for low cost carriers and some NDC carriers.  \nIn booking workflows, it is used to add a selected offer to the reservation workbench."}},"components/schemas/OfferListResponseWrapper":{"id":"components/schemas/OfferListResponseWrapper","kind":"json-schema","title":"OfferListResponseWrapper","data":{"properties":{"OfferListResponse":{"$ref":"#/components/schemas/OfferListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/OfferListResponse":{"id":"components/schemas/OfferListResponse","kind":"json-schema","title":"OfferListResponse","data":{"properties":{"OfferID":{"maxItems":1000,"type":"array","description":"Returns the system-generated offer identifier. This identifier must be sent in several subsequent transactions, such as payment and ticketing.","items":{"$ref":"#/components/schemas/OfferID"}}},"description":"The response of an Offer list endpoint request, such as AirPrice and Add Offer calls.  \nDefines one or more air offers returned including the offer identifiers and related response data needed for subsequent booking steps.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"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/OfferQueryBuildFromProducts":{"id":"components/schemas/OfferQueryBuildFromProducts","kind":"json-schema","title":"OfferQueryBuildFromProducts","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes","example":"OfferQueryBuildFromProducts"},"BuildFromProductsRequest":{"$ref":"#/components/schemas/BuildFromProductsRequest"},"CabinPreference":{"$ref":"#/components/schemas/CabinPreference"},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"FareRuleType":{"$ref":"#/components/schemas/FareRuleEnum"},"FareRuleCategory":{"maxItems":10,"type":"array","description":"Not recommended to use. Invoke fare rule end points directly.","items":{"$ref":"#/components/schemas/FareRuleCategoryEnum"}},"lowFareFinderInd":{"type":"boolean","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":"Provides pricing flexibility around class of service."},"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":"If true: returns the lowest fares available in any class of service available, which may not be the same as the requested class."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): the response returns fares only in the requested class of service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes for modifier interations:"},"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":"If lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When lowFareFindInd=true and brand attributes are not disabled with inhibitBrandContentInd, AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service."},"children":[]}]}]}]}],"example":true},"returnBrandedFaresInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use to request the return of branded fares, which by default are not returned for the AirPrice Full 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":"If true, returns branded fares. For AirPrice this is supported only in the full payload request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Does not return branded fares."},"children":[]}]}]}]}],"example":true},"reCheckInventoryInd":{"type":"boolean","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 (NDC carriers always validate inventory at pricing)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether to validate inventory on the first flight in the itinerary in the requested class of service by booking and then releasing seats. Can help reduce sell failures at booking by alerting of insufficient availability."},"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":"If true, verifies availability for the requested number of passengers in a specific class of service at the time of the price request by booking and releasing seats. If any or all segments are not bookable, AirPrice returns a message that the air segment/s are not bookable along with the dates and city pairs of the segments that are not bookable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Checks only for general seat availability on the flight, not a specific class of service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because this indicator temporarily affects seat availability, the recommended best practice is to use validateInventoryInd instead. Some airlines monitor for high volumes of sell/ignore transactions. Regardless of pricing results, air fares and inventory are only guaranteed by airlines when ticketed and paid."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cause AirPrice to perform the same check for connecting flights, you can send both reCheckInventory=true and SpecificFlightCriteria/boundFlightsInd=true for each connecting flight."},"children":[]}]}]}],"example":true},"validateInventoryInd":{"type":"boolean","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, as NDC carriers already validate inventory at pricing."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether to validate inventory in the requested class of service."},"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":"If true, checks for availability for the requested number of passengers in the requested class of service at the time of the price request. If there are fewer seats than requested passengers available in that class of service, AirPrice does not return any offers and instead returns an error message that the booking class or preference is not available. This reduces failures at the Add Offer and Workbench Commit steps."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Checks only for general seat availability on the flight, not a specific class of service. AirPrice may return upsell offers with no availability in the requested class of service."},"children":[]}]}]}]}],"example":true},"MaxNumberOfUpsellsToReturn":{"maximum":12,"minimum":1,"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC only; not supported for GDS."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports values from 0 to 99 inclusive. Send to request upsell offers along with pricing for the requested class of service or cabin, returned in ascending price order. An upsell is the next highest fare in a different brand or cabin than requested."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsells are returned as follows:"},"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":"Upsells not requested: Only the requested offer is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One upsell requested: The lowest priced offer in the requested class of service or cabin plus one upsell offer are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two upsells requested (and so on for x upsells requested): The lowest priced offer in the requested class of service or cabin plus two upsell offers are returned."},"children":[]}]}]}]}],"format":"int32","example":4}},"description":"Used for AirPrice and Add Offer full-payload requests. Defines the top-level request for building an offer from full itinerary details, together with optional cabin, payment, fare rule, branding, inventory, and upsell controls. The full payload request sends full itinerary details without a reference to any previous search.   \nIn pricing workflows, this request is used to confirm pricing for a supplied itinerary without using a cache to reference a prior Search response. It can be used to price an itinerary returned from the Search API or from a non-Travelport source.  \nFor NDC, only specific NDC carriers support the AirPrice full payload request.  \nIn booking workflows, it is used to add a supplied itinerary to the reservation workbench as an offer."}},"components/schemas/BuildFromProductsRequest":{"id":"components/schemas/BuildFromProductsRequest","kind":"json-schema","title":"BuildFromProductsRequest","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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Next Leg Search and AirPrice child classes BuildFromProductsRequestAir, BuildFromProductsRequestAirSearch, and BuildFromProductsRequestOfferConstruction"},"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":"To price all PTCs and segments send with @type BuildFromProductsRequestAir."},"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":"To price a specific PTC and/or air segment, send with @type BuildFromProductsRequestOfferConstruction"},"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":"TripChange child class is BuildFromProductsRequestAirChange"},"children":[]}]}]}]}]}],"example":"BuildFromProductsRequestAir"}},"description":"GDS only. Not supported for NDC.  \nFull payload itinerary request used in multiple work flows. Flight Specific Search, Full payload Price, Full payload Book. ","discriminator":{"propertyName":"@type"}}},"components/schemas/FareRuleListResponseWrapper":{"id":"components/schemas/FareRuleListResponseWrapper","kind":"json-schema","title":"FareRuleListResponseWrapper","data":{"properties":{"FareRuleListResponse":{"$ref":"#/components/schemas/FareRuleListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/FareRuleListResponse":{"id":"components/schemas/FareRuleListResponse","kind":"json-schema","title":"FareRuleListResponse","data":{"properties":{"@type":{"type":"string","example":"FareRuleListResponse"},"FareRule":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/FareRule"}},"transactionId":{"type":"string","description":"Unique transaction, correlation or tracking id for a single request and reply i.e. for a single transaction. Should be a 128 bit GUID format. Also know as E2ETrackingId.","example":"6570ed7b-89fe-4334-9c78-af282a977ba6"},"traceId":{"type":"string","description":"Optional ID for internal child transactions created for processing a single request (single transaction). Should be a 128 bit GUID format. Also known as ChildTrackingId.","example":"c009a53c-48f6-4084-b7b6-3043fa9fec67"},"Result":{"$ref":"#/components/schemas/Result"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"ReferenceList":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/ReferenceList"}}},"description":"The response of a Fare rule list endpoint request."}},"components/schemas/FareRule":{"id":"components/schemas/FareRule","kind":"json-schema","title":"FareRule","data":{"allOf":[{"$ref":"#/components/schemas/FareRuleID"},{"required":["Flight"],"properties":{"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number of fare rule","example":"34","deprecated":true},"tariffNumber":{"maxLength":32,"type":"string","description":"Fare rule tarrif number","example":"56","deprecated":true},"Flight":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/FlightID"}}}}]}},"components/schemas/FareRuleID":{"id":"components/schemas/FareRuleID","kind":"json-schema","title":"FareRuleID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"FareRuleText"},"id":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Discriminator classes FareRuleID, FareRuleStructured or FareRuleText","discriminator":{"propertyName":"@type"}}},"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/CatalogOfferingsQuerySeatAvailability":{"id":"components/schemas/CatalogOfferingsQuerySeatAvailability","kind":"json-schema","title":"CatalogOfferingsQuerySeatAvailability","data":{"required":["@type","SeatAvailabilityOfferings"],"properties":{"@type":{"type":"string","description":"Discriminator class CatalogOfferingsQuerySeatAvailability only","example":"CatalogOfferingsQuerySeatAvailability"},"SeatAvailabilityOfferings":{"$ref":"#/components/schemas/SeatAvailabilityOfferings"}},"description":"Used for a Seat Map request. Defines the request payload for returning seat availability for free and paid seats by referencing prior shopping, pricing, booking, or reservation data.  This request can be sent at multiple points in the Air workflow:  When sent after a Search request and prior to pricing or a workbench session, the Seat Map request sends identifiers from the Search response. When sent after a Price request and prior to initiating a workbench session, the Seat Map request sends identifiers from the Price response. When sent during a workbench session, the Seat Map request sends identifiers from the responses in the booking flow or, for a post-commit workbench, from the Workbench Create or Reservation Retrieve responses. The Standalone Seat map response is the same as the reference payload seat map response, with the exception that Result/Warning/Message is returned with the message 'The seatMap is view only'."}},"components/schemas/SeatAvailabilityOfferings":{"id":"components/schemas/SeatAvailabilityOfferings","kind":"json-schema","title":"SeatAvailabilityOfferings","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes SeatAvailabilityOfferingsBuildFromCatalogOfferings, SeatAvailabilityOfferingsBuildFromCatalogProductOfferings, SeatAvailabilityOfferingsBuildFromOffer, SeatAvailabilityOfferingsBuildFromOfferList, SeatAvailabilityOfferingsBuildFromProducts, and SeatAvailabilityOfferingsBuildFromReservationWorkbench","example":"SeatAvailabilityOfferings"},"CustomerLoyalty":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Including a loyalty number causes the seat map service to recalculate availability, pricing, and eligibility using the traveler’s elite tier and benefits. The returned seat map reflects what that specific customer can select, not just what exists on the aircraft."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CustomerLoyalty"}}},"discriminator":{"propertyName":"@type"}}},"components/schemas/CatalogOfferingsAncillaryListResponseWrapper":{"id":"components/schemas/CatalogOfferingsAncillaryListResponseWrapper","kind":"json-schema","title":"CatalogOfferingsAncillaryListResponseWrapper","data":{"properties":{"CatalogOfferingsAncillaryListResponse":{"$ref":"#/components/schemas/CatalogOfferingsAncillaryListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/CatalogOfferingsAncillaryListResponse":{"id":"components/schemas/CatalogOfferingsAncillaryListResponse","kind":"json-schema","title":"CatalogOfferingsAncillaryListResponse","data":{"properties":{"CatalogOfferingsID":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CatalogOfferings"}}},"description":"The response of a Catalog Offerings Ancillary list endpoint request.  For Seats, the seat map response is nearly identical whether the request was sent after Search, after AirPrice, or in a workbench session. The only difference is that outside a workbench session, TravelerIdentifierRef returns only passengerTypeCode, as there are no traveler details at this point in the workflow. When Seat Map is sent for flight/s in a booking that already have seat assignments, the response inlcudes HeldAncillary to list the current SeatAssignment for each traveler on the flight/s. This supports modifying seats by holding the current seats until the new seats are successfully booked at workbench commit, ensuring those seats remain available in case of a booking failure.  The Standalone Seat map response is the same as the reference payload seat map response, with the exception that a Result/Warning/Message is returned with the message 'The seatMap is view only'.","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/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/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/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/OfferQueryBuildAncillaryOffersFromCatalogOfferings":{"id":"components/schemas/OfferQueryBuildAncillaryOffersFromCatalogOfferings","kind":"json-schema","title":"OfferQueryBuildAncillaryOffersFromCatalogOfferings","data":{"required":["@type","BuildAncillaryOffersFromCatalogOfferings"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryBuildAncillaryOffersFromCatalogOfferings only","example":"OfferQueryBuildAncillaryOffersFromCatalogOfferings"},"BuildAncillaryOffersFromCatalogOfferings":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/BuildAncillaryOffersFromCatalogOfferings"}}}}},"components/schemas/BuildAncillaryOffersFromCatalogOfferings":{"id":"components/schemas/BuildAncillaryOffersFromCatalogOfferings","kind":"json-schema","title":"BuildAncillaryOffersFromCatalogOfferings","data":{"required":["@type","CatalogOfferingIdentifier","CatalogOfferingsIdentifier"],"properties":{"@type":{"type":"string","description":"Discriminator classes BuildAncillaryOffersFromCatalogOfferings or BuildAncillaryOffersFromCatalogOfferingsAirSeat","example":"BuildAncillaryOffersFromCatalogOfferings"},"CatalogOfferingsIdentifier":{"$ref":"#/components/schemas/CatalogOfferingsIdentifier"},"CatalogOfferingIdentifier":{"$ref":"#/components/schemas/CatalogOfferingIdentifier"},"ProductIdentifier":{"$ref":"#/components/schemas/ProductIdentifier"},"Quantity":{"type":"integer","description":"The quantity of ancillaries to be included in the Offer","format":"int32","example":3},"TravelerIdentifierRef":{"$ref":"#/components/schemas/TravelerIdentifierRef"},"CatalogOfferingsAncillaryListIdentifier":{"$ref":"#/components/schemas/Identifier"},"includeUnsellableAncillariesInd":{"type":"boolean","description":"If true, the response will include unsellable ancillary options","example":true},"Comments":{"$ref":"#/components/schemas/Comments"}},"discriminator":{"propertyName":"@type"}}},"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/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/CatalogOfferingsQueryAncillaries":{"id":"components/schemas/CatalogOfferingsQueryAncillaries","kind":"json-schema","title":"CatalogOfferingsQueryAncillaries","data":{"required":["@type","AncillaryOfferings"],"properties":{"@type":{"type":"string","description":"Discriminator class CatalogOfferingsQueryAncillaries only","example":"CatalogOfferingsQueryAncillaries"},"AncillaryOfferings":{"$ref":"#/components/schemas/AncillaryOfferings"}}}},"components/schemas/AncillaryOfferings":{"id":"components/schemas/AncillaryOfferings","kind":"json-schema","title":"AncillaryOfferings","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes AncillaryOfferingsBuildFromCatalogOfferings, AncillaryOfferingsBuildFromCatalogProductOfferings, AncillaryOfferingsBuildFromOfferList, AncillaryOfferingsBuildFromOffer, and AncillaryOfferingsBuildFromReservationWorkbench","example":"AncillaryOfferingsBuildFromReservationWorkbench"},"includeUnsellableAncillariesInd":{"type":"boolean","description":"If true, the response will include unsellable ancillary options","example":true}},"discriminator":{"propertyName":"@type"}}},"components/schemas/OfferQueryCancelOffer":{"id":"components/schemas/OfferQueryCancelOffer","kind":"json-schema","title":"OfferQueryCancelOffer","data":{"required":["@type","BuildFromOffer"],"properties":{"@type":{"type":"string","example":"OfferQueryCancelOffer"},"BuildFromOffer":{"$ref":"#/components/schemas/BuildFromOffer"},"TravelerIdentifier":{"maxItems":8,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"cancelAtCommitWorkbenchInd":{"type":"boolean","description":"If true, the Offer will be cancelled when the user commits workbench. Refund Quote will not be returned when this indicator is set to true.","example":true},"divideReservationByTravelerInd":{"type":"boolean","description":"If true, this refund quote request will result in the original reservation being divided and cancelled for the specified traveler. When true, TravelerRef is mandatory in the request payload.","example":true}},"description":"Discriminator class OfferQueryCancelOffer only"}},"components/schemas/BuildFromOffer":{"id":"components/schemas/BuildFromOffer","kind":"json-schema","title":"BuildFromOffer","data":{"required":["@type","OfferIdentifier"],"properties":{"@type":{"type":"string","description":"Discriminator classes BuildFromOffer and BuildFromOfferAir","example":"BuildFromOffer"},"OfferIdentifier":{"$ref":"#/components/schemas/OfferIdentifier"},"ProductIdentifier":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ProductIdentifier"}},"PassengerCriteria":{"maxItems":10,"type":"array","description":"Optional passenger criteria to associate request to a specific passenger.","items":{"$ref":"#/components/schemas/PassengerCriteria"}},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"}},"discriminator":{"propertyName":"@type"}}},"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/EMDListResponseWrapper":{"id":"components/schemas/EMDListResponseWrapper","kind":"json-schema","title":"EMDListResponseWrapper","data":{"properties":{"EMDListResponse":{"$ref":"#/components/schemas/EMDListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/EMDListResponse":{"id":"components/schemas/EMDListResponse","kind":"json-schema","title":"EMDListResponse","data":{"description":"The response of a EMD list endpoint request.","allOf":[{"properties":{"EMDID":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/EMD"}}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/EMD":{"id":"components/schemas/EMD","kind":"json-schema","title":"EMD","data":{"description":"API will return EMD or EMDSummary.","allOf":[{"$ref":"#/components/schemas/EMDID"},{"required":["AgencyInfo","EMDSegment","FormOfPayment","PersonName"],"properties":{"PersonName":{"$ref":"#/components/schemas/PersonName"},"ReservationLocator":{"maxItems":2,"type":"array","items":{"$ref":"#/components/schemas/SupplierLocator"}},"AgencyInfo":{"$ref":"#/components/schemas/AgencyInfo"},"EMDSegment":{"maxItems":16,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/EMDSegment"}},"TotalAmount":{"$ref":"#/components/schemas/TotalAmount"},"FormOfPayment":{"$ref":"#/components/schemas/FormOfPayment"},"ESAC":{"maxLength":128,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The BSP ESAC code assign for a void or refund transaction\\nThe BSP E"},"children":[]}]}]}]},"AssociatedTicketNumber":{"$ref":"#/components/schemas/TicketNumber"},"Restrictions":{"maxItems":5,"type":"array","items":{"maxLength":512,"type":"string"}}}}]}},"components/schemas/EMDID":{"id":"components/schemas/EMDID","kind":"json-schema","title":"EMDID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes EMDID, EMD, or EMDSummary","example":"EMD"},"id":{"type":"string","description":"EMD reference ID."},"EMDRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"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/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/AgencyInfo":{"id":"components/schemas/AgencyInfo","kind":"json-schema","title":"AgencyInfo","data":{"required":["name","ticketingCity","ticketingCountry"],"properties":{"ticketedDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"Ticketed date","example":"2026-04-05"},"name":{"maxLength":32,"type":"string","description":"Name of the Agency","example":"Alpha travel"},"place":{"maxLength":32,"type":"string","description":"Place of the agency","example":"Marietta"},"ticketingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"Ticketing PCC","example":"1CR"},"code":{"pattern":"([0-9]{8})","type":"string","description":"Agency code","example":"12430870"},"salesType":{"maxLength":32,"type":"string","description":"Sales type","example":"Ticketing"},"ticketingCountry":{"maxLength":32,"type":"string","description":"Ticketing country","example":"US"},"ticketingCity":{"maxLength":32,"type":"string","description":"Ticketing city","example":"NYC"}},"description":"Detail of the travel agency that issues the ticket"}},"components/schemas/EMDSegment":{"id":"components/schemas/EMDSegment","kind":"json-schema","title":"EMDSegment","data":{"required":["@type","sequence"],"properties":{"@type":{"type":"string","example":"EMDSegment"},"sequence":{"type":"integer","description":"Sequence of EMDSegment","format":"int32"},"quantity":{"type":"integer","description":"The quantity of the ancillary available on this EMDSegment","format":"int32"},"EMDDescription":{"$ref":"#/components/schemas/EMDDescription"},"Amount":{"$ref":"#/components/schemas/Amount"},"Status":{"$ref":"#/components/schemas/EMDStatusENUM"},"DateOfService":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"The date of service the service is available for"},"PresentTo":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The airline the EMD should be presented to to supply the service"},"PresentAt":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The location the EMD should be presented to to supply the service"},"Routing":{"maxLength":128,"type":"string","description":"The routing the service is valid on"}}}},"components/schemas/EMDDescription":{"id":"components/schemas/EMDDescription","kind":"json-schema","title":"EMDDescription","data":{"properties":{"value":{"maxLength":512,"type":"string","example":"First checked bag"},"code":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"A description of the ancillary with two description codes","example":"BG"},"subCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"EMD number sub code","example":"02C"},"codeContext":{"maxLength":32,"type":"string","description":"Code context","example":"ATPCO"}},"description":"A description of the ancillary with two description codes"}},"components/schemas/EMDStatusENUM":{"id":"components/schemas/EMDStatusENUM","kind":"json-schema","title":"EMDStatusENUM","data":{"type":"string","description":"The EMD status.","example":"Refund","enum":["Open","Refund","Used","Void"]}},"components/schemas/TotalAmount":{"id":"components/schemas/TotalAmount","kind":"json-schema","title":"TotalAmount","data":{"properties":{"@type":{"type":"string","default":"TotalAmount"},"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":"Total Amount object"}},"components/schemas/FormOfPayment":{"id":"components/schemas/FormOfPayment","kind":"json-schema","title":"FormOfPayment","data":{"properties":{"value":{"$ref":"#/components/schemas/FormOfPaymentTypeEnum"},"documentNumber":{"maxLength":4096,"pattern":"([0-9]+)?","type":"string","description":"Payment document number","example":"45"},"encryptedValue":{"maxLength":512,"type":"string","description":"Encrypted value","example":"BNASJASJKASKJASHJKASK"},"documentIssuer":{"maxLength":32,"type":"string","description":"Document issuer","example":"Alpha travel"},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"}}}},"components/schemas/FormOfPaymentTypeEnum":{"id":"components/schemas/FormOfPaymentTypeEnum","kind":"json-schema","title":"FormOfPaymentTypeEnum","data":{"type":"string","description":"The list of valid forms of payment.","example":"PaymentCard","enum":["AgencyAccount","BSP","Cash","Document","Invoice","PaymentCard","WaiverCode"]}},"components/schemas/TicketNumber":{"id":"components/schemas/TicketNumber","kind":"json-schema","title":"TicketNumber","data":{"properties":{"value":{"maxLength":4096,"pattern":"([0-9]+)?","type":"string","description":"Ticket number","example":"1156"},"ticketIssuer":{"maxLength":32,"type":"string","description":"Ticket issuer","example":"Cargo airways"},"contentSource":{"$ref":"#/components/schemas/ContentSourceEnum"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ticketNumber that will be used as partial payment for this Offer/Offering"},"children":[]}]}]}]}},"components/schemas/EMDQueryUpdateEMD":{"id":"components/schemas/EMDQueryUpdateEMD","kind":"json-schema","title":"EMDQueryUpdateEMD","data":{"required":["@type","status"],"properties":{"@type":{"type":"string","example":"EMDQueryUpdateEMD"},"agencyCode":{"pattern":"([0-9]{8})","type":"string","description":"The agency IATA code","example":"91219332"},"status":{"maxLength":32,"type":"string","description":"Status to update the EMD","example":"Void"},"dateOfIssue":{"type":"string","description":"The date the EMD was issued","format":"date"}}}},"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/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/CancelRequest":{"id":"components/schemas/CancelRequest","kind":"json-schema","title":"CancelRequest","data":{"properties":{"cancelAllInd":{"type":"boolean","description":"If true, all offers and unpriced segments in the reservation will be cancelled. Includes air, hotel, car offers and unpricedSegments."},"cancelOffers":{"$ref":"#/components/schemas/CancelOffers"},"cancelUnpricedSegments":{"$ref":"#/components/schemas/CancelUnpricedSegments"},"cancelAuxiliarySegments":{"$ref":"#/components/schemas/CancelAuxiliarySegments"}},"description":"Cancel request allows the user to cancel an offer or unpriced segment in its entirety or at the product/segment level. NDC cancel is not currently supported using this API post commit. Restrictions on NDC content also apply pre commit."}},"components/schemas/CancelOffers":{"id":"components/schemas/CancelOffers","kind":"json-schema","title":"CancelOffers","data":{"required":["objectType"],"type":"object","properties":{"objectType":{"$ref":"#/components/schemas/CancelOffersObjectTypeENUM"}},"description":"Parent class must be substituted with subclass CancelAllOffers or CancelSelectedOffers.","discriminator":{"propertyName":"objectType"}}},"components/schemas/CancelOffersObjectTypeENUM":{"id":"components/schemas/CancelOffersObjectTypeENUM","kind":"json-schema","title":"CancelOffersObjectTypeENUM","data":{"type":"string","description":"CancelOffers sub type options.","example":"CancelSelectedOffers","enum":["CancelAllOffers","CancelSelectedOffers"]}},"components/schemas/CancelUnpricedSegments":{"id":"components/schemas/CancelUnpricedSegments","kind":"json-schema","title":"CancelUnpricedSegments","data":{"required":["objectType"],"type":"object","properties":{"objectType":{"$ref":"#/components/schemas/CancelUnpricedSegmentsObjectTypeENUM"}},"description":"Parent class must be substituted with subclass CancelAllUnpricedSegments or CancelSelectedUnpricedSegments","discriminator":{"propertyName":"objectType"}}},"components/schemas/CancelUnpricedSegmentsObjectTypeENUM":{"id":"components/schemas/CancelUnpricedSegmentsObjectTypeENUM","kind":"json-schema","title":"CancelUnpricedSegmentsObjectTypeENUM","data":{"type":"string","description":"CancelUnpricedSegments sub type options.","example":"CancelSelectedUnpricedSegments","enum":["CancelAllUnpricedSegments","CancelSelectedUnpricedSegments"]}},"components/schemas/CancelAuxiliarySegments":{"id":"components/schemas/CancelAuxiliarySegments","kind":"json-schema","title":"CancelAuxiliarySegments","data":{"required":["objectType"],"type":"object","properties":{"objectType":{"$ref":"#/components/schemas/CancelAuxiliarySegmentsObjectTypeENUM"}},"description":"Parent class must be substituted with subclass CancelAllAuxiliarySegments or CancelSelectedAuxiliarySegments","discriminator":{"propertyName":"objectType"}}},"components/schemas/CancelAuxiliarySegmentsObjectTypeENUM":{"id":"components/schemas/CancelAuxiliarySegmentsObjectTypeENUM","kind":"json-schema","title":"CancelAuxiliarySegmentsObjectTypeENUM","data":{"type":"string","description":"CancelAuxiliarySegments sub type options.","example":"CancelSelectedAuxiliarySegments","enum":["CancelAllAuxiliarySegments","CancelSelectedAuxiliarySegments"]}},"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/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/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/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/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/DocumentOverridesResponseWrapper":{"id":"components/schemas/DocumentOverridesResponseWrapper","kind":"json-schema","title":"DocumentOverridesResponseWrapper","data":{"properties":{"DocumentOverridesResponse":{"$ref":"#/components/schemas/DocumentOverridesResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/DocumentOverridesResponse":{"id":"components/schemas/DocumentOverridesResponse","kind":"json-schema","title":"DocumentOverridesResponse","data":{"properties":{"DocumentOverrides":{"$ref":"#/components/schemas/DocumentOverridesID"}},"description":"The response of a Document Overrides endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/TicketChangeEligibilityListResponseWrapper":{"id":"components/schemas/TicketChangeEligibilityListResponseWrapper","kind":"json-schema","title":"TicketChangeEligibilityListResponseWrapper","data":{"properties":{"TicketChangeEligibilityListResponse":{"$ref":"#/components/schemas/TicketChangeEligibilityListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TicketChangeEligibilityListResponse":{"id":"components/schemas/TicketChangeEligibilityListResponse","kind":"json-schema","title":"TicketChangeEligibilityListResponse","data":{"properties":{"TicketChangeEligibility":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/TicketChangeEligibility"}}},"description":"The Eligibility response returns details on whether the ticket can be exchanged or refunded, and the range of possible change fees.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/TicketChangeEligibility":{"id":"components/schemas/TicketChangeEligibility","kind":"json-schema","title":"TicketChangeEligibility","data":{"description":"Details about whether the ticket can be exchanged or refunded.","allOf":[{"$ref":"#/components/schemas/TicketChangeEligibilityID"},{"properties":{"exchangeable":{"$ref":"#/components/schemas/AllSomeNoneEnum"},"refundable":{"$ref":"#/components/schemas/AllSomeNoneEnum"},"Penalties":{"$ref":"#/components/schemas/Penalties"},"PassengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"Passenger Type Code","example":"ADT"},"automationNotSupportedInd":{"type":"boolean","description":"Returned with a value of true only if automated exchanges are not allowed.  \nWith this indicator the following warning is also returned: 'Carrier is not currently supported for automated exchanges. Exchange must be processed manually.'"}}}]}},"components/schemas/TicketChangeEligibilityID":{"id":"components/schemas/TicketChangeEligibilityID","kind":"json-schema","title":"TicketChangeEligibilityID","data":{"properties":{"@type":{"type":"string","example":"TicketChangeEligibility"},"objID":{"type":"string","description":"Ticket number sequence for exchange or refund.  \nNote that for itineraries with multiple passengers, the response returns eligibility details at the passenger level. If there are multiple passengers of the same PTC type, the response returns details and the ticket number for each passenger are returned."},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"description":"Transaction identifier information such as authority and id value."}},"components/schemas/AllSomeNoneEnum":{"id":"components/schemas/AllSomeNoneEnum","kind":"json-schema","title":"AllSomeNoneEnum","data":{"type":"string","description":"Used to indicate if all, some, or none of the fare components can be exchanged or refunded.","example":"All","enum":["All","Some","None"]}},"components/schemas/Penalties":{"id":"components/schemas/Penalties","kind":"json-schema","title":"Penalties","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"Penalties"},"Change":{"maxItems":10,"type":"array","description":"Details about maximum or minimum change fees charged for changes to this itinerary.  \nReturned in Penalties object with type ChangePermitted if a change is permitted after booking.","items":{"$ref":"#/components/schemas/Change"}},"Cancel":{"maxItems":10,"type":"array","description":"Returned in Penalties object with type CancelPermitted if a cancellation is permitted after booking.","items":{"$ref":"#/components/schemas/Cancel"}},"Waiver":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/WaiverEnum"}},"PenaltySourceCode":{"$ref":"#/components/schemas/PenaltySourceCode"},"PassengerTypeCodes":{"type":"array","description":"The passenger type codes that the penalties apply to.","example":["ADT","CHD"],"items":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string"}},"involuntaryInd":{"type":"boolean","description":"Penalties apply for involuntary changes initiated by the airline.","example":true},"applyLeastRestrictiveInd":{"type":"boolean","description":"If true, the least restrictive of the rule hierarchy is applied.","example":true},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info.","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info.","example":"01634"}},"description":"List of refund and change penalties for this offer or itinerary."}},"components/schemas/Change":{"id":"components/schemas/Change","kind":"json-schema","title":"Change","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child classes ChangePermitted, ChangeNotPermitted, and ChangeIndeterminate.","example":"ChangePermitted"},"ProductRefs":{"type":"array","description":"List of product reference ids to which these penalties apply, if applicable only to specific products.","example":["p1","p2"],"items":{"type":"string"}},"SegmentSequence":{"type":"array","description":"List of segment sequence numbers to which these penalties apply, if applicable only to specific segments.","example":[1],"items":{"type":"integer","format":"int32"}}},"description":"Change restrictions applicable to the Offer/Product.","discriminator":{"propertyName":"@type"}}},"components/schemas/Cancel":{"id":"components/schemas/Cancel","kind":"json-schema","title":"Cancel","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"discriminator","example":"CancelPermitted"},"ProductRefs":{"type":"array","description":"The product ids this cancel information applies to.","example":["p1","p2"],"items":{"type":"string"}},"SegmentSequence":{"type":"array","description":"The list of any segment sequence numbers this cancelation information applies to.","example":[1],"items":{"type":"integer","format":"int32"}}},"description":"Cancel restrictions applicable to the Offer/Product. Discriminator classes CancelPermitted, CancelNotPermitted or CancelIndeterminate","discriminator":{"propertyName":"@type"}}},"components/schemas/WaiverEnum":{"id":"components/schemas/WaiverEnum","kind":"json-schema","title":"WaiverEnum","data":{"type":"string","description":"Type of Waiver like Death of Passanger, illness Of Passenger, Death of Immediate Family Member  etc","example":"TicketUpgrade","enum":["DeathOfPassenger","IllnessOfPassenger","DeathOfImmediateFamilyMember","IllnessOfImmediateFamilyMember","TicketUpgrade","ScheduleChange"]}},"components/schemas/PenaltySourceCode":{"id":"components/schemas/PenaltySourceCode","kind":"json-schema","title":"PenaltySourceCode","data":{"properties":{"value":{"maxLength":32,"type":"string","example":"Properties of the penalty"},"codeContext":{"maxLength":32,"type":"string","description":"Penalty source code context","example":"Context of the penalty source"}},"description":"The source of the penalty applied."}},"components/schemas/CatalogOfferingsQueryAirChange":{"id":"components/schemas/CatalogOfferingsQueryAirChange","kind":"json-schema","title":"CatalogOfferingsQueryAirChange","data":{"required":["@type","CatalogOfferingsAirChangeRequest"],"properties":{"@type":{"type":"string","example":"CatalogOfferingsQueryAirChange"},"CatalogOfferingsAirChangeRequest":{"$ref":"#/components/schemas/CatalogOfferingsAirChangeRequestReservation"}},"description":"Discriminator class CatalogOfferingsQueryAirChange only"}},"components/schemas/CatalogOfferingsAirChangeRequestReservation":{"id":"components/schemas/CatalogOfferingsAirChangeRequestReservation","kind":"json-schema","title":"CatalogOfferingsAirChangeRequestReservation","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOfferingsAirChangeRequest"},{"required":["BuildFromReservationWorkbench"],"properties":{"BuildFromReservationWorkbench":{"$ref":"#/components/schemas/BuildFromReservationWorkbench"}}}]}},"components/schemas/CatalogOfferingsAirChangeRequest":{"id":"components/schemas/CatalogOfferingsAirChangeRequest","kind":"json-schema","title":"CatalogOfferingsAirChangeRequest","data":{"required":["@type","PassengerCriteria","SearchCriteriaFlight"],"properties":{"@type":{"type":"string","example":"CatalogOfferingsAirChangeRequestReservation"},"catalogOfferingsPerPage":{"type":"integer","description":"Catalog Offerings per page value","format":"int32","example":5},"SearchCriteriaFlight":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SearchCriteriaFlight"}},"PassengerCriteria":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PassengerCriteria"}},"SearchModifiersAir":{"$ref":"#/components/schemas/SearchModifiersAir"},"PricingModifiersAirChange":{"$ref":"#/components/schemas/PricingModifiersAirChange"},"SearchControlConsoleChannelID":{"$ref":"#/components/schemas/SearchControlConsoleChannelID"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"returnBrandedFaresInd":{"type":"boolean","example":true},"upsellInd":{"type":"boolean","example":true},"detailViewInd":{"type":"boolean","example":true},"divideReservationByTravelerInd":{"type":"boolean","description":"If true, this reprice request will result in the original reservation being divided and modified for the specified traveler. When true, TravelerRef is mandatory in the request payload.","example":true}},"description":"Discriminator classes CatalogOfferingsAirChangeRequestReservation or CatalogOfferingsAirChangeRequestDocumentNumber","discriminator":{"propertyName":"@type"}}},"components/schemas/PricingModifiersAirChange":{"id":"components/schemas/PricingModifiersAirChange","kind":"json-schema","title":"PricingModifiersAirChange","data":{"properties":{"@type":{"type":"string","example":"PricingModifiersAirChange"},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"ISO 4217 currency code","example":"USD"},"FareSelection":{"$ref":"#/components/schemas/FareSelection"},"OrganizationInformation":{"$ref":"#/components/schemas/OrganizationInformation"},"WaiverCode":{"$ref":"#/components/schemas/WaiverCode"},"TaxExemption":{"$ref":"#/components/schemas/TaxExemption"},"PromotionalCode":{"$ref":"#/components/schemas/PromotionalCode"},"SellCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Overrides the sell city of the requestor","example":"MEX"},"TicketCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Overrides the ticket city of the requestor","example":"MEX"},"PricingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"Overrides the pricing PCC of the requestor","example":"0XS4"},"TicketingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"Overrides the ticketing PCC of the requestor","example":"0XCD"},"CalculatedFareAdjustment":{"$ref":"#/components/schemas/CalculatedFareAdjustment"},"BrandPreference":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/BrandPreference"}},"keepToBrandInd":{"type":"boolean","description":"If true, the offerings returned will be of the same brand as the original Offer","example":true},"returnMostRestrictiveBrandInd":{"type":"boolean","description":"if true, the most restrictive brand will be returned in the response when there are different brands present in the Offering","example":true},"doNotNetInd":{"type":"boolean","description":"If true, this exchange will not net any residual/refundable amounts against due amounts."}},"description":"Optional modifiers related to pricing, such as brands, taxes, and account codes.  \nMay include OrganizationInformation (account codes), FareSelection (fare types), CalculatedFareAdjustment (increase/decrease fare modifiers) or BrandPreference (brand tiers)."}},"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/BuildFromReservationWorkbench":{"id":"components/schemas/BuildFromReservationWorkbench","kind":"json-schema","title":"BuildFromReservationWorkbench","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"BuildFromReservationWorkbench"},"ReservationIdentifier":{"$ref":"#/components/schemas/ReservationIdentifier"},"OfferIdentifier":{"$ref":"#/components/schemas/OfferIdentifier"},"ProductIdentifier":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/ProductIdentifier"}},"SegmentSequenceList":{"type":"array","description":"The segmentSequence within the product the action is being requested for. Used when multiple flights exist within a product. Only one product may be selected with this option.","items":{"type":"integer","format":"int32"}},"TravelerRefs":{"type":"array","description":"A list of Traveler references.","items":{"type":"string","example":"traveler_1"}}}}},"components/schemas/ReservationIdentifier":{"id":"components/schemas/ReservationIdentifier","kind":"json-schema","title":"ReservationIdentifier","data":{"properties":{"@type":{"type":"string","example":"Reservation","deprecated":true},"id":{"type":"string","description":"Internal ID"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"IdentifierType":{"$ref":"#/components/schemas/IdentifierTypeENUM"}},"description":"Reservation Identifier object."}},"components/schemas/IdentifierTypeENUM":{"id":"components/schemas/IdentifierTypeENUM","kind":"json-schema","title":"IdentifierTypeENUM","data":{"type":"string","example":"Locator","enum":["Reservation","Locator","SupplierLocator","DocumentNumber"]}},"components/schemas/CatalogOfferingsAirChangeResponseWrapper":{"id":"components/schemas/CatalogOfferingsAirChangeResponseWrapper","kind":"json-schema","title":"CatalogOfferingsAirChangeResponseWrapper","data":{"properties":{"CatalogOfferingsAirChangeResponse":{"$ref":"#/components/schemas/CatalogOfferingsAirChangeResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/CatalogOfferingsAirChangeResponse":{"id":"components/schemas/CatalogOfferingsAirChangeResponse","kind":"json-schema","title":"CatalogOfferingsAirChangeResponse","data":{"properties":{"CatalogOfferings":{"$ref":"#/components/schemas/CatalogOfferings"}},"description":"The response of a Catalog offerings air change endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/CatalogOfferingsQueryProductSpecificSearch":{"id":"components/schemas/CatalogOfferingsQueryProductSpecificSearch","kind":"json-schema","title":"CatalogOfferingsQueryProductSpecificSearch","data":{"required":["@type","BuildFromProductsRequestAirChange","PassengerCriteria","PaymentCriteria"],"properties":{"@type":{"type":"string","example":"CatalogOfferingsQueryProductSpecificSearch"},"detailView":{"type":"boolean","description":"If true, detail view will be returned in response","example":true},"lowFareFinderInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC."},"children":[]}]}]}],"example":true},"returnBrandedfaresInd":{"type":"boolean","description":"If true, branded fares will be returned in the response","example":true},"BuildFromProductsRequestAirChange":{"$ref":"#/components/schemas/BuildFromProductsRequestAirChange"},"PassengerCriteria":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PassengerCriteria"}},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"CabinPreference":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/CabinPreference"}},"lowFareFindAndRebookInd":{"type":"boolean","description":"If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights."}},"description":"Discriminator classes CatalogOfferingsQueryProductSpecificSearch only"}},"components/schemas/BuildFromProductsRequestAirChange":{"id":"components/schemas/BuildFromProductsRequestAirChange","kind":"json-schema","title":"BuildFromProductsRequestAirChange","data":{"description":"full payload used to build an Offer","allOf":[{"$ref":"#/components/schemas/BuildFromProductsRequest"},{"required":["ProductCriteriaAir"],"properties":{"PricingModifiersAirChange":{"$ref":"#/components/schemas/PricingModifiersAirChange"},"ProductCriteriaAir":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductCriteriaAir"}}}}]}},"components/schemas/ProductCriteriaAir":{"id":"components/schemas/ProductCriteriaAir","kind":"json-schema","title":"ProductCriteriaAir","data":{"required":["SpecificFlightCriteria","sequence"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"ProductCriteriaAir"},"sequence":{"type":"integer","description":"Optional sequence of this block of product criteria","format":"int32","example":1},"SponsoredFlightAttributes":{"$ref":"#/components/schemas/SponsoredFlightAttributes"},"SpecificFlightCriteria":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SpecificFlightCriteria"}},"SupplierLocator":{"description":"Send to add a locator code for a passive segment.  \nRequired for passive segment bookings when GDS ticketing is required (AK segment status - passive segment confirmed outside the GDS). Not supported for Search or Price APIs.  \n  \nRequired for ticket issuance; if not sent in Add Offer, must be added with a terminal program prior to ticketing.  \nRecommended to always send with SpecificFlightCriteria /passiveSegmentStatus.","allOf":[{"$ref":"#/components/schemas/SupplierLocator"}]}},"description":"Full payload itinerary details. Each instance is one leg of the itinerary.  \nFor AirReservation: includes SupplierLocator when adding a passive segment."}},"components/schemas/SpecificFlightCriteria":{"id":"components/schemas/SpecificFlightCriteria","kind":"json-schema","title":"SpecificFlightCriteria","data":{"required":["carrier","departureDate","flightNumber","from","segmentSequence","to"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"SpecificFlightCriteria"},"carrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"IATA code for the airline carrier for this flight.","example":"BA"},"flightNumber":{"pattern":"[0-9]{1,4}[A-Z]?|OPEN|ARNK","type":"string","description":"Flight number assigned by the airline.","example":"980"},"departureDate":{"type":"string","description":"The local departure date of the flight in YYYY-MM-DD format.","format":"date","example":"2025-10-25"},"departureTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$","type":"string","description":"The local departure time of the flight in HH:MM:SS (24-hour) format.","example":"68400"},"arrivalDate":{"type":"string","description":"The local arrival date of the flight in YYYY-MM-DD format.","format":"date","example":"2025-10-25"},"arrivalTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$","type":"string","description":"The local arrival time of the flight in HH:MM:SS (24-hour) format.","example":"80100"},"from":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The origin IATA airport code from which the flight departs.","example":"LHR"},"to":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The destination IATA airport code where the flight arrives.","example":"PAR"},"cabin":{"$ref":"#/components/schemas/CabinAirEnum"},"classOfService":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","description":"The class of service. If sent for Flight Specific Search, this field is ignored.","example":"F"},"brandTier":{"type":"integer","description":"The brand tier to price, if brand tier pricing is desired.  \n \nSupported only in the full payload request.  \nFor AirReservation, send only if requesting to store brand information at the segment level. A segment is one flight with the same flight number. You can send brandTier for any or all instances of SpecificFlightCriteria. To store brand information at the offer level instead, see PricingModifiersAir.","format":"int32","example":2},"segmentSequence":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Segment sequence is used to identify the order of the flight segments. A segment is one flight with the same flight number."},"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":"For AirPrice: starting with 0 for the first segment on the leg."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For AirReservation: starting with 1 for the first segment on the leg."},"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":"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."},"children":[]}]}]}]}]}]}],"format":"int32"},"additionalCabins":{"type":"array","description":"Request additional SeatMap cabins (not supported in full payload Price or Book requests)","example":["First"],"items":{"$ref":"#/components/schemas/CabinAirEnum"}},"passiveSegmentStatus":{"maxLength":2,"type":"string","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":"Applicable to Book workflow only. If the segment is to be sold as passive (booked outside the Travelport GDS) enter the passive segment status."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This updates the Travelport booking with any details received from the supplier for the passive segment. Recommended to also send SupplierLocator."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported for the following segment status codes:"},"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":"AK (passive segment confirmed outside the GDS)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BK (passive segment booked with carrier)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"YK (Hold confirmed airline space)"},"children":[]}]}]}]}],"example":"AK"},"fareBasisCodeOverride":{"type":"string","description":"Use PricingModifiersAir for fare basis code override.","example":"YEE1Y","deprecated":true},"id":{"type":"string","description":"Unique id to support referencing of this specific passenger criteria in the book offer construction workflow.  \nFor AirPrice: optionally use to send a custom flight identifier value such as f1, f2, and so on when requesting pricing for one or more specific segments with OfferConstruction. If not sent, pricing for all segments is returned. GDS only; not supported for this use in NDC."},"AvailabilitySourceCode":{"$ref":"#/components/schemas/AvailabilitySourceCodeENUM"},"ContentSource":{"$ref":"#/components/schemas/ContentSourceEnum"},"boundFlightsInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bound flights indicator boundFlightsInd is a variable indicating segments are married/bound. True indicates that the flight availability was polled (availability check) using connecting segments. If false, flights were polled as point to point segments."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In full payload AirPrice, this sets whether to validate inventory on a connecting flight in the requested class of service by booking and then releasing seats. GDS only; not supported for NDC. Supported only in the full 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":"Can be used in conjunction with reCheckInventoryInd=true on the leading segment(s) on a leg with connecting flight(s) to also check availability on the connecting flight(s) by booking and releasing seats in the requested class of service."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if a leg has two connections, send boundFlightsInd for the first two of the three flights. Must also send reCheckInventoryInd=true per above. If any or all segments are not bookable, AirPrice returns a message that the air segment/s are not bookable and the dates and city pairs of the segments that are not bookable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because this indicator temporarily affects seat availability, recommended best practice is to use validateInventoryInd instead of reCheckInventoryInd and boundFlightsInd. Some airlines have revenue management applications that monitor for high volumes of sell/ignore transactions for inventory. Regardless of pricing results, air fares and inventory are guaranteed by airlines only when ticketed and paid for."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): Checks only for general seat availability on any connecting flight, not a specific class of service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In full payload AirReservation, this indicator is not sent by the user but instead is sent if included in the information stored in the price by the carrier. Not returned for NDC."},"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":"When returned with a value of true, the flight segments are polled together and usually share the same fare basis code and class of service. The indicator is returned as true 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."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if an O&D pair has 3 flight segments, boundFlightsInd is returned only for the first two segments on that leg."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the segments are not bound, boundFlightsInd is false and not returned."},"children":[]}]}]}]}],"example":true}},"description":"Full payload request object used to specify a flight for Search, Price, Book, or Standalone Seat Map processing. Each instance sends details for one flight (aka segment) on the itinerary."}},"components/schemas/AvailabilitySourceCodeENUM":{"id":"components/schemas/AvailabilitySourceCodeENUM","kind":"json-schema","title":"AvailabilitySourceCodeENUM","data":{"type":"string","description":"GDS only; not supported for NDC.  \nOptional but Recommended to send in the full payload request.  \nReturned to assist in troubleshooting.  \nReturned in the Search, Air Availability, Exchange Search, AirPrice, and Workbench Commit responses.   Not returned for Ancillary Shop or Fare Rules.  \nRecommended to send in the AirPrice Full Payload and Add Offer Full Payload requests.","example":"Z","enum":["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","S","T","U","X","Y","Z"],"x-enumDescriptions":{"A":"AVS (availability and schedules)","B":"Travelport cache","C":"AVS","D":"Direct Access","E":"Travelport cache","F":"Travelport cache","G":"Travelport cache","H":"Travelport cache","I":"Travelport cache","K":"Travelport cache","L":"Last seat availability","M":"Unknown source","O":"Travelport cache","P":"Travelport cache","Q":"Travelport cache","S":"Seamless","T":"Travelport cache","U":"Unknown source","X":"Customer reusing availability data from customer cache (data originally obtained from Travelport)","Y":"Customer reusing data obtained from another system (e.g., another GDS) (data may be fresh or stored in customer cache)","Z":"Customer sold from e-streamed data stored in customer cache"}}},"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/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/ScheduleChangeRepriceEnum":{"id":"components/schemas/ScheduleChangeRepriceEnum","kind":"json-schema","title":"ScheduleChangeRepriceEnum","data":{"type":"string","example":"AcceptOfferPriceDifference","enum":["RetainOfferPrice","AcceptOfferPriceDifference"]}},"components/schemas/ReservationQueryDivide":{"id":"components/schemas/ReservationQueryDivide","kind":"json-schema","title":"ReservationQueryDivide","data":{"required":["ReservationIdentifier","TravelerIdentifier"],"properties":{"ReservationIdentifier":{"$ref":"#/components/schemas/ReservationIdentifier"},"TravelerIdentifier":{"maxItems":9,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifier"}},"InfantTravelerAssociation":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/InfantTravelerAssociation"}}}}},"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/InfantTravelerAssociation":{"id":"components/schemas/InfantTravelerAssociation","kind":"json-schema","title":"InfantTravelerAssociation","data":{"required":["@type","InfantTravelerID","TravelerID"],"properties":{"@type":{"type":"string","description":"Discriminator class InfantTravelerAssociation only","example":"InfantTravelerAssociation"},"TravelerID":{"$ref":"#/components/schemas/Identifier"},"InfantTravelerID":{"$ref":"#/components/schemas/Identifier"}}}},"components/schemas/ReservationListResponseWrapper":{"id":"components/schemas/ReservationListResponseWrapper","kind":"json-schema","title":"ReservationListResponseWrapper","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/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/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/ReceiptListResponseWrapper":{"id":"components/schemas/ReceiptListResponseWrapper","kind":"json-schema","title":"ReceiptListResponseWrapper","data":{"properties":{"ReceiptListResponse":{"$ref":"#/components/schemas/ReceiptListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ReceiptListResponse":{"id":"components/schemas/ReceiptListResponse","kind":"json-schema","title":"ReceiptListResponse","data":{"properties":{"ReceiptID":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Receipt"}}},"description":"The response of an ReceiptList endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ReceiptQueryDocumentRefundFromOfferList":{"id":"components/schemas/ReceiptQueryDocumentRefundFromOfferList","kind":"json-schema","title":"ReceiptQueryDocumentRefundFromOfferList","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"ReceiptQueryDocumentRefundFromOfferList"},"BuildFromOfferList":{"maxItems":10,"type":"array","description":"An array of buildfromofferlist to support multiple standalone refunds.","items":{"$ref":"#/components/schemas/BuildFromOfferList"}}},"description":"Request payload for standalone document refund."}},"components/schemas/BuildFromOfferList":{"id":"components/schemas/BuildFromOfferList","kind":"json-schema","title":"BuildFromOfferList","data":{"required":["OfferIdentifier","OfferListIdentifier"],"properties":{"@type":{"type":"string","example":"BuildFromOfferList"},"OfferListIdentifier":{"maxLength":128,"type":"string","description":"The OfferListIdentifer (GUID) to retrieve the OfferList from cache","example":"A0656EFF-FAF4-456F-B061-0161008D7C4E"},"OfferIdentifier":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/OfferIdentifier"}},"ProductIdentifier":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ProductIdentifier"}},"SegmentSequence":{"type":"integer","description":"The segmentSequence within the product the action is being requested for. Used when multiple exist within a product","format":"int32","example":1},"WaiverCode":{"$ref":"#/components/schemas/WaiverCode"}}}},"components/schemas/OfferQueryBuildfromOfferList":{"id":"components/schemas/OfferQueryBuildfromOfferList","kind":"json-schema","title":"OfferQueryBuildfromOfferList","data":{"required":["@type","BuildFromOfferList"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryBuildFromOfferList","example":"OfferQueryBuildfromOfferList"},"BuildFromOfferList":{"$ref":"#/components/schemas/BuildFromOfferList"},"MaxNumberOfUpsellsToReturn":{"maximum":12,"minimum":1,"type":"integer","format":"int32","example":4},"NumberOfDownsellsToReturn":{"type":"integer","description":"Will not implement.","format":"int32","example":4,"deprecated":true},"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"CabinPreference":{"$ref":"#/components/schemas/CabinPreference"},"lowFareFindAndRebookInd":{"type":"boolean","description":"If true, a new Offer will replace the referenced Offer with the lowest fare available. Flights will be rebooked.","example":true},"inhibitBrandContentInd":{"type":"boolean","description":"If true, disables the return of branded fare attributes. By default the AirPrice Reference Payload request returns branded fare attributes.","example":true}}}},"components/schemas/OfferQueryBuildFromCatalogOfferings":{"id":"components/schemas/OfferQueryBuildFromCatalogOfferings","kind":"json-schema","title":"OfferQueryBuildFromCatalogOfferings","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"OfferQueryBuildFromCatalogOfferings"},"BuildFromCatalogOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"},"CabinPreference":{"$ref":"#/components/schemas/CabinPreference"},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"FareRuleType":{"$ref":"#/components/schemas/FareRuleEnum"},"FareRuleCategory":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/FareRuleCategoryEnum"}},"lowFareFinderInd":{"type":"boolean","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":"Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service."},"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":"If true: returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): provides fares for only the specified class of service."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service."},"children":[]}]}]}]}],"example":true},"returnBrandedFaresInd":{"type":"boolean","description":"If true, branded fares are returned.","example":true},"reCheckInventoryInd":{"type":"boolean","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 (NDC carriers always validate inventory at pricing)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether to validate inventory for the requested number of passengers in a specific class of service at the time of the price request by booking and releasing seats."},"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":"If true: verifies availability for the requested number of passengers in a specific class of service at the time of the price request by booking and releasing seats. If any or all segments are not bookable, AirPrice does not return any offers and returns an error message."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): checks for general seat availability on the flight, not a specific class of service, and does not book/release seats."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because this indicator temporarily affects seat availability, the recommended best practice is to use validateInventoryInd instead. Some airlines monitor for high volumes of sell/ignore transactions. Regardless of pricing results, air fares and inventory are only guaranteed by airlines when ticketed and paid."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can help reduce sell failures at booking by alerting of insufficient availability."},"children":[]}]}]}]}],"example":true},"validateInventoryInd":{"type":"boolean","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, as NDC carriers already validate inventory at pricing."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether to validate inventory in the requested class of service. This reduces failures at the Add Offer and Workbench Commit steps."},"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":"If true: checks for availability for the requested number of passengers in the requested class of service at the time of the price request. If there are fewer seats than requested passengers available in that class of service, AirPrice does not return any offers and instead returns an error message that the booking class or preference is not available."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): checks for general seat availability on the flight, not a specific class of service. May return upsell offers with no availability in the requested class of service."},"children":[]}]}]}]}],"example":true},"lowFareFindAndRebookInd":{"type":"boolean","description":"If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights."}},"description":"Discriminator class OfferQueryBuildFromCatalogOfferings only"}},"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"}}},"discriminator":{"propertyName":"@type"}}},"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/OfferQueryBuildFromOffer":{"id":"components/schemas/OfferQueryBuildFromOffer","kind":"json-schema","title":"OfferQueryBuildFromOffer","data":{"required":["@type","BuildFromOffer"],"properties":{"@type":{"type":"string","example":"OfferQueryBuildFromOffer"},"BuildFromOffer":{"$ref":"#/components/schemas/BuildFromOffer"},"CabinPreference":{"$ref":"#/components/schemas/CabinPreference"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"priceHistoricalOfferInd":{"type":"boolean","description":"If true, the new Offer should be priced using the original Offer create date.","example":true},"priceHistoricalTaxInd":{"type":"boolean","description":"if true, the taxes in the new Offer should be priced using the original Offer create date.","example":true},"priceHistoricalFeeInd":{"type":"boolean","description":"if true, the fees in the new Offer should be priced using the original Offer create date.","example":true},"inhibitBrandContentInd":{"type":"boolean","description":"If true, brand information will not be returned","example":true},"lowFareFinderInd":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC."},"children":[]}]}]}],"example":true},"lowFareFindAndRebookInd":{"type":"boolean","description":"If true, a new Offer will replace the referenced Offer with the lowest available fare. Flight products are rebooked.","example":true},"validateInventoryInd":{"type":"boolean","description":"Sets whether to validate inventory in the requested class of service. If true, checks for availability for the requested number of passengers in the requested class of service at the time of the price request. If there are fewer seats than requested passengers available in that class of service, AirPrice does not return any offers and instead returns an error message that the booking class or preference is not available. This reduces failures at the Add Offer and Workbench Commit steps. GDS only; not supported for NDC, as NDC carriers already validate inventory at pricing.","example":true},"MaxNumberOfUpsellsToReturn":{"maximum":12,"minimum":1,"type":"integer","format":"int32","example":4}},"description":"Discriminator class OfferQueryBuildFromOffer only"}},"components/schemas/OfferResponseWrapper":{"id":"components/schemas/OfferResponseWrapper","kind":"json-schema","title":"OfferResponseWrapper","data":{"properties":{"OfferResponse":{"$ref":"#/components/schemas/OfferResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/OfferResponse":{"id":"components/schemas/OfferResponse","kind":"json-schema","title":"OfferResponse","data":{"properties":{"Offer":{"$ref":"#/components/schemas/OfferID"}},"description":"The response of an Offer endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/OfferTypeENUM":{"id":"components/schemas/OfferTypeENUM","kind":"json-schema","title":"OfferTypeENUM","data":{"type":"string","example":"AgencyCalculatedRefund","enum":["AgencyCalculatedExchange","AgencyCalculatedRefund"]}},"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","description":"For Hotel Rules and Reservation responses, this array will contain a single TermsAndConditionsFullHospitality entry. Cancellation terms with multiple time periods are represented within that entry's CancelPenalty array rather than as multiple TermsAndConditionsFull entries.","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/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/OfferQueryDocumentRefundQuote":{"id":"components/schemas/OfferQueryDocumentRefundQuote","kind":"json-schema","title":"OfferQueryDocumentRefundQuote","data":{"required":["@type","DocumentRefundQuote"],"properties":{"@type":{"type":"string","example":"OfferQueryDocumentRefundQuote"},"DocumentRefundQuote":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/DocumentRefundQuote"}}}}},"components/schemas/DocumentRefundQuote":{"id":"components/schemas/DocumentRefundQuote","kind":"json-schema","title":"DocumentRefundQuote","data":{"required":["@type","DocumentNumber"],"properties":{"@type":{"type":"string","description":"Discriminator. Use DocumentRefundQuote for Travelport calculated auto refund and DocumentRefundQuoteManual for agency calculated manual refund.","example":"DocumentRefundQuote"},"DocumentNumber":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/DocumentNumber"}}}}},"components/schemas/OfferQueryBuildFromUnpricedSegments":{"id":"components/schemas/OfferQueryBuildFromUnpricedSegments","kind":"json-schema","title":"OfferQueryBuildFromUnpricedSegments","data":{"required":["@type","BuildFromUnpricedSegments"],"properties":{"@type":{"type":"string","description":"Discriminator class OfferQueryBuildFromUnpricedSegments only.","example":"OfferQueryBuildFromUnpricedSegments"},"BuildFromUnpricedSegments":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/BuildFromUnpricedSegments"}}},"description":"Build either an auto priced offer or manually priced offer. Send one instance of BuildFromUnpricedSegments per offer to be created."}},"components/schemas/BuildFromUnpricedSegments":{"id":"components/schemas/BuildFromUnpricedSegments","kind":"json-schema","title":"BuildFromUnpricedSegments","data":{"required":["@type","UnpricedFlightSegmentCriteria"],"properties":{"@type":{"type":"string","description":"Discriminator classes BuildFromUnpricedSegmentsAutoPrice or BuildFromUnpricedSegmentsManualPrice.","example":"BuildFromUnpricedSegments"},"UnpricedFlightSegmentCriteria":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/UnpricedFlightSegmentCriteria"}}},"description":"Parent call of auto and manual pricing. Select the child facet BuildFromUnpricedSegmentsAutoPrice or BuildFromUnpricedSegmentsManualPrice. Each instance of BuildFromUnpricedSegments will create a separate Offer.","discriminator":{"propertyName":"@type"}}},"components/schemas/UnpricedFlightSegmentCriteria":{"id":"components/schemas/UnpricedFlightSegmentCriteria","kind":"json-schema","title":"UnpricedFlightSegmentCriteria","data":{"required":["@type","UnpricedFlightSegmentRefs"],"properties":{"@type":{"type":"string","description":"Discriminator class UnpricedFlightSegmentCriteria only.","example":"UnpricedFlightSegmentCriteria"},"UnpricedFlightSegmentRefs":{"type":"array","description":"Select the unpriced flight segments to build the offer.","example":"s1","items":{"type":"string","example":"s1"}},"Sequence":{"type":"integer","description":"Use sequence when assigning preference to a specific leg of the journey or when using manual price. When assigning a sequence only one UnpricedSegmentRef can be entered. Send an array of UnpricedFlightSegmentCriteria when using multiple sequence.","format":"int32","example":1},"TravelerRefs":{"type":"array","description":"The traveler you wish to create an Offer for. If blank, all travelers will be included in the Offer.","example":"traveler_1","items":{"type":"string"}}},"description":"Selection object for unpriced segments including a sequence to reference in cabin preference and manual price."}},"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/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/UnpricedSegmentsResponseWrapper":{"id":"components/schemas/UnpricedSegmentsResponseWrapper","kind":"json-schema","title":"UnpricedSegmentsResponseWrapper","data":{"properties":{"UnpricedSegmentsResponse":{"$ref":"#/components/schemas/UnpricedSegmentsResponse"}},"description":"Wrapper schema to expose the root element in the JSON example"}},"components/schemas/UnpricedSegmentsResponse":{"id":"components/schemas/UnpricedSegmentsResponse","kind":"json-schema","title":"UnpricedSegmentsResponse","data":{"description":"The response of an UnpricedSegment add request.","allOf":[{"properties":{"UnpricedSegments":{"$ref":"#/components/schemas/UnpricedSegments"}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/CustomAuxiliarySegmentRequest":{"id":"components/schemas/CustomAuxiliarySegmentRequest","kind":"json-schema","title":"CustomAuxiliarySegmentRequest","data":{"required":["CustomAuxiliarySegment"],"properties":{"CustomAuxiliarySegment":{"type":"array","description":"Add TUR/SUR auxiliary segments.","items":{"$ref":"#/components/schemas/CustomAuxiliarySegment"}}},"description":"Request to add custom auxiliary segments to the reservation."}},"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/CustomAuxiliarySegmentResponseWrapper":{"id":"components/schemas/CustomAuxiliarySegmentResponseWrapper","kind":"json-schema","title":"CustomAuxiliarySegmentResponseWrapper","data":{"properties":{"CustomAuxiliarySegmentResponse":{"$ref":"#/components/schemas/CustomAuxiliarySegmentResponse"}},"description":"Wrapper schema to expose the root element in the JSON example."}},"components/schemas/CustomAuxiliarySegmentResponse":{"id":"components/schemas/CustomAuxiliarySegmentResponse","kind":"json-schema","title":"CustomAuxiliarySegmentResponse","data":{"description":"The response of a Custom Auxiliary Segment add or update request.","allOf":[{"properties":{"CustomAuxiliarySegments":{"type":"array","items":{"$ref":"#/components/schemas/CustomAuxiliarySegmentID"}}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ExchangeOfferListResponseWrapper":{"id":"components/schemas/ExchangeOfferListResponseWrapper","kind":"json-schema","title":"ExchangeOfferListResponseWrapper","data":{"type":"object","properties":{"OfferListResponse":{"$ref":"#/components/schemas/ExchangeOfferListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/ExchangeOfferListResponse":{"id":"components/schemas/ExchangeOfferListResponse","kind":"json-schema","title":"ExchangeOfferListResponse","data":{"properties":{"Offer":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/OfferID"}}},"description":"The response of an Offer list endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"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/AccountingResponseWrapper":{"id":"components/schemas/AccountingResponseWrapper","kind":"json-schema","title":"AccountingResponseWrapper","data":{"properties":{"AccountingResponse":{"$ref":"#/components/schemas/AccountingResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/AccountingResponse":{"id":"components/schemas/AccountingResponse","kind":"json-schema","title":"AccountingResponse","data":{"properties":{"Accounting":{"$ref":"#/components/schemas/AccountingID"}},"description":"The response of an Accounting 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/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/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/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/PaymentResponseWrapper":{"id":"components/schemas/PaymentResponseWrapper","kind":"json-schema","title":"PaymentResponseWrapper","data":{"properties":{"PaymentResponse":{"$ref":"#/components/schemas/PaymentResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/PaymentResponse":{"id":"components/schemas/PaymentResponse","kind":"json-schema","title":"PaymentResponse","data":{"properties":{"Payment":{"$ref":"#/components/schemas/PaymentIdentifier"}},"description":"The response of a Payment endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"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/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/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/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/SpecialServiceListRequest":{"id":"components/schemas/SpecialServiceListRequest","kind":"json-schema","title":"SpecialServiceListRequest","data":{"required":["SpecialService"],"properties":{"SpecialService":{"minItems":1,"type":"array","example":["specialservice_1"],"items":{"$ref":"#/components/schemas/SpecialService"}}},"description":"supports sending a list of SpecialService objects"}},"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/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/SpecialServiceListResponseWrapper":{"id":"components/schemas/SpecialServiceListResponseWrapper","kind":"json-schema","title":"SpecialServiceListResponseWrapper","data":{"properties":{"SpecialServiceListResponse":{"$ref":"#/components/schemas/SpecialServiceListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/SpecialServiceListResponse":{"id":"components/schemas/SpecialServiceListResponse","kind":"json-schema","title":"SpecialServiceListResponse","data":{"properties":{"@type":{"type":"string","example":"SpecialServiceListResponse"},"SpecialServiceID":{"type":"array","items":{"$ref":"#/components/schemas/SpecialServiceID"}}},"description":"The response of a Special service list endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/SpecialServiceQueryDeleteMultiple":{"id":"components/schemas/SpecialServiceQueryDeleteMultiple","kind":"json-schema","title":"SpecialServiceQueryDeleteMultiple","data":{"required":["@type","SpecialServiceID"],"properties":{"@type":{"type":"string","example":"SpecialServiceQueryDeleteMultiple"},"SpecialServiceID":{"maxItems":500,"type":"array","items":{"maxLength":128,"type":"string","example":"specialservice_1"}}},"description":"Delete multiple special services."}},"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/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/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/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/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/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/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/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/TravelerQueryUpdate":{"id":"components/schemas/TravelerQueryUpdate","kind":"json-schema","title":"TravelerQueryUpdate","data":{"required":["@type","TravelerUpdatedItem"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelerQueryUpdate only","example":"TravelerQueryUpdate"},"TravelerUpdatedItem":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TravelerUpdatedItem"}}}}},"components/schemas/TravelerUpdatedItem":{"id":"components/schemas/TravelerUpdatedItem","kind":"json-schema","title":"TravelerUpdatedItem","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelerUpdatedItemAddress, TravelerUpdatedItemBirthDate, TravelerUpdatedItemComments, TravelerUpdatedItemCustomerLoyalty, TravelerUpdatedItemEmail, TravelerUpdatedItemGender, TravelerUpdatedItemPersonName, TravelerUpdatedItemTelephone, TravelerUpdatedItemTravelDocument","example":"TravelerUpdatedItem"},"TravelerUpdatableItemID":{"maxLength":128,"type":"string","description":"A unique GUID to identify the TravelerUpdatedItem","example":"234"},"addInd":{"type":"boolean","description":"If true the TravelerUpdatedItem is being added to the Traveler","example":true},"modifyInd":{"type":"boolean","description":"If true the TravelerUpdatedItem is being modified in the Traveler","example":true},"deleteInd":{"type":"boolean","description":"If true the TravelerUpdatedItem is being deleted from the Traveler","example":true}},"discriminator":{"propertyName":"@type"}}},"components/schemas/TravelerResponseWrapper":{"id":"components/schemas/TravelerResponseWrapper","kind":"json-schema","title":"TravelerResponseWrapper","data":{"properties":{"TravelerResponse":{"$ref":"#/components/schemas/TravelerResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelerResponse":{"id":"components/schemas/TravelerResponse","kind":"json-schema","title":"TravelerResponse","data":{"properties":{"Traveler":{"$ref":"#/components/schemas/TravelerIdentifier"}},"description":"The response of a Traveler endpoint request; returns the system-generated traveler identifier. This identifier must be sent in any subsequent traveler-specific requests, such as ticketing and seat assignment.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"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/PrimaryContactResponseWrapper":{"id":"components/schemas/PrimaryContactResponseWrapper","kind":"json-schema","title":"PrimaryContactResponseWrapper","data":{"properties":{"PrimaryContactResponse":{"$ref":"#/components/schemas/PrimaryContactResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/PrimaryContactResponse":{"id":"components/schemas/PrimaryContactResponse","kind":"json-schema","title":"PrimaryContactResponse","data":{"properties":{"PrimaryContact":{"$ref":"#/components/schemas/PrimaryContactID"}},"description":"The response of a Primary contact endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/TicketQueryGetByLocator":{"id":"components/schemas/TicketQueryGetByLocator","kind":"json-schema","title":"TicketQueryGetByLocator","data":{"required":["@type","Locator"],"properties":{"@type":{"type":"string","example":"TicketQueryGetByLocator"},"detailViewInd":{"type":"boolean","description":"If true, TicketDetail will be returned","example":true},"Locator":{"$ref":"#/components/schemas/Locator"},"TicketNumber":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/TicketNumber"}}}}},"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/TicketListResponseWrapper":{"id":"components/schemas/TicketListResponseWrapper","kind":"json-schema","title":"TicketListResponseWrapper","data":{"properties":{"TicketListResponse":{"$ref":"#/components/schemas/TicketListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TicketListResponse":{"id":"components/schemas/TicketListResponse","kind":"json-schema","title":"TicketListResponse","data":{"description":"The response of a Ticket list endpoint request.","allOf":[{"properties":{"TicketID":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Ticket"}},"SettlementAuthorizationCode":{"maxLength":32,"type":"string"}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/Ticket":{"id":"components/schemas/Ticket","kind":"json-schema","title":"Ticket","data":{"description":"This object holds ticket details.","allOf":[{"$ref":"#/components/schemas/TicketID"},{"required":["FormOfPayment","PersonName","TicketPrice","TicketSegment","numberOfTicketsIssued"],"properties":{"numberOfTicketsIssued":{"type":"integer","description":"The total number of tickets issued for the collection of flight segments example: 5","format":"int32"},"settlementAuthorizationCode":{"maxLength":32,"type":"string","description":"Electronic Settlement Authorization Code - A unique number generated by a Carrier to authorize or approve a transaction","example":"REA"},"tourCode":{"maxLength":32,"type":"string","description":"A Tour Code on a flight ticket is a special code arranged between the Travel Agency and the Airlines","example":"LHR"},"accountCode":{"maxLength":32,"type":"string","description":"The Account Code used to classify financial activities","example":"Pcard, travel"},"ticketDesignator":{"maxLength":32,"type":"string","description":"A code on airline tickets to indicate what type of discount is applied","example":"infant"},"PersonName":{"$ref":"#/components/schemas/PersonName"},"ReservationLocator":{"$ref":"#/components/schemas/SupplierLocator"},"FormOfPayment":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/FormOfPayment"}},"TicketSegment":{"maxItems":30,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TicketSegment"}},"TicketPrice":{"$ref":"#/components/schemas/TicketPrice"},"PassengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"Code used to identify Passengers according to various","example":"PTC"},"ValidatingCarrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The plating carrier of the ticket","example":"ticket prefix is 001, while United Airlines' prefix is 016."},"PricingType":{"$ref":"#/components/schemas/PricingTypeEnum"},"Restrictions":{"maxItems":10,"type":"array","description":"restrictions associated with a particular fare","example":["VALID BA ONLY/ NON REF","NON REF"],"items":{"maxLength":128,"type":"string"}},"AgencyInfo":{"$ref":"#/components/schemas/AgencyInfo"},"OriginalIssue":{"$ref":"#/components/schemas/OriginalIssue"},"PreviousIssue":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PreviousIssue"}}}}]}},"components/schemas/TicketID":{"id":"components/schemas/TicketID","kind":"json-schema","title":"TicketID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TicketID, Ticket, TicketSummary, or TicketDetail","example":"Ticket"},"objID":{"type":"string"},"TicketRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/TicketSegment":{"id":"components/schemas/TicketSegment","kind":"json-schema","title":"TicketSegment","data":{"required":["Arrival","Carrier","Departure","FlightStatusCode","Number","TicketBaggage"],"properties":{"@type":{"type":"string","example":"TicketSegment"},"sequence":{"type":"integer","description":"The sequence of the coupon within the ticket","format":"int32","example":1},"ClassOfService":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","description":"The booking class of service. segment","example":"Y"},"FareBasisCode":{"maxLength":32,"type":"string","description":"The Fare Basis code for this ticket segment.","example":"YEE1Y"},"Status":{"$ref":"#/components/schemas/TicketStatusEnum"},"Carrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The marketing carrier of the flight on this ticket segment.","example":"DL"},"Number":{"pattern":"[0-9]{1,4}[A-Z]?|OPEN|ARNK","type":"string","description":"The flight number.","example":"2490"},"Departure":{"$ref":"#/components/schemas/Departure"},"Arrival":{"$ref":"#/components/schemas/Arrival"},"FlightStatusCode":{"maxLength":32,"type":"string","description":"A status code indicates the status of an air segment","example":"HK"},"ValidDateRange":{"$ref":"#/components/schemas/DateRange"},"TicketBaggage":{"$ref":"#/components/schemas/TicketBaggage"},"connectionInd":{"type":"boolean","description":"If true, the ticketSegment is a connecting segment","example":true}}}},"components/schemas/TicketStatusEnum":{"id":"components/schemas/TicketStatusEnum","kind":"json-schema","title":"TicketStatusEnum","data":{"type":"string","example":"Void","enum":["CheckedIn","Closed","Exchanged","InfoOnly","Lifted/Boarded","OpenForUse","OtherAirlineControl","Void","Refund","Suspended","Unavailable","Used"]}},"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/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/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/TicketBaggage":{"id":"components/schemas/TicketBaggage","kind":"json-schema","title":"TicketBaggage","data":{"properties":{"@type":{"type":"string","example":"TicketBaggage"},"quantity":{"type":"integer","description":"How many baggage allowed","format":"int32","example":2},"Measurement":{"maxItems":6,"type":"array","description":"The total dimensions  of baggage","items":{"$ref":"#/components/schemas/Measurement"}},"soldByPieceInd":{"type":"boolean","description":"If true, the baggage item is sold as a piece allowance. Weight restrictions may also apply."},"soldByWeightInd":{"type":"boolean","description":"If true, the baggage item is sold as a weight allowance. Number of item restrictions may also apply."}}}},"components/schemas/TicketPrice":{"id":"components/schemas/TicketPrice","kind":"json-schema","title":"TicketPrice","data":{"required":["Base","CurrencyCode","Total"],"properties":{"@type":{"type":"string","example":"TicketPrice"},"fareCalculation":{"maxLength":512,"type":"string","description":"Calculation of applicable fare","example":"LON BA SIN R235.00YEE1Y BA LON R235.00YEE1Y END ROE0.645487"},"fareBreakdown":{"maxLength":512,"type":"string","description":"An itinerary used as the start and finish of a particular fare"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","format":"float"},"Taxes":{"$ref":"#/components/schemas/Taxes"},"Fees":{"$ref":"#/components/schemas/Fees"},"Total":{"type":"number","format":"float"},"Commission":{"$ref":"#/components/schemas/Commission"},"FiledAmount":{"$ref":"#/components/schemas/FiledAmount"},"PaidTaxes":{"$ref":"#/components/schemas/PaidTaxes"},"iTFareInd":{"type":"boolean","description":"if true, this is an IT fare and the base amount is not exposed","example":true},"bTFareInd":{"type":"boolean","description":"if true, this is a BT fare and the base amount is not exposed","example":false},"AdditionalCollection":{"$ref":"#/components/schemas/FiledAmount"},"NetAmount":{"$ref":"#/components/schemas/AlternateAmount"}}}},"components/schemas/PaidTaxes":{"id":"components/schemas/PaidTaxes","kind":"json-schema","title":"PaidTaxes","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes PaidTaxes or PaidTaxesDetail","example":"PaidTaxesDetail"},"TotalTaxes":{"type":"number","description":"A monetary amount, up to 4 decimal places. Decimal place needs to be included.","format":"float","example":220.12}},"description":"Summary Taxes object","discriminator":{"propertyName":"@type"}}},"components/schemas/AlternateAmount":{"id":"components/schemas/AlternateAmount","kind":"json-schema","title":"AlternateAmount","data":{"required":["amount","currencyCode","decimalPlace"],"properties":{"amount":{"type":"number","description":"The base amount","format":"float","example":43.3422},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Amount currency code","example":"USD"},"decimalPlace":{"type":"integer","description":"ISO 4217 decimal standard","format":"int32","example":3},"fareCalculation":{"maxLength":128,"type":"string","description":"the fare calculation string","example":"LON BA SIN R 234.00 BA LON R 234.00NUC468.00END"},"rateOfExchange":{"type":"number","description":"The rate of exchange used to convert the fare calculation","format":"float","example":1.234562}}}},"components/schemas/PricingTypeEnum":{"id":"components/schemas/PricingTypeEnum","kind":"json-schema","title":"PricingTypeEnum","data":{"type":"string","description":"How the price was created","example":"Auto Priced","enum":["Auto Priced","Manually Price"]}},"components/schemas/OriginalIssue":{"id":"components/schemas/OriginalIssue","kind":"json-schema","title":"OriginalIssue","data":{"required":["agencyCodeIATA","issueDate","issuingCity"],"properties":{"value":{"maxLength":32,"type":"string"},"issuingCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"Original Issuing city","example":"NYC"},"issueDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"Issue date","example":"2026-04-04"},"agencyCodeIATA":{"pattern":"([0-9]{8})","type":"string","description":"Agency code","example":"89213476"},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"}}}},"components/schemas/PreviousIssue":{"id":"components/schemas/PreviousIssue","kind":"json-schema","title":"PreviousIssue","data":{"properties":{"value":{"maxLength":32,"type":"string"},"issuingCity":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string"},"issueDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string"},"agencyCodeIATA":{"pattern":"([0-9]{8})","type":"string"},"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"}}}},"components/schemas/TicketQueryUpdateTicket":{"id":"components/schemas/TicketQueryUpdateTicket","kind":"json-schema","title":"TicketQueryUpdateTicket","data":{"required":["@type","status"],"properties":{"@type":{"type":"string","example":"TicketQueryUpdateTicket"},"agencyCode":{"pattern":"([0-9]{8})","type":"string","description":"Agency IATA code."},"dateOfIssue":{"type":"string","description":"Date the ticket was issued.","format":"date"},"status":{"maxLength":32,"type":"string","description":"The status to update the ticket.","example":"Void"},"reverseResidentFareInd":{"type":"boolean","description":"Request reversal of residency fare allocation in SARA database.","example":true}}}},"components/schemas/TicketIDResponseWrapper":{"id":"components/schemas/TicketIDResponseWrapper","kind":"json-schema","title":"TicketIDResponseWrapper","data":{"properties":{"TicketIdResponse":{"$ref":"#/components/schemas/TicketIdResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TicketIdResponse":{"id":"components/schemas/TicketIdResponse","kind":"json-schema","title":"TicketIdResponse","data":{"required":["SettlementAuthorizationCode","Ticket"],"properties":{"@type":{"type":"string","example":"TicketIDResponse"},"Ticket":{"$ref":"#/components/schemas/TicketID"},"SettlementAuthorizationCode":{"maxLength":32,"type":"string"}},"description":"The response of a Ticket id endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/DocumentVoidQueryRequest":{"id":"components/schemas/DocumentVoidQueryRequest","kind":"json-schema","title":"DocumentVoidQueryRequest","data":{"required":["documentVoid","locator"],"properties":{"locator":{"$ref":"#/components/schemas/Locator"},"documentVoid":{"type":"array","items":{"$ref":"#/components/schemas/DocumentVoid"}}},"description":"Allows user to support voiding GDS issued documents including Tickets, EMDs and MCOs. This request allows user to void documents by PNR (all documents in PNR voided) or by individual document number(s)."}},"components/schemas/DocumentVoid":{"id":"components/schemas/DocumentVoid","kind":"json-schema","title":"DocumentVoid","data":{"required":["documentType"],"type":"object","properties":{"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"},"number":{"type":"array","items":{"type":"string","example":"1259900123456"}},"reverseResidentFareInd":{"type":"boolean","description":"Request reversal of residency fare allocation in SARA database.","example":true}},"description":"Void documents by document type. If document number is not provided all documents of the specified type will be voided in the specified reservation."}},"components/schemas/DocumentVoidListResponseWrapper":{"id":"components/schemas/DocumentVoidListResponseWrapper","kind":"json-schema","title":"DocumentVoidListResponseWrapper","data":{"properties":{"DocumentVoidListResponse":{"$ref":"#/components/schemas/DocumentVoidListResponse"}},"description":"Wrapper schema to expose the root element in the JSON example."}},"components/schemas/DocumentVoidListResponse":{"id":"components/schemas/DocumentVoidListResponse","kind":"json-schema","title":"DocumentVoidListResponse","data":{"properties":{"documentStatus":{"type":"array","items":{"$ref":"#/components/schemas/DocumentStatus"}}},"description":"List of void results.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/DocumentStatus":{"id":"components/schemas/DocumentStatus","kind":"json-schema","title":"DocumentStatus","data":{"type":"object","properties":{"documentType":{"$ref":"#/components/schemas/DocumentTypeEnum"},"number":{"type":"string","example":"1259900123456"},"status":{"type":"string","description":"The status of the document.","example":"VOID"}},"description":"The status of the document following the void request."}},"components/schemas/DocumentHistoryListResponseWrapper":{"id":"components/schemas/DocumentHistoryListResponseWrapper","kind":"json-schema","title":"DocumentHistoryListResponseWrapper","data":{"properties":{"DocumentHistoryListResponse":{"$ref":"#/components/schemas/DocumentHistoryListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/DocumentHistoryListResponse":{"id":"components/schemas/DocumentHistoryListResponse","kind":"json-schema","title":"DocumentHistoryListResponse","data":{"description":"Summary of document associated to this Reservation.","allOf":[{"properties":{"documentHistoryList":{"type":"array","items":{"$ref":"#/components/schemas/DocumentHistoryList"}}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/DocumentHistoryList":{"id":"components/schemas/DocumentHistoryList","kind":"json-schema","title":"DocumentHistoryList","data":{"properties":{"name":{"type":"string","description":"The traveler name associated to the document.","example":"SMITH/JOHNMR"},"documentListSummary":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DocumentHistoryListSummary"}}},"description":"List of documents associated to this reservation."}},"components/schemas/DocumentHistoryListSummary":{"id":"components/schemas/DocumentHistoryListSummary","kind":"json-schema","title":"DocumentHistoryListSummary","data":{"required":["actionStatus","documentType","number","pseudoCityCode","transactionDateTimeUTC"],"properties":{"platingAirline":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The plating airline code of the document.","example":"BA"},"number":{"type":"string","description":"The document number. 13 digit ticket number, or 17 digit conjunctive ticket number, or 9 digit invoice number."},"documentType":{"type":"string","enum":["E","N","M","F","I","D","C"],"x-enumDescriptions":{"E":"GDS issued electronic ticket","N":"NDC issued electronic ticket","M":"MCO","F":"Service Fee","I":"Invoice","D":"GDS EMD","C":"NDC EMD"}},"actionStatus":{"type":"string","enum":["I","R","RC","V","VE","E"],"x-enumDescriptions":{"I":"Issue","R":"Refund","RC":"Refund Cancel","V":"Void","VE":"Void Exchange","E":"Exchange"}},"transactionDateTimeUTC":{"type":"string","description":"Transaction date and time stamp in UTC.","format":"date-time","example":"2025-05-11T15:30:00Z"},"pseudoCityCode":{"maxLength":4,"minLength":3,"type":"string","example":"XS4"}},"description":"List of documents associated to this Reservation."}},"components/schemas/DocumentHistoryQueryRequest":{"id":"components/schemas/DocumentHistoryQueryRequest","kind":"json-schema","title":"DocumentHistoryQueryRequest","data":{"properties":{"locator":{"maxLength":16,"pattern":"([A-Z0-9]+)?","type":"string","description":"For GDS locator max length is 6.","example":"ZXG25P"},"documentNumbers":{"type":"array","items":{"$ref":"#/components/schemas/DocumentNumberType"}}},"description":"Request payload to retrieve one to many documents, by Locator or by number. When requesting an invoice, if multiple instances of the invoice exists only the latest will be returned. Alternatively include the locator and the invoice number. Payload must include either locator or documentNumber or both."}},"components/schemas/DocumentNumberType":{"id":"components/schemas/DocumentNumberType","kind":"json-schema","title":"DocumentNumberType","data":{"required":["documentType","number"],"properties":{"number":{"type":"string","description":"The document number.","example":"0019900123456"},"numberOfConjunctiveTickets":{"type":"integer","format":"int32","example":2},"documentType":{"type":"string","example":"TKT","enum":["TKT","EMD","MCO","INV","TASF"],"x-enumDescriptions":{"TKT":"The document is a ticket","EMD":"The document is an EMD","MCO":"The document is an MCO","INV":"The document is an invoice","TASF":"The document is a Service Fee"}}},"description":"The document number with the type of document"}},"components/schemas/DocumentHistoryResponseWrapper":{"id":"components/schemas/DocumentHistoryResponseWrapper","kind":"json-schema","title":"DocumentHistoryResponseWrapper","data":{"properties":{"DocumentHistoryResponse":{"$ref":"#/components/schemas/DocumentHistoryResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/DocumentHistoryResponse":{"id":"components/schemas/DocumentHistoryResponse","kind":"json-schema","title":"DocumentHistoryResponse","data":{"description":"Full document history display of a ticket or invoice.","allOf":[{"properties":{"documentHistories":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/DocumentHistory"}}}},{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/DocumentHistory":{"id":"components/schemas/DocumentHistory","kind":"json-schema","title":"DocumentHistory","data":{"properties":{"number":{"$ref":"#/components/schemas/DocumentNumberType"},"issueDateTimeUTC":{"type":"string","description":"The issue date time of the document in GMT.","format":"date-time","example":"2025-05-11T15:30:00Z"},"issuingGTID":{"maxLength":8,"type":"string","description":"The issuing terminal ID.","example":"CCCDBA"},"issuingAgent":{"maxLength":4,"minLength":2,"type":"string","description":"The document issuing agent initials.","example":"TW"},"issuingPseudoCityCode":{"maxLength":4,"minLength":3,"type":"string","description":"The document issuing pseudo city code.","example":"XS4"},"issuingIATA":{"maxLength":8,"type":"string","description":"The document issuing IATA number.","example":"99999992"},"issuingAgencyName":{"type":"string","description":"The name of the issuing agency.","example":"ABC Travel"},"issuingAgencyLocation":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The city location of the issuing agency.","example":"AMS"},"countryCode":{"pattern":"[a-zA-Z]{2}","type":"string","description":"ISO Code of a Country.","example":"GB"},"travelportLocator":{"$ref":"#/components/schemas/Locator"},"supplierLocator":{"$ref":"#/components/schemas/Locator"},"orderID":{"type":"string","description":"The NDC Order ID.","example":"AB081H5MRTUA7"},"name":{"type":"string","description":"The name of the traveler the document is issued for","example":"SMITH/JOHNMR"},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"Passenger type code","example":"CHD"},"passengerComments":{"$ref":"#/components/schemas/Comments"},"pricingDateTimeUTC":{"type":"string","description":"The pricing date and time stamp in UTC.","format":"date","example":"2025-05-23"},"pricingPseudoCityCode":{"maxLength":4,"minLength":3,"type":"string","description":"The pseudo city code that the price was created.","example":"XS4"},"platingAirline":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The plating airline code of the document.","example":"BA"},"agentEnteredDetails":{"$ref":"#/components/schemas/AgentEnteredDetails"},"formOfPayment":{"maxItems":3,"type":"array","description":"Array of form of payments related to this document.","items":{"$ref":"#/components/schemas/FormOfPaymentDocumentHistoryType"}},"ticketSegments":{"maxItems":16,"type":"array","description":"Flight information in ticket coupons.","items":{"$ref":"#/components/schemas/TicketSegment"}},"documentDetail":{"$ref":"#/components/schemas/DocumentDetailHistory"},"mcoDetail":{"$ref":"#/components/schemas/MCOInformation"},"duePaidRemarks":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"relatedDocument":{"description":"The related ticket or invoice number.","allOf":[{"$ref":"#/components/schemas/DocumentNumberType"}]},"associatedDocument":{"description":"The associated EMD or MCO number.","allOf":[{"$ref":"#/components/schemas/DocumentNumberType"}]},"exchanges":{"$ref":"#/components/schemas/ExchangeDocumentHistory"}},"description":"The full document history display for the requested document number."}},"components/schemas/AgentEnteredDetails":{"id":"components/schemas/AgentEnteredDetails","kind":"json-schema","title":"AgentEnteredDetails","data":{"properties":{"fareQuoteModifierString":{"type":"array","description":"Array of modifiers applied at the time of pricing","items":{"type":"string","description":"pricing modifier","example":"Z5"}},"ticketModifierString":{"type":"array","description":"Array of modifiers applied at the time of ticketing","items":{"type":"string","description":"ticket modifier","example":"EBVALID BA ONLY NON REF"}}},"description":"Agency entered details that are submitted at time of pricing or ticketing"}},"components/schemas/FormOfPaymentDocumentHistoryType":{"id":"components/schemas/FormOfPaymentDocumentHistoryType","kind":"json-schema","title":"FormOfPaymentDocumentHistoryType","data":{"properties":{"formOfPaymentType":{"type":"string","example":"CREDIT"},"paymentCard":{"$ref":"#/components/schemas/PaymentCardSimple"},"amount":{"type":"number","description":"The total amount charged to this form of payment.","format":"float","example":500},"formOfPaymentText":{"type":"string","description":"Free text information associated to the form of payment.","example":"NONREF"}},"description":"The type of form of payment and the amount applied."}},"components/schemas/PaymentCardSimple":{"id":"components/schemas/PaymentCardSimple","kind":"json-schema","title":"PaymentCardSimple","data":{"properties":{"cardCode":{"type":"string","description":"The Payment Card Code.","example":"VI"},"cardNumber":{"type":"string","description":"The payment card number masked.","example":"4929XXXXXXXXX123"},"cardExpiryDate":{"type":"string","description":"The payment card expiry date. MMYY format.","example":"0525"},"cardAuthorizationCode":{"type":"string","description":"The payment card authorization.","example":"123A45"}},"description":"Payment Card details."}},"components/schemas/DocumentDetailHistory":{"id":"components/schemas/DocumentDetailHistory","kind":"json-schema","title":"DocumentDetailHistory","data":{"properties":{"documentPricingDetail":{"$ref":"#/components/schemas/DocumentPricingDetail"},"voidDetail":{"$ref":"#/components/schemas/VoidDetail"},"refundDetail":{"$ref":"#/components/schemas/RefundDetail"},"exchangePenalty":{"$ref":"#/components/schemas/CurrencyAmount"},"residualValue":{"$ref":"#/components/schemas/CurrencyAmount"}},"description":"Price used on this document"}},"components/schemas/DocumentPricingDetail":{"id":"components/schemas/DocumentPricingDetail","kind":"json-schema","title":"DocumentPricingDetail","data":{"properties":{"currencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"filedBaseAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"base":{"type":"number","description":"The base fare excluding any taxes or fees.","format":"float","example":750},"totalTaxes":{"type":"number","description":"Total amount of all taxes.","format":"float","example":50},"totalDocumentPrice":{"type":"number","description":"Total of base plus totalTaxes. OB fees are not included in totalDocumentPrice.","format":"float","example":850},"totalFees":{"type":"number","description":"Total amount of all fees.","format":"float","example":50},"totalChargePrice":{"type":"number","description":"Total of base, totalTaxes and totalFees.","format":"float","example":900},"totalAdditionalCollection":{"type":"number","description":"Additional Collection amount charged on the exchanged document.","format":"float","example":250},"totalForfeitAmount":{"type":"number","description":"The total amount that has been forfeited after an exchange of documents when a residual amount has not been refunded.","format":"float","example":25},"taxBreakdown":{"type":"array","description":"Individual tax breakdown and description.","items":{"$ref":"#/components/schemas/Taxes"}},"paidTaxBreakdown":{"type":"array","description":"Array of paid taxes.","items":{"$ref":"#/components/schemas/Taxes"}},"feeBreakdown":{"type":"array","description":"Array of individual fees.","items":{"$ref":"#/components/schemas/Fee"}},"fareCalculation":{"$ref":"#/components/schemas/FareCalculation"},"commissionAmount":{"type":"number","description":"The amount of commission applied to this document.","format":"float","example":25},"commissionPercent":{"type":"number","description":"The percentage of commission override applied to the document.","format":"float","example":10.25},"restrictions":{"type":"array","description":"Array of restrictions/endorsements.","items":{"type":"string","description":"Restriction/endorsement text.","example":"VALID BA ONLY"}},"tourCode":{"type":"string","description":"The tour code applied.","example":"SUMMERSUN"}},"description":"Detailed pricing information of the document."}},"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/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/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/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/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/FareCalculation":{"id":"components/schemas/FareCalculation","kind":"json-schema","title":"FareCalculation","data":{"properties":{"fareCalculationString":{"type":"string","description":"The linear fare calculation string.","example":"LON BA X/SIN SYD R250.00BA X/SIN BA LON R250.00END"},"rateOfExchange":{"type":"number","description":"The exchange rate applied.","format":"float","example":0.1234568},"pricingIndicator":{"maxLength":1,"minLength":1,"type":"string","description":"The pricing code indicates how the fare is priced. e.g. manual or automated. The pricing indicator determines when the fare is valid for the Travelport fare guarantee policy.","example":"G"}},"description":"Details on how the fare has been constructed."}},"components/schemas/VoidDetail":{"id":"components/schemas/VoidDetail","kind":"json-schema","title":"VoidDetail","data":{"type":"object","properties":{"voidDocumentNumber":{"$ref":"#/components/schemas/DocumentNumberType"},"voidDateTimeUTC":{"type":"string","description":"The date time the document was voided in GMT.","format":"date-time","example":"2025-05-11T15:30:00Z"},"source":{"maxLength":2,"minLength":2,"type":"string","example":"1G"},"pseudoCityCode":{"maxLength":4,"minLength":3,"type":"string","example":"XS4"},"voidingAgent":{"maxLength":4,"minLength":2,"type":"string","description":"The voiding agent initials.","example":"TW"},"sacCode":{"maxLength":14,"minLength":13,"type":"string","description":"The settlement authorization code for this transaction","example":"123SZ7RAS4GRR"}},"description":"Detail information on a document that has been voided"}},"components/schemas/RefundDetail":{"id":"components/schemas/RefundDetail","kind":"json-schema","title":"RefundDetail","data":{"type":"object","properties":{"refundDocumentNumber":{"$ref":"#/components/schemas/DocumentNumberType"},"refundDateTimeUTC":{"type":"string","description":"The date time the document was voided in GMT.","format":"date-time","example":"2025-05-11T15:30:00Z"},"source":{"maxLength":2,"minLength":2,"type":"string","example":"1G"},"pseudoCityCode":{"maxLength":4,"minLength":3,"type":"string","example":"XS4"},"refundingAgent":{"maxLength":4,"minLength":2,"type":"string","description":"The voiding agent initials.","example":"TW"},"sacCode":{"maxLength":14,"minLength":13,"type":"string","description":"The settlement authorization code for this transaction","example":"123SZ7RAS4GRR"},"refundCategory":{"type":"string","example":"Full","enum":["Full","Partial","Automated","NonReportable"],"x-enumDescriptions":{"Full":"Full Refund","Partial":"Partial Refund","Automated":"Cat33 Auto Refund","NonReportable":"Non reportable refund"}},"refundAmount":{"$ref":"#/components/schemas/RefundHistoryAmount"}},"description":"Detail information on a refunded document"}},"components/schemas/RefundHistoryAmount":{"id":"components/schemas/RefundHistoryAmount","kind":"json-schema","title":"RefundHistoryAmount","data":{"type":"object","properties":{"currencyCode":{"type":"string","description":"3 letter currency code as defined by ISO-4217.","example":"EUR"},"base":{"type":"number","description":"The base refund amount exclusive of taxes and fees.","format":"float","example":400},"equivalent":{"$ref":"#/components/schemas/CurrencyAmount"},"totalTaxes":{"type":"number","description":"Total amount of tax refunded.","format":"float","example":75},"totalRefund":{"type":"number","description":"Total refund amount.","format":"float","example":475},"refundTaxBreakdown":{"type":"array","description":"Array of individual taxes.","items":{"$ref":"#/components/schemas/Tax"}},"cashAmountUsed":{"type":"number","description":"Total cash amount used.","format":"float","example":475},"creditAmountUsed":{"type":"number","description":"Total credit amount used.","format":"float","example":475},"refundFormOfPayment":{"type":"array","description":"The form of payment used for the refund including the amount refunded.","items":{"$ref":"#/components/schemas/FormOfPaymentDocumentHistoryType"}},"refundPenalty":{"$ref":"#/components/schemas/CurrencyAmount"},"refundWaiverCode":{"$ref":"#/components/schemas/WaiverCode"},"refundCommissionAmount":{"type":"number","description":"The amount of commission applied to the refunded ticket.","format":"float","example":40},"refundCommissionPercent":{"type":"integer","description":"The percentage of commission override applied to the refunded ticket.","example":9}},"description":"Refund amount breakdown"}},"components/schemas/MCOInformation":{"id":"components/schemas/MCOInformation","kind":"json-schema","title":"MCOInformation","data":{"type":"object","properties":{"issuedFor":{"type":"string","description":"MCO issued for.","example":"Residual Value"},"reasonForIssuanceCode":{"type":"string","description":"MCO reason for issuance code.","example":"K"},"issuedAt":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"MCO issuance IATA location code.","example":"LON"},"pTA":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"tOD":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"comment":{"type":"array","items":{"type":"string","example":"MCO ISSUED FOR RESIDUAL VALUE"}}},"description":"MCO detail information"}},"components/schemas/ExchangeDocumentHistory":{"id":"components/schemas/ExchangeDocumentHistory","kind":"json-schema","title":"ExchangeDocumentHistory","data":{"properties":{"exchangedFor":{"$ref":"#/components/schemas/PreviousIssue"},"originalIssue":{"$ref":"#/components/schemas/PreviousIssue"},"previousIssue":{"type":"array","description":"Array of previous issued documents.","items":{"$ref":"#/components/schemas/PreviousIssue"}}},"description":"Details of documents that have been exchanged for this document."}},"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler":{"id":"components/schemas/TravelerUpdatableItemsQueryBuildFromTraveler","kind":"json-schema","title":"TravelerUpdatableItemsQueryBuildFromTraveler","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class TravelerUpdatableItemsQueryBuildFromTraveler only","example":"TravelerUpdatableItemsQueryBuildFromTraveler"},"TravelerIdentifier":{"maxItems":100,"type":"array","example":["34","65","23","12","22","81"],"items":{"maxLength":128,"type":"string"}}}}},"components/schemas/TravelerUpdatableItemsListResponseWrapper":{"id":"components/schemas/TravelerUpdatableItemsListResponseWrapper","kind":"json-schema","title":"TravelerUpdatableItemsListResponseWrapper","data":{"properties":{"TravelerUpdatableItemsListResponse":{"$ref":"#/components/schemas/TravelerUpdatableItemsListResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelerUpdatableItemsListResponse":{"id":"components/schemas/TravelerUpdatableItemsListResponse","kind":"json-schema","title":"TravelerUpdatableItemsListResponse","data":{"properties":{"TravelerUpdatableItemsID":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TravelerUpdatableItemsID"}}},"description":"The response of a Traveler updatable items list endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/TravelerUpdatableItemsID":{"id":"components/schemas/TravelerUpdatableItemsID","kind":"json-schema","title":"TravelerUpdatableItemsID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class TravelerUpdatableItems only","example":"TravelerUpdatableItems"},"id":{"type":"string","description":"Internally reference xsd id","example":"523"},"TravelerUpdatableItemsRef":{"type":"string"},"Identifier":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/AgencyQueueSummary":{"id":"components/schemas/AgencyQueueSummary","kind":"json-schema","title":"AgencyQueueSummary","data":{"allOf":[{"$ref":"#/components/schemas/AgencyQueueID"},{"required":["Queue"],"type":"object","properties":{"ReservationIdentifier":{"$ref":"#/components/schemas/Identifier"},"Queue":{"maxItems":99,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Queue"}}}}]}},"components/schemas/AgencyQueueID":{"id":"components/schemas/AgencyQueueID","kind":"json-schema","title":"AgencyQueueID","data":{"required":["@type"],"type":"object","properties":{"@type":{"type":"string","example":"AgencyQueueSummary"},"Identifer":{"$ref":"#/components/schemas/Identifier"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Queue":{"id":"components/schemas/Queue","kind":"json-schema","title":"Queue","data":{"type":"object","properties":{"value":{"type":"integer","format":"int32","example":23},"pccOverride":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","example":"0XS4"},"category":{"maxLength":3,"pattern":"([0-9a-zA-Z]+)?","type":"string"},"date":{"type":"string","format":"date","example":"2022-08-07"},"dateOffset":{"type":"integer","format":"int32"}}}},"components/schemas/BaseResponseWrapper":{"id":"components/schemas/BaseResponseWrapper","kind":"json-schema","title":"BaseResponseWrapper","data":{"properties":{"BaseResponse":{"$ref":"#/components/schemas/BaseResponse"}},"description":"Wrapper object"}},"components/schemas/AgencyQueueResponseWrapper":{"id":"components/schemas/AgencyQueueResponseWrapper","kind":"json-schema","title":"AgencyQueueResponseWrapper","data":{"properties":{"AgencyQueueResponse":{"$ref":"#/components/schemas/AgencyQueueResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/AgencyQueueResponse":{"id":"components/schemas/AgencyQueueResponse","kind":"json-schema","title":"AgencyQueueResponse","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"AgencyQueueResponse"},"AgencyQueue":{"$ref":"#/components/schemas/AgencyQueueDetail"}},"description":"Agency queue response including QueueList","discriminator":{"propertyName":"@type"},"allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/AgencyQueueDetail":{"id":"components/schemas/AgencyQueueDetail","kind":"json-schema","title":"AgencyQueueDetail","data":{"allOf":[{"$ref":"#/components/schemas/AgencyQueueSummary"},{"type":"object","properties":{"QueueList":{"type":"array","items":{"$ref":"#/components/schemas/QueueList"}}}}]}},"components/schemas/QueueList":{"id":"components/schemas/QueueList","kind":"json-schema","title":"QueueList","data":{"required":["@type","Locator","Name"],"properties":{"@type":{"type":"string","description":"Discriminator class QueueList only.","example":"QueueList"},"Name":{"maxLength":128,"type":"string","description":"The lead traveler in the reservation.","example":"1SMITH ADT/ROBERT C MR"},"Locator":{"$ref":"#/components/schemas/Locator"},"TravelDate":{"type":"string","description":"The first date of travel in the reservation.","format":"date","example":"2025-10-25"},"additionalReservationsExistInd":{"type":"boolean","description":"If true, the maximum queue list count has been reached. To retrieve the entire queue list retry with retrieveAllInd query parameter.","example":true}},"description":"A list of reservations that are actively on the queue."}},"components/schemas/TravelAgencyQueryTravelAgencyWrapper":{"id":"components/schemas/TravelAgencyQueryTravelAgencyWrapper","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyWrapper","data":{"properties":{"TravelAgencyQueryTravelAgency":{"$ref":"#/components/schemas/TravelAgencyQueryTravelAgency"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelAgencyQueryTravelAgency":{"id":"components/schemas/TravelAgencyQueryTravelAgency","kind":"json-schema","title":"TravelAgencyQueryTravelAgency","data":{"properties":{"Address":{"$ref":"#/components/schemas/AddressBasic"},"Telephone":{"type":"array","items":{"$ref":"#/components/schemas/TelephoneBasic"}},"Email":{"$ref":"#/components/schemas/EmailBasic"},"CorporateCode":{"maxLength":32,"type":"string","description":"A reference assigned by the Travel Agency to identify the corporate organization","example":"Air Agency"}},"description":"At least one property is required in the payload. For AF/KL NDC bookings both the Telephone and Email are required at time of Reservation commit."}},"components/schemas/AddressBasic":{"id":"components/schemas/AddressBasic","kind":"json-schema","title":"AddressBasic","data":{"properties":{"role":{"$ref":"#/components/schemas/Enum_AddressRole"},"Addressee":{"maxLength":37,"type":"string","description":"The name of the company or person to be addressed","example":"MRS A Agent"},"AddressLine":{"maxItems":1,"type":"array","description":"Street address. Use in place of Street and Number. Each element of the array represents an address line.","example":"2035 S Havana street","items":{"maxLength":128,"type":"string"}},"City":{"maxLength":128,"type":"string","description":"City, town, or postal station.","example":"Denver"},"StateProv":{"$ref":"#/components/schemas/StateProv"},"Country":{"$ref":"#/components/schemas/Country"},"PostalCode":{"maxLength":128,"type":"string","description":"Postal code for the address.","example":"Sl6 1AB"}}}},"components/schemas/TelephoneBasic":{"id":"components/schemas/TelephoneBasic","kind":"json-schema","title":"TelephoneBasic","data":{"properties":{"role":{"$ref":"#/components/schemas/Enum_TelephoneRole"},"cityCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"City Code","example":"DEN"},"countryAccessCode":{"pattern":"[0-9]{1,3}","type":"string","description":"Telephone Country Access Code","example":"1"},"areaCityCode":{"pattern":"[0-9]{1,8}","type":"string","description":"Telephone Area CityCode","example":"972"},"phoneNumber":{"maxLength":32,"type":"string","description":"Mobile/Telephone Number","example":"972-000-787"},"extension":{"pattern":"[0-9]{0,5}","type":"string","description":"Telephone extension number","example":"234"}}}},"components/schemas/EmailBasic":{"id":"components/schemas/EmailBasic","kind":"json-schema","title":"EmailBasic","data":{"properties":{"value":{"maxLength":128,"type":"string","example":"exampledomain@example.com"},"emailType":{"type":"string","description":"Use email type to specify if the email is to be sent \"TO\" or sent \"FROM\"","example":"FROM"}},"description":"email addresses"}},"components/schemas/TravelAgencyResponse":{"id":"components/schemas/TravelAgencyResponse","kind":"json-schema","title":"TravelAgencyResponse","data":{"properties":{"TravelAgency":{"$ref":"#/components/schemas/TravelAgencyID"}},"description":"The response of Travel agency endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper":{"id":"components/schemas/TravelAgencyQueryTravelAgencyAddressWrapper","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyAddressWrapper","data":{"properties":{"TravelAgencyQueryTravelAgencyAddress":{"$ref":"#/components/schemas/TravelAgencyQueryTravelAgencyAddress"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelAgencyQueryTravelAgencyAddress":{"id":"components/schemas/TravelAgencyQueryTravelAgencyAddress","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyAddress","data":{"required":["Address"],"properties":{"Address":{"$ref":"#/components/schemas/AddressDetail"}}}},"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/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/TravelAgencyQueryTravelAgencyCorporateCodeWrapper":{"id":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCodeWrapper","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyCorporateCodeWrapper","data":{"properties":{"TravelAgencyQueryTravelAgencyCorporateCode":{"$ref":"#/components/schemas/TravelAgencyQueryTravelAgencyCorporateCode"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelAgencyQueryTravelAgencyCorporateCode":{"id":"components/schemas/TravelAgencyQueryTravelAgencyCorporateCode","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyCorporateCode","data":{"required":["CorporateCode"],"properties":{"CorporateCode":{"maxLength":32,"type":"string","description":"A reference assigned by the Travel Agency to identify the corporate organization","example":"Air Agency"}}}},"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper":{"id":"components/schemas/TravelAgencyQueryTravelAgencyEmailWrapper","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyEmailWrapper","data":{"properties":{"TravelAgencyQueryTravelAgencyEmail":{"$ref":"#/components/schemas/TravelAgencyQueryTravelAgencyEmail"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelAgencyQueryTravelAgencyEmail":{"id":"components/schemas/TravelAgencyQueryTravelAgencyEmail","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyEmail","data":{"required":["Email"],"properties":{"Email":{"$ref":"#/components/schemas/Email"}},"example":"john@travelport.com"}},"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper":{"id":"components/schemas/TravelAgencyQueryTravelAgencyTelephoneWrapper","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyTelephoneWrapper","data":{"properties":{"TravelAgencyQueryTravelAgencyTelephone":{"$ref":"#/components/schemas/TravelAgencyQueryTravelAgencyTelephone"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/TravelAgencyQueryTravelAgencyTelephone":{"id":"components/schemas/TravelAgencyQueryTravelAgencyTelephone","kind":"json-schema","title":"TravelAgencyQueryTravelAgencyTelephone","data":{"required":["Telephone"],"properties":{"Telephone":{"$ref":"#/components/schemas/TelephoneDetail"}},"example":553467891}},"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/CustomRuleResponseWrapper":{"id":"components/schemas/CustomRuleResponseWrapper","kind":"json-schema","title":"CustomRuleResponseWrapper","data":{"properties":{"CustomRuleResponse":{"$ref":"#/components/schemas/CustomRuleResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/CustomRuleResponse":{"id":"components/schemas/CustomRuleResponse","kind":"json-schema","title":"CustomRuleResponse","data":{"required":["CustomRule"],"properties":{"CustomRule":{"$ref":"#/components/schemas/CustomRuleID"}},"description":"The response of a Custom rule endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"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/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/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/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/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"}},"discriminator":{"propertyName":"@type"}}},"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/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/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/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/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/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/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/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/FlightDetail":{"id":"components/schemas/FlightDetail","kind":"json-schema","title":"FlightDetail","data":{"description":"Extended Flight class","allOf":[{"$ref":"#/components/schemas/Flight"},{"properties":{"AvailabilitySourceCode":{"$ref":"#/components/schemas/AvailabilitySourceCodeENUM"}}}]}},"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/TermsAndConditionsAir":{"id":"components/schemas/TermsAndConditionsAir","kind":"json-schema","title":"TermsAndConditionsAir","data":{"description":"The Terms And Conditions applicable to this Air Offering. FareRuleIdentifierRef is deprecated and not in use. Use Fare Rule end points directly for detailed fare rules.","allOf":[{"$ref":"#/components/schemas/TermsAndConditions"},{"properties":{"BaggageAllowance":{"maxItems":99,"type":"array","items":{"$ref":"#/components/schemas/BaggageAllowance"}},"FareRuleIdentifierRef":{"$ref":"#/components/schemas/IdentifierRef"},"Restriction":{"maxItems":10,"type":"array","description":"Not supported in Search response.","deprecated":true,"items":{"$ref":"#/components/schemas/Restriction"}},"OrganizationInformation":{"$ref":"#/components/schemas/OrganizationInformation"},"ValidatingAirline":{"maxItems":10,"type":"array","description":"Each instance lists the carrier on which the ticket is issued.","items":{"$ref":"#/components/schemas/ValidatingAirline"}},"BaggageRecheck":{"maxItems":10,"type":"array","description":"Not implemented.","deprecated":true,"items":{"$ref":"#/components/schemas/BaggageRecheck"}},"TicketingAgency":{"maxItems":10,"type":"array","description":"If TicketingPCC was sent in the request to override the default ticketing agency, TicketingAgency returns the PCC of the overriding agency. If no override request was made, TicketingAgency returns the default PCC. GDS only; not supported for NDC.","items":{"$ref":"#/components/schemas/TicketingAgency"}},"PaymentTimeLimit":{"type":"string","description":"The local (per the point of sale) date and time by which the offer must be ticketed. Returned for GDS offers and some NDC airlines.","format":"date-time","example":"2022-08-07T12:12:00Z"},"PromotionalCode":{"$ref":"#/components/schemas/PromotionalCode"},"Penalties":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search returns change and cancel penalties for this set of terms and conditions. For GDS, Penalties are currently returned as the most restrictive CAT16 penalty details; NDC penalty rules are not necessarily filed in a specific category (CAT). Returned by default. Not returned if the optional indicator excludePenaltiesInd=true (GDS only), which omits penalty information from the response. Includes the PassengerTypeCodes object and either or both the Change and Cancel objects. Not all NDC carriers return penalty details. Some NDC carriers may not return Penalty/amount when a change is permitted, which means there is no charge for the change."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Penalties"}},"FareGuaranteePolicy":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/FareGuaranteePolicy"}},"PricingAgency":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PricingAgency"}},"FlightPass":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/FlightPass"}},"instantPurchaseInd":{"type":"boolean","description":"If true the Offer/Offering must be paid for at the same time as creating the Reservation.","example":true},"secureFlightPassengerDataRequiredInd":{"type":"boolean","description":"Returned only when true to indicate the airline requires additional passenger data for one or more travelers to complete the reservation per Secure Flight Passenger Data requirements.","example":true},"TourCodes":{"maxItems":10,"type":"array","description":"GDS only; not supported for NDC. Any tour code applicable to this fare, per PTC. Includes TravelerIdentifierRef and TourCode objects.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.","items":{"$ref":"#/components/schemas/TourCodes"}},"DocumentValidDateRange":{"$ref":"#/components/schemas/DocumentValidDateRange"},"flightPassInd":{"type":"boolean","description":"If true, indicates a flight pass offer. A response may include both regular priced offers (non flight pass) and flight pass offers."}}}]}},"components/schemas/BaggageAllowance":{"id":"components/schemas/BaggageAllowance","kind":"json-schema","title":"BaggageAllowance","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator. Child class BaggageAllowanceDetail","example":"BaggageAllowanceDetail"},"passengerTypeCodes":{"type":"array","description":"All PTCs to which this allowance applies.","items":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","example":"ADT"}},"baggageType":{"$ref":"#/components/schemas/BaggageTypeEnum"},"validatingAirlineCode":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The validating baggage airline code","example":"BA"},"ProductRef":{"type":"array","description":"The Product id/s to which this baggage allowance applies.","example":["p1","p2"],"items":{"type":"string"}},"BaggageItem":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/BaggageItem"}},"SegmentSequenceList":{"type":"array","description":"Segment/s on which this baggage allowance applies.  \nSegment sequence is only to be used when the baggage allowance differs between segments within a product. If so, then the ProducRef must be specified.","example":[12,45,3,2],"items":{"type":"integer","format":"int32"}},"Text":{"maxItems":35,"type":"array","example":["Blue baggage allowed","Purple baggage allowed"],"items":{"maxLength":128,"type":"string"}}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If returned by the carrier, describes a specific type of baggage, or if a baggage embargo is in effect."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The baggage allowance is displayed by baggage type with associated conditions (max pieces, weight, and unit of weight) and charges (fee with currency code), if applicable."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Baggage-related data including measurements and baggageType may not always be returned for every offer depending on the information sent by the carrier."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Baggage fees and embargo information can be excluded from the Search response with the excludeBaggageFeesInd indicator (GDS only)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once instance of BaggageAllowance will be sent for each PTC where the allowance differs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the Reservation Retrieve request, you can send the optional query parameter viewBaggageDetailInd=true to include additional baggage details in the response in TermsAndConditionsFull/BaggageAllowance. GDS only; not supported for NDC."},"children":[]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/BaggageTypeEnum":{"id":"components/schemas/BaggageTypeEnum","kind":"json-schema","title":"BaggageTypeEnum","data":{"type":"string","description":"Identifies the type of baggage.","example":"CarryOn","enum":["CarryOn","FirstCheckedBag","SecondCheckedBag","AdditionalBags","BaggageEmbargo"]}},"components/schemas/BaggageItem":{"id":"components/schemas/BaggageItem","kind":"json-schema","title":"BaggageItem","data":{"properties":{"@type":{"type":"string","example":"BaggageItem"},"quantity":{"type":"integer","description":"The number of baggage items allowed. May be free or at a charge. Not returned for baggage allowances by weight.","format":"int32","example":2},"includedInOfferPrice":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"Measurement":{"maxItems":6,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Measurement details for BaggageItem as available and applicable."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Baggage measurements are not always returned."},"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":"measurementType: Type of measurement specified, such as weight, height, width, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unit: Unit in which measurement is specified, such as Kilograms, Inches, Centimeters, etc."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value: The number of units allowed for this measurement type."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC returns quantity and Measurement info for FirstCheckedBag, SecondCheckedBag, AdditionalBags, and CarryOn when returned by the NDC carrier. NDC returns measurements in structured format in the Search response when the NDC carrier returns them this way. Otherwise, the measurements are returned in Text."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For GDS, baggage measurements are returned in Text."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/Measurement"}},"BaggageFee":{"$ref":"#/components/schemas/CurrencyAmount"},"Text":{"maxLength":128,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any free text provided by carrier for baggage terms."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May provide measurements for the allowed baggage dimension."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the baggage allowance is based on pieces, Text returns 0P, 1P, 2P, or 3P, defined as follows, for FirstCheckedBag, SecondCheckedBag, AdditionalBags, and/or CarryOn."},"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":"0P: No free bags."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1P: The FirstCheckedBag is free; the SecondCheckedBag has a fee."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2P: Both the FirstCheckedBag and SecondCheckedBag are free."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3P: Both the FirstCheckedBag and SecondCheckedBag are free, plus an additional checked bag (AdditionalBags) is free."},"children":[]}]}]}]}],"example":"UPTO15LB/7KG AND UPTO45LI/115LCM"},"soldByPieceInd":{"type":"boolean","description":"Returned only if true. Indicates baggage allowance is by piece, such as one, two, or three pieces. Weight restrictions may also apply."},"soldByWeightInd":{"type":"boolean","description":"Returned only if true. Indicates the baggage is allowed by weight, either kilograms or pounds, such as 50 pounds or 35 kilograms. Number of item restrictions may also apply."}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Baggage-related data including measurements and baggageType may not always be returned for every offer depending on the information sent by the carrier."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The indicators includedInOfferPrice, soldByPieceInd, and soldByWeightInd are returned as applicable in AirPrice if the Reservation Retrieve request sends detailViewInd and viewBaggageDetailInd as true."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A note for includedInOfferPrice possible values:"},"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":"Yes: Baggage is included in the price."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No: Baggage is not included in the price; available for an additional charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown: Unknown if baggage is included in the price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A note for BaggageFee (the cost for an item of baggage):"},"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":"code: Currency code for cost."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"approximateInd: True indicates the charge is approximate. False indicates the charge is an exact price."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"value: Cost of baggage in the related currency."},"children":[]}]}]}]}]}},"components/schemas/Restriction":{"id":"components/schemas/Restriction","kind":"json-schema","title":"Restriction","data":{"properties":{"value":{"maxLength":128,"type":"string","example":"No late arrivals"},"segmentSequenceList":{"type":"array","description":"Segment sequence list","example":[2,4,6,8,10],"items":{"type":"integer","format":"int32"}},"productRef":{"type":"array","description":"The productRef which the restriction applies to","example":["p1","p2","p3","p4"],"items":{"type":"string"}}},"description":"Restriction"}},"components/schemas/ValidatingAirline":{"id":"components/schemas/ValidatingAirline","kind":"json-schema","title":"ValidatingAirline","data":{"required":["ValidatingAirline"],"properties":{"@type":{"type":"string","example":"ValidatingAirline"},"SegmentSequenceList":{"type":"array","description":"The segmentSequenceList the validatingCarrier applies to","example":[2,4,6,8,10],"items":{"type":"integer","format":"int32"}},"ValidatingAirline":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the airline responsible for ticketing/fulfillment of this Offer"},"children":[]}]}]}],"example":"QA"},"ProductRef":{"type":"array","description":"The productRef the validatingCarrier applies to","example":["product1","product2","product3"],"items":{"type":"string"}}},"description":"Represents the airline responsible for ticketing/fulfillment of this Offer.Each instance lists the carrier on which the ticket is issued."}},"components/schemas/BaggageRecheck":{"id":"components/schemas/BaggageRecheck","kind":"json-schema","title":"BaggageRecheck","data":{"required":["ArrivalFlight","At","DepartureFlight"],"properties":{"@type":{"type":"string","example":"BaggageRecheck"},"At":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"The city where the baggage recheck is required","example":"MEX"},"ArrivalFlight":{"$ref":"#/components/schemas/FlightID"},"DepartureFlight":{"$ref":"#/components/schemas/FlightID"}},"description":"Used when baggage recheck is required between connecting flights"}},"components/schemas/TicketingAgency":{"id":"components/schemas/TicketingAgency","kind":"json-schema","title":"TicketingAgency","data":{"required":["Code"],"properties":{"@type":{"type":"string","example":"TicketingAgency"},"Code":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"PCC of the overriding or default ticket agency.","example":"A561510"},"ProductRef":{"type":"array","description":"Product references to which this ticketing agency PCC applies. If empty applies to all products within the offer.","example":["p1","p2","p3"],"items":{"type":"string"}},"SegmentSequenceList":{"type":"array","description":"SegmentSequenceList the TicketingAgency applies to. If empty applies to all segments within the product.","example":[31,28,43,42,51,26],"items":{"type":"integer","format":"int32"}}},"description":"Contains the Ticketing Agency code that the Offer must be ticketed by."}},"components/schemas/FareGuaranteePolicy":{"id":"components/schemas/FareGuaranteePolicy","kind":"json-schema","title":"FareGuaranteePolicy","data":{"required":["@type","EligibleforADMReview"],"properties":{"@type":{"type":"string","description":"discriminator","example":"FareGuaranteePolicy"},"passengerTypeCodes":{"type":"array","description":"The list of passenger type codes","example":["ADT","CHD"],"items":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string"}},"EligibleforADMReview":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"Code":{"$ref":"#/components/schemas/Code"}},"description":"Travelports fare guarantee policy applicable to the Offer. Used to  identify the quote type, if that information was returned by the airline."}},"components/schemas/Code":{"id":"components/schemas/Code","kind":"json-schema","title":"Code","data":{"properties":{"value":{"maxLength":32,"type":"string","example":"INS"},"codeContext":{"maxLength":32,"type":"string","description":"Code Context","example":"ACRISS"}},"description":"Any code used to specify an item, for example a type of traveler, service code, room amenity, etc."}},"components/schemas/PricingAgency":{"id":"components/schemas/PricingAgency","kind":"json-schema","title":"PricingAgency","data":{"required":["Code"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"PricingAgency"},"ProductRef":{"type":"array","description":"Product references to which this pricing agency PCC applies. If empty applies to all products within the offer.","items":{"type":"string","example":"p1"}},"Code":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"PCC of the overriding or default pricing agency.","example":"0XS4"},"SegmentSequenceList":{"type":"array","description":"SegmentSequence references to which this pricing agency PCC applies. If empty applies to all segments within the products.","example":[2,4,6,8,10],"items":{"type":"integer","format":"int32","example":1}}},"description":"The pricing agency for this offer."}},"components/schemas/DocumentValidDateRange":{"id":"components/schemas/DocumentValidDateRange","kind":"json-schema","title":"DocumentValidDateRange","data":{"properties":{"@type":{"type":"string","example":"DocumentValidDateRange"},"ProductRef":{"type":"string","description":"The product this document date range applies to. If blank, applies to all products.","example":"product_1"},"SegmentSequenceList":{"type":"array","description":"The segmentSequence within the product the action is being requested for. Used when multiple flights exist within a product. Only one product may be selected with this option.","items":{"type":"integer","format":"int32"}},"ValidDateRange":{"$ref":"#/components/schemas/DateRange"}},"description":"The valid date range to be applied to the document."}},"components/schemas/PriceBreakdownAir":{"id":"components/schemas/PriceBreakdownAir","kind":"json-schema","title":"PriceBreakdownAir","data":{"description":"Price breakdown by PTC; each instance returns pricing for one passenger of a single PTC. On multi-passenger itineraries, refer to TotalPrice for a total price for the itinerary.\nFor GDS may return FiledAmount, FareCalculation, and/or Commission.   \nFor NDC may return Discount, PassengerCriteriaRefs, TravelerIdentifierRef. May include FlightPassCredits (Air Canada NDC only).  ","allOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"properties":{"quantity":{"type":"integer","description":"Quantity of passengers in that PTC.","format":"int32","example":2},"requestedPassengerType":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"The PTC to which the PriceBreakdown applies.","example":"CHD"},"FiledAmount":{"$ref":"#/components/schemas/FiledAmount"},"Discount":{"$ref":"#/components/schemas/Discount"},"NetFareInfo":{"$ref":"#/components/schemas/NetFareInfo"},"TravelerIdentifierRef":{"$ref":"#/components/schemas/TravelerIdentifierRef"},"NetBaseAmount":{"$ref":"#/components/schemas/FiledAmount"},"FareCalculation":{"maxLength":512,"type":"string","description":"GDS only; not supported for NDC.  \nFor each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline.","example":"LON BA SYD R564.00YEE1Y BA LON R564.00YEE1Y NUC1128.00END ROE0.787855"},"Surcharges":{"$ref":"#/components/schemas/Surcharges"},"TravelerRefs":{"type":"array","description":"Returned only in Reservation Retrieve to identify the traveler associated with this instance of PriceBreakdown in case of multiple offers on the booking.","items":{"type":"string","example":"[\"traveler_1\",\"traveler2\"]"}},"PaidTaxes":{"$ref":"#/components/schemas/PaidTaxes"},"RequestedPricingModifiers":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/RequestedPricingModifiers"}},"PassengerCriteriaRefs":{"type":"array","description":"NDC only; not supported for GDS.  \nReturned for NDC if a traveler identifier was sent for this traveler in the previous workflow requests.","items":{"type":"string","example":"passengerCriteria_1"}},"FlightPassCredits":{"type":"integer","description":"The number of flight pass credits consumed for this pricebreakdown.","format":"int32","example":1}}}]}},"components/schemas/Discount":{"id":"components/schemas/Discount","kind":"json-schema","title":"Discount","data":{"required":["codeAuthority","currencyCode","decimalPlace"],"properties":{"value":{"type":"number","description":"The amount value of the discount","format":"float","example":20.22},"description":{"maxLength":512,"type":"string","description":"The text description for the discount.","example":"Spring discount on group bookings"},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Currency code discount is returned in.","example":"USD"},"codeAuthority":{"maxLength":32,"type":"string","description":"Not used. Currency code Authority.","example":"ISO"},"decimalPlace":{"type":"integer","description":"Number of decimal places in the currency the discount is returned in.","format":"int32","example":2},"decimalAuthority":{"maxLength":32,"type":"string","description":"Not used. Decimal Authority.","example":"ISO"}},"description":"NDC only; not supported for GDS.  \nReturned for a fare discounted from the published price, such as a promotional discount. Not returned for privately negotiated discounts such as private fares."}},"components/schemas/NetFareInfo":{"id":"components/schemas/NetFareInfo","kind":"json-schema","title":"NetFareInfo","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"NetFareInfo"},"passengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"PassengerTypeCode","example":"ADT"},"NetFareBreakdownConstruction":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/NetFareBreakdownConstruction"}},"TicketBaseAudit":{"$ref":"#/components/schemas/FiledAmount"},"TicketBasePassenger":{"$ref":"#/components/schemas/TicketBasePassenger"}},"description":"Detailed information on the net fare used."}},"components/schemas/NetFareBreakdownConstruction":{"id":"components/schemas/NetFareBreakdownConstruction","kind":"json-schema","title":"NetFareBreakdownConstruction","data":{"properties":{"value":{"maxLength":512,"type":"string"},"fareType":{"maxLength":32,"type":"string","description":"Assigned Type: c-1100:StringTiny"},"rateOfExchange":{"type":"number","description":"The rate of exchange applied to the fare breakdown","format":"float"}},"description":"The net fare calculation."}},"components/schemas/TicketBasePassenger":{"id":"components/schemas/TicketBasePassenger","kind":"json-schema","title":"TicketBasePassenger","data":{"required":["codeAuthority","decimalPlace"],"properties":{"value":{"type":"number","format":"float"},"currencyCode":{"pattern":"[a-zA-Z]{3}","type":"string","description":"Assigned Type: c-1100:CurrencyCode"},"codeAuthority":{"maxLength":32,"type":"string","description":"Assigned Type: c-1100:CodeContext"},"decimalPlace":{"type":"integer","description":"Assigned Type: c-1100:CurrencyMinorUnit","format":"int32"},"decimalAuthority":{"maxLength":32,"type":"string","description":"Assigned Type: c-1100:CodeContext"},"bTInd":{"type":"boolean","description":"If true, this is a bulk ticket fare"},"iTInd":{"type":"boolean","description":"If true, this is an inclusive tour fare"}},"description":"The monetary value"}},"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/RequestedPricingModifiers":{"id":"components/schemas/RequestedPricingModifiers","kind":"json-schema","title":"RequestedPricingModifiers","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"RequestedPricingModifiers"},"PassengerCriteria":{"$ref":"#/components/schemas/PassengerCriteria"},"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"CabinPreference":{"$ref":"#/components/schemas/CabinPreference"},"FlightType":{"$ref":"#/components/schemas/FlightType"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"PricingModifiersAirChange":{"$ref":"#/components/schemas/PricingModifiersAirChange"},"lowFareFinderInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service. If true, returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted. When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service. GDS only; not supported for NDC."},"children":[]}]}]}],"example":true},"keepToBrandInd":{"type":"boolean","description":"If true, the original brand will be maintained during the exchange process.","example":true},"lowFareFindAndRebookInd":{"type":"boolean","description":"If true, the original flights in the reservation will be rebooked or replaced with the new exchanged flights."}},"description":"The pricing modifiers that were requested during the initial search."}},"components/schemas/BuildFromProductsRequestAirSearch":{"id":"components/schemas/BuildFromProductsRequestAirSearch","kind":"json-schema","title":"BuildFromProductsRequestAirSearch","data":{"description":"Reference path from Search response","allOf":[{"$ref":"#/components/schemas/BuildFromProductsRequestAir"},{"properties":{"SearchModifiersAir":{"$ref":"#/components/schemas/SearchModifiersAir"}}}]}},"components/schemas/BuildFromProductsRequestAir":{"id":"components/schemas/BuildFromProductsRequestAir","kind":"json-schema","title":"BuildFromProductsRequestAir","data":{"description":"Full payload itinerary request with option pricing and response modifiers. Used in multiple workflows including Flight specific search, Full payload Price, Full Payload Add Offer.","allOf":[{"$ref":"#/components/schemas/BuildFromProductsRequest"},{"required":["PassengerCriteria","ProductCriteriaAir"],"properties":{"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"PassengerCriteria":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PassengerCriteria"}},"ProductCriteriaAir":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ProductCriteriaAir"}},"CustomResponseModifiersAir":{"type":"array","items":{"$ref":"#/components/schemas/CustomResponseModifiersAir"}}}}]}},"components/schemas/BuildFromCatalogProductOfferingsRequestAirSearch":{"id":"components/schemas/BuildFromCatalogProductOfferingsRequestAirSearch","kind":"json-schema","title":"BuildFromCatalogProductOfferingsRequestAirSearch","data":{"description":"Reference path from Search response","allOf":[{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequestAir"},{"properties":{"SearchModifiersAir":{"$ref":"#/components/schemas/SearchModifiersAir"}}}]}},"components/schemas/BuildFromCatalogProductOfferingsRequestAir":{"id":"components/schemas/BuildFromCatalogProductOfferingsRequestAir","kind":"json-schema","title":"BuildFromCatalogProductOfferingsRequestAir","data":{"description":"Reference path payload using identifiers from Air Search response.","allOf":[{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"},{"properties":{"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"CabinPreference":{"$ref":"#/components/schemas/CabinPreference"},"FareRuleCategory":{"maxItems":10,"type":"array","description":"Not recommended use. Invoke fare rule end points directly.","items":{"$ref":"#/components/schemas/FareRuleCategoryEnum"}},"FareRuleType":{"$ref":"#/components/schemas/FareRuleEnum"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"lowFareFinderInd":{"type":"boolean","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":"Provides pricing flexibility around class of service. If not sent, the response returns fares only in the requested class of service."},"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":"If true: returns the lowest fares available in any class of service available, which may not be the same as the requested class. Note that if lowFareFinderInd is sent with true and CabinPreference is sent, the only supported value for CabinPreference/type is Permitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false: Provides fares for only the specified class of service. Default."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When lowFareFindInd=true and brand attributes are not disabled (inhibitBrandContentInd), AirPrice uses only the brand tier (and any other pricing modifiers) to find the lowest fare within a brand tier regardless of class of service."},"children":[]}]}]}],"example":true},"reCheckInventoryInd":{"type":"boolean","description":"If true, verifies availability for the requested number of passengers in a specific class of service at the time of the price request by booking and releasing seats. Because this indicator temporarily affects seat availability, the recommended best practice is to use validateInventoryInd instead. Some airlines monitor for high volumes of sell/ignore transactions. Regardless of pricing results, air fares and inventory are only guaranteed by airlines when ticketed and paid. Can help reduce sell failures at booking by alerting of insufficient availability. If any or all segments are not bookable, AirPrice does not return any offers and returns an error message. GDS only, not supported for NDC (NDC carriers always validate inventory at pricing).","example":true},"inhibitBrandContentInd":{"type":"boolean","description":"If true, disables the return of branded fare attributes. By default the AirPrice Reference Payload request returns branded fare attributes.","example":true},"validateInventoryInd":{"type":"boolean","description":"Verifies availability and may reduce failures at the Add Offer and Workbench Commit steps. If true, verifies availability for the requested number of passengers in a specific class of service at the time of the price request. If there are fewer seats than requested passengers available in that class of service, AirPrice returns an error message and no offers. GDS only, not supported for NDC (NDC carriers always validate inventory at pricing).","example":true}}}]}},"components/schemas/PricingModifiersAirDetail":{"id":"components/schemas/PricingModifiersAirDetail","kind":"json-schema","title":"PricingModifiersAirDetail","data":{"description":"Additional Pricing Modifiers that can be used to influence the Price of an Offer","allOf":[{"$ref":"#/components/schemas/PricingModifiersAir"},{"properties":{"Brand":{"$ref":"#/components/schemas/Brand"}}}]}},"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/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/FareSelectionDetail":{"id":"components/schemas/FareSelectionDetail","kind":"json-schema","title":"FareSelectionDetail","data":{"description":"Object to request fares with specific restrictions.  The response does not return any indicators about these conditions. ","allOf":[{"$ref":"#/components/schemas/FareSelection"},{"properties":{"validatingCarrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"IATA code for a carrier to override any default validating carrier (the airline designator that the ticket is issued against).  \nIf the validating carrier code is not supported for an itinerary, the response returns the error Ticketing Agreement does not exist.  \nIf an invalid validating carrier code is sent in the request, the response returns the error Unknown Carrier.","example":"KA"},"prohibitMinStayFaresInd":{"type":"boolean","description":[{"$$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":"If true: returns only fares that do not require a minimum stay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): allows minimum stay fares."},"children":[]}]}]}]}],"example":true},"prohibitMaxStayFaresInd":{"type":"boolean","description":[{"$$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":"If true: returns only fares that do not require a maximum stay."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): allows maximum stay fares."},"children":[]}]}]}]}],"example":true},"refundableOnlyInd":{"type":"boolean","description":[{"$$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":"If true: returns only fares that are fully refundable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): allows fares that are not fully refundable"},"children":[]}]}]}]}],"example":true},"prohibitAdvancePurchaseFaresInd":{"type":"boolean","description":[{"$$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":"If true, returns only fares that do not require advance purchase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false (default behavior): allows fares with advance purchase restrictions."},"children":[]}]}]}]}],"example":true},"prohibitUnbundledFaresInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported for GDS Exchanges."},"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":"If true, prevents unbundled fares."},"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":"If false (default behavior): does not prevent unbundled fares."},"children":[]}]}]}]}]}],"example":true},"prohibitRefundableFaresInd":{"type":"boolean","description":"This field is deprecated. Use RefundOptions for refundability options","example":true}}}]}},"components/schemas/ChangeIndeterminate":{"id":"components/schemas/ChangeIndeterminate","kind":"json-schema","title":"ChangeIndeterminate","data":{"description":"The change restrictions cannot be determined.","allOf":[{"$ref":"#/components/schemas/Change"},{"properties":{"IndeterminateInd":{"type":"string","description":"Structured fare rules could not be determined for this category.","example":"true"}}}]}},"components/schemas/ChangePermitted":{"id":"components/schemas/ChangePermitted","kind":"json-schema","title":"ChangePermitted","data":{"description":"Changes are permitted but may have restrictions","allOf":[{"$ref":"#/components/schemas/Change"},{"required":["penaltyTypes"],"properties":{"penaltyTypes":{"type":"array","items":{"$ref":"#/components/schemas/PenaltyTypeEnum"}},"PenaltyAppliesTo":{"$ref":"#/components/schemas/PenaltyAppliesToEnum"},"Penalty":{"maxItems":2,"type":"array","items":{"$ref":"#/components/schemas/Penalty"}},"higherPenatltyAppliesInd":{"type":"boolean","description":"If true, when an amount and a percent are specified in the Penalty then the higher of these apply","example":true},"MinimumAdcolAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"ChangeMethod":{"$ref":"#/components/schemas/ChangeMethodEnum"},"ResidualValuePenalty":{"$ref":"#/components/schemas/ResidualValuePenaltyEnum"},"PeriodBeforeDeparture":{"$ref":"#/components/schemas/PeriodBeforeDeparture"},"PenaltyException":{"$ref":"#/components/schemas/PenaltyException"}}}]}},"components/schemas/PenaltyTypeEnum":{"id":"components/schemas/PenaltyTypeEnum","kind":"json-schema","title":"PenaltyTypeEnum","data":{"type":"string","description":"Type of penalty that applies to the change or cancellation option.  \nWhen returned in an Air Exchange Eligibility response, a value of Maximum indicates the Change object lists maximum change fees; a value of Minimum indicates it lists minimum change fees.","enum":["BeforeDeparture","AfterDeparture","Anytime","NoShow","Minimum","Maximum","ExchangeRequired","ExchangeNotRequired"]}},"components/schemas/PenaltyAppliesToEnum":{"id":"components/schemas/PenaltyAppliesToEnum","kind":"json-schema","title":"PenaltyAppliesToEnum","data":{"type":"string","description":"Returned in Change and Cancel objects to specify what the change or cancel penalty applies to.","example":"PerTicket","enum":["OneWay","RoundTrip","PerTicket","PerCoupon","PerDirectionOfTravel"],"x-enumDescriptions":{"OneWay":"Penalty applies for the one way journey.","RoundTrip":"Penalty applies for the round trip journey.","PerTicket":"Penalty applies per ticket. In case of LCC/ticketless applies per person per journey.","PerCoupon":"Penalty applies for each ticket coupon.","PerDirectionOfTravel":"Penalty applies per direction of travel."}}},"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/ChangeMethodEnum":{"id":"components/schemas/ChangeMethodEnum","kind":"json-schema","title":"ChangeMethodEnum","data":{"type":"string","description":"Ticket must be reissued, revalidated or both","enum":["Reissue","Revalidation","Both"],"x-enumDescriptions":{"Reissue":"Ticket must be reissued","Revalidation":"Ticket must be revalidated","Both":"Ticket May be reissued or revalidated"}}},"components/schemas/ResidualValuePenaltyEnum":{"id":"components/schemas/ResidualValuePenaltyEnum","kind":"json-schema","title":"ResidualValuePenaltyEnum","data":{"type":"string","description":"List of Residual Value Penalty types.","enum":["Ignore","Refund","Subtract","SubtractFromNonRefundable"],"x-enumDescriptions":{"Ignore":"Residual value is forfeited and not refunded","Refund":"Residual value will be refunded","Subtract":"Any residual value will be subtracted from the penalty amount due and any additional will be refunded to the original form of payment","SubtractFromNonRefundable":"Any residual value from a non refundable fare may be used to subtract from the penalty. Any additional residual value will be forfeited"}}},"components/schemas/PeriodBeforeDeparture":{"id":"components/schemas/PeriodBeforeDeparture","kind":"json-schema","title":"PeriodBeforeDeparture","data":{"properties":{"value":{"type":"integer","format":"int32","example":1},"period":{"$ref":"#/components/schemas/DurationUnitEnum"}},"description":"The first occurrence (if day of week) or the unit of time"}},"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/PenaltyException":{"id":"components/schemas/PenaltyException","kind":"json-schema","title":"PenaltyException","data":{"properties":{"value":{"type":"integer","format":"int32","example":1},"period":{"$ref":"#/components/schemas/DurationUnitEnum"},"appliesAfterReservationInd":{"type":"boolean","description":"If true, exception applies after reservation has been made"},"appliesAfterTicketingInd":{"type":"boolean","description":"If true, exception applies after ticketing"}},"description":"The first occurrence (if day of week) or the unit of time"}},"components/schemas/ChangeNotPermitted":{"id":"components/schemas/ChangeNotPermitted","kind":"json-schema","title":"ChangeNotPermitted","data":{"description":"No changes are permitted","allOf":[{"$ref":"#/components/schemas/Change"},{"properties":{"NotPermittedInd":{"type":"string","description":"Changes are not permitted","example":"true"},"penaltyTypes":{"type":"array","items":{"$ref":"#/components/schemas/PenaltyTypeEnum"}},"PeriodBeforeDeparture":{"$ref":"#/components/schemas/PeriodBeforeDeparture"},"taxesNonRefundableInd":{"type":"boolean","description":"If true, for non-refundable fares taxes are also non-refundable.","example":true}}}]}},"components/schemas/CancelIndeterminate":{"id":"components/schemas/CancelIndeterminate","kind":"json-schema","title":"CancelIndeterminate","data":{"description":"The cancel restrictions cannot be determined.","allOf":[{"$ref":"#/components/schemas/Cancel"},{"properties":{"IndeterminateInd":{"type":"string","description":"structured fare rules could not be determined for this category","example":"true"}}}]}},"components/schemas/CancelPermitted":{"id":"components/schemas/CancelPermitted","kind":"json-schema","title":"CancelPermitted","data":{"description":"Cancellation is permitted but may have restrictions","allOf":[{"$ref":"#/components/schemas/Cancel"},{"required":["penaltyTypes"],"properties":{"penaltyTypes":{"type":"array","items":{"$ref":"#/components/schemas/PenaltyTypeEnum"}},"PenaltyAppliesTo":{"$ref":"#/components/schemas/PenaltyAppliesToEnum"},"Penalty":{"maxItems":2,"type":"array","items":{"$ref":"#/components/schemas/Penalty"}},"higherPenatltyAppliesInd":{"type":"boolean","description":"If true, when an amount and a percent are specified in the Penalty then the higher of these apply","example":true},"MinimumAdcolAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"ChangeMethod":{"$ref":"#/components/schemas/ChangeMethodEnum"},"ResidualValuePenalty":{"$ref":"#/components/schemas/ResidualValuePenaltyEnum"},"PeriodBeforeDeparture":{"$ref":"#/components/schemas/PeriodBeforeDeparture"},"PenaltyException":{"$ref":"#/components/schemas/PenaltyException"}}}]}},"components/schemas/CancelNotPermitted":{"id":"components/schemas/CancelNotPermitted","kind":"json-schema","title":"CancelNotPermitted","data":{"description":"Cancel is not permitted","allOf":[{"$ref":"#/components/schemas/Cancel"},{"properties":{"NotPermittedInd":{"type":"string","description":"Cancel is not permitted","example":"true"},"penaltyTypes":{"type":"array","items":{"$ref":"#/components/schemas/PenaltyTypeEnum"}},"PeriodBeforeDeparture":{"$ref":"#/components/schemas/PeriodBeforeDeparture"},"taxesNonRefundableInd":{"type":"boolean","description":"if true, for non-refundable fares taxes are also non-refundable","example":true}}}]}},"components/schemas/BaggageAllowanceDetail":{"id":"components/schemas/BaggageAllowanceDetail","kind":"json-schema","title":"BaggageAllowanceDetail","data":{"description":"Details of the BaggageAllowance, baggage policy and prices as part of the terms and conditions.","allOf":[{"$ref":"#/components/schemas/BaggageAllowance"},{"properties":{"url":{"type":"string","description":"Link to additional baggage policy information.","example":"https://airline/baggage"}}}]}},"components/schemas/BuildOptionsFromProducts":{"id":"components/schemas/BuildOptionsFromProducts","kind":"json-schema","title":"BuildOptionsFromProducts","data":{"description":"Use the Flight Specific Search full payload request to return additional upsells for one or more flights. You must send all required flight details; a preceding Search or Next Leg Search is not required. You can request up to 99 upsells. GDS only, not supported for NDC. The request contains full itinerary details. If SpecificFlightCriteria/cabin or /classOfService is sent, those are ignored.","allOf":[{"$ref":"#/components/schemas/BuildOptions"},{"required":["BuildFromProductsRequest"],"properties":{"BuildFromProductsRequest":{"$ref":"#/components/schemas/BuildFromProductsRequest"},"sortBy":{"$ref":"#/components/schemas/SortByEnum"}}}]}},"components/schemas/ReferenceListFlight":{"id":"components/schemas/ReferenceListFlight","kind":"json-schema","title":"ReferenceListFlight","data":{"description":"Returns an array of Flight objects that match to the flights that make up a product. Air Search will return an array of FlightDetail","allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"required":["Flight"],"properties":{"Flight":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Flight"}}}}]}},"components/schemas/ReferenceListAmenity":{"id":"components/schemas/ReferenceListAmenity","kind":"json-schema","title":"ReferenceListAmenity","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If flight amenities were requested with includeFlightAmenitiesInd=true, the response returns ReferenceListAmenity to list all available amenities across all flights."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flight amenities are provided by ATPCO as RouteHappy data. ATPCO flight amenities do not support the Premium Business cabin. If the fare is in Premium Business, Travelport's system does not look for flight amenities. All other cabins are supported."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If flight amenity data is requested but not available, the Result object returns a warning message that flight amenity data is unavailable. This could be due to a time out or some other issue while accessing the flight amenities data."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"required":["Amenity"],"properties":{"Amenity":{"maxItems":1000,"minItems":1,"type":"array","description":"One instance for each specific amenity.","items":{"$ref":"#/components/schemas/Amenity"}}}}]}},"components/schemas/Amenity":{"id":"components/schemas/Amenity","kind":"json-schema","title":"Amenity","data":{"required":["@type","Category","id"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"Amenity"},"id":{"type":"string","description":"A unique Travelport-assigned amenity id used for cross-referencing by each flight with this amenity.","example":"amenity_001"},"Category":{"maxLength":128,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flight amenity categories may include the following data as provided by ATPCO."},"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":"Aircraft: cabin pressure, model and type."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Beverage: alcoholic and non-alcoholic beverages and whether available for a fee or free; highlights premium beverages in business/first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entertainment: passenger entertainment options."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flight: airline flight schedules and equipment types with the associated amenities ID for each carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Food: food per flight and flight cabin and whether available for a fee or free; food is classified as breakfast, lunch, dinner, snacks, and light meals, and as premium when available in business/first."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layout: seating layout such as classic layouts to premium cabin configurations."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Power: availability of AC power outlets, USB ports, or both."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seat: physical seat type for every sub fleet in every cabin of the aircraft, including legroom, pitch, width, flatness and type. Note that seat metrics are returned in centimeters because the default language is English."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WiFi: availability, type, coverage, rollout, performance, and whether available free or for a fee."},"children":[]}]}]}]}],"example":"Entertainment"},"Text":{"$ref":"#/components/schemas/AmenityText"}},"description":"Flight amenities are provided by ATPCO as RouteHappy data. ATPCO flight amenities do not support the Premium Business cabin. If the fare is in Premium Business, Travelport's system does not look for flight amenities. All other cabins are supported.   \nIf flight amenity data is requested but not available, the Result object returns a warning message that flight amenity data is unavailable. This could be due to a time out or some other issue while accessing the flight amenities data."}},"components/schemas/AmenityText":{"id":"components/schemas/AmenityText","kind":"json-schema","title":"AmenityText","data":{"properties":{"value":{"maxLength":512,"type":"string","description":"A short free text description."},"language":{"type":"string","description":"The language the text is provided in. ISO639 format.","example":"EN"}},"description":"A free text description of the amenity."}},"components/schemas/CalculatedFareAdjustmentDiscount":{"id":"components/schemas/CalculatedFareAdjustmentDiscount","kind":"json-schema","title":"CalculatedFareAdjustmentDiscount","data":{"description":"Used in Exchange Search to discount the Price of the Fare","allOf":[{"$ref":"#/components/schemas/CalculatedFareAdjustment"},{"properties":{"AmountPercent":{"$ref":"#/components/schemas/AmountPercent"}}}]}},"components/schemas/CalculatedFareAdjustmentIncrease":{"id":"components/schemas/CalculatedFareAdjustmentIncrease","kind":"json-schema","title":"CalculatedFareAdjustmentIncrease","data":{"description":"Used in Exchange Search to increase the Price of the Fare","allOf":[{"$ref":"#/components/schemas/CalculatedFareAdjustment"},{"required":["AmountPercent"],"properties":{"AmountPercent":{"$ref":"#/components/schemas/AmountPercent"}}}]}},"components/schemas/ManualFareAdjustmentIncrease":{"id":"components/schemas/ManualFareAdjustmentIncrease","kind":"json-schema","title":"ManualFareAdjustmentIncrease","data":{"description":"Send to manually increase the base fare amount on all fares by either an amount or a percentage. Send AmountPercentAmount to adjust the base fare by an amount. Amount may contain up to two decimal places. Send AmountPercentPercent to adjust the base fare by a percentage. Percent may contain up to two decimal places","allOf":[{"$ref":"#/components/schemas/ManualFareAdjustment"},{"required":["AmountPercent"],"properties":{"AmountPercent":{"$ref":"#/components/schemas/AmountPercent"}}}]}},"components/schemas/ManualFareAdjustmentDiscount":{"id":"components/schemas/ManualFareAdjustmentDiscount","kind":"json-schema","title":"ManualFareAdjustmentDiscount","data":{"description":"Send to manually discount the base fare amount on all fares by either an amount or a percentage. Send AmountPercentAmount to adjust the base fare by an amount. Amount may contain up to two decimal places. Send AmountPercentPercent to adjust the base fare by a percentage. Percent may contain up to two decimal places","allOf":[{"$ref":"#/components/schemas/ManualFareAdjustment"},{"required":["AmountPercent"],"properties":{"AmountPercent":{"$ref":"#/components/schemas/AmountPercent"}}}]}},"components/schemas/CancelAllOffers":{"id":"components/schemas/CancelAllOffers","kind":"json-schema","title":"CancelAllOffers","data":{"properties":{"retainSegmentsInd":{"type":"boolean","description":"If true, the offer price will be cancelled and the flights will remain active as unpriced segments."}},"description":"Cancel all offers within the workbench.","allOf":[{"$ref":"#/components/schemas/CancelOffers"}]}},"components/schemas/CancelSelectedOffers":{"id":"components/schemas/CancelSelectedOffers","kind":"json-schema","title":"CancelSelectedOffers","data":{"required":["offerProductSelection"],"properties":{"offerProductSelection":{"type":"array","items":{"$ref":"#/components/schemas/OfferProductSelection"}}},"description":"Cancel selected offers within the workbench.","allOf":[{"$ref":"#/components/schemas/CancelOffers"}]}},"components/schemas/OfferProductSelection":{"id":"components/schemas/OfferProductSelection","kind":"json-schema","title":"OfferProductSelection","data":{"required":["offerID"],"properties":{"sendPassiveNotificationInd":{"type":"boolean","description":"If true, any passive segments that are cancelled will be notified to the airline."},"retainSegmentsInd":{"type":"boolean","description":"If true, the offer price will be cancelled and the flights will remain active in the workbench as unpricedSegments."},"offerID":{"$ref":"#/components/schemas/OfferIdentifier"},"productSegmentSequenceArray":{"type":"array","items":{"$ref":"#/components/schemas/ProductSegmentSequence"}}},"description":"Cancel selected offer and/or product within the workbench."}},"components/schemas/ProductSegmentSequence":{"id":"components/schemas/ProductSegmentSequence","kind":"json-schema","title":"ProductSegmentSequence","data":{"required":["productID"],"properties":{"productID":{"$ref":"#/components/schemas/ProductIdentifier"},"segmentSequenceArray":{"type":"array","description":"The segmentSequence within the product the action is being requested for. Used when multiple in a product. If SegmentSequenceArray is null then all segments within the product will be actioned.","example":[1,2],"items":{"type":"integer","format":"int32"}}}}},"components/schemas/CancelAllUnpricedSegments":{"id":"components/schemas/CancelAllUnpricedSegments","kind":"json-schema","title":"CancelAllUnpricedSegments","data":{"description":"Cancel all unpriced segments within the workbench.","allOf":[{"$ref":"#/components/schemas/CancelUnpricedSegments"}]}},"components/schemas/CancelSelectedUnpricedSegments":{"id":"components/schemas/CancelSelectedUnpricedSegments","kind":"json-schema","title":"CancelSelectedUnpricedSegments","data":{"required":["flightSegmentSelection"],"properties":{"flightSegmentSelection":{"type":"array","items":{"$ref":"#/components/schemas/FlightSegmentSelection"}}},"description":"Cancel selected unpriced segments within the workbench.","allOf":[{"$ref":"#/components/schemas/CancelUnpricedSegments"}]}},"components/schemas/FlightSegmentSelection":{"id":"components/schemas/FlightSegmentSelection","kind":"json-schema","title":"FlightSegmentSelection","data":{"required":["unpricedFlightSegmentIDRefs"],"properties":{"sendPassiveNotificationInd":{"type":"boolean","description":"If true, any passive segments that are cancelled will be notified to the airline.","example":true},"unpricedFlightSegmentIDRefs":{"type":"array","description":"Select the UnpricedFlightSegment id from UnpricedSegments that you wish to cancel. This will cancel the full passenger quantity. To cancel less than the full passenger quantity divide the booking first.","example":["unpricedFlightSegment_01","unpricedFlightSegment_02"],"items":{"type":"string"}}},"description":"Select the unpriced flight segment to cancel."}},"components/schemas/CancelAllAuxiliarySegments":{"id":"components/schemas/CancelAllAuxiliarySegments","kind":"json-schema","title":"CancelAllAuxiliarySegments","data":{"description":"Cancel all auxiliary segments within the workbench.","allOf":[{"$ref":"#/components/schemas/CancelAuxiliarySegments"}]}},"components/schemas/CancelSelectedAuxiliarySegments":{"id":"components/schemas/CancelSelectedAuxiliarySegments","kind":"json-schema","title":"CancelSelectedAuxiliarySegments","data":{"required":["customAuxiliarySegmentID"],"properties":{"customAuxiliarySegmentID":{"type":"array","example":["customAuxiliarySegment_01","customAuxiliarySegment_02"],"items":{"type":"string"}}},"description":"Cancel selected auxiliary segments within the workbench.","allOf":[{"$ref":"#/components/schemas/CancelAuxiliarySegments"}]}},"components/schemas/ReferenceListProduct":{"id":"components/schemas/ReferenceListProduct","kind":"json-schema","title":"ReferenceListProduct","data":{"description":"Returned in Air Search API. List of products referenced in ProductBrandOffering. Includes the Product object. Air Search may return ProductAir or ProductAncillary child classes.","allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"Product":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}]}},"components/schemas/ReferenceListTraveler":{"id":"components/schemas/ReferenceListTraveler","kind":"json-schema","title":"ReferenceListTraveler","data":{"allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"Traveler":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Traveler"}}}}]}},"components/schemas/ReferenceListOffer":{"id":"components/schemas/ReferenceListOffer","kind":"json-schema","title":"ReferenceListOffer","data":{"allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"Offer":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}}}}]}},"components/schemas/ReferenceListBrand":{"id":"components/schemas/ReferenceListBrand","kind":"json-schema","title":"ReferenceListBrand","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns an array of Brand objects that match to brand ids returned in the response payload."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReferenceList Brand is used in the Air Search, Air Price, and Reservation Response."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search returns branded fares by default when available. For more about brands see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.travelport.com/docs/flights/guides/flights-search-guide#branded-fares-and-upsells"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Branded Fares and Upsells"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the developer documentation."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AirPrice Reference Payload request returns branded fares by default when available, and supports suppressing the return of brand attributes by sending inhibitBrandContentInd=true."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AirPrice Full Payload request does not return branded fares unless they are requested with returnBrandedFaresInd=true. If branded fares are not returned, ReferenceListBrand is not returned."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"Brand":{"type":"array","description":"Each instance provides details for one BrandRef id.","items":{"$ref":"#/components/schemas/Brand"}}}}]}},"components/schemas/ReferenceListTermsAndConditions":{"id":"components/schemas/ReferenceListTermsAndConditions","kind":"json-schema","title":"ReferenceListTermsAndConditions","data":{"description":"Returns terms and conditions details for sets of terms and conditions referenced in offers. Air Search may return TermsAndConditionsAir or TermsAndConditionsAncillary or TermsAndConditionsAncillaryAir. Each instance is one set of terms and conditions applicable to any ProductBrandOffering with this id.","allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"TermsAndConditions":{"type":"array","items":{"$ref":"#/components/schemas/TermsAndConditions"}}}}]}},"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/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/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/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/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/ModifyPriceDetail":{"id":"components/schemas/ModifyPriceDetail","kind":"json-schema","title":"ModifyPriceDetail","data":{"description":"The extended class of Modify Price.","allOf":[{"$ref":"#/components/schemas/ModifyPrice"},{"properties":{"PriceBreakdown":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/ModifyPrice":{"id":"components/schemas/ModifyPrice","kind":"json-schema","title":"ModifyPrice","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ModifyPrice or ModifyPriceDetail","example":"ModifyPriceDetail"},"id":{"type":"string","description":"Internally referenced id","example":"2"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount not including taxes and/or fees"},"children":[]}]}]}],"format":"float","example":20.2},"TotalTaxes":{"type":"number","description":"The total of the taxes included in the total price","format":"float","example":34.4},"TotalFees":{"type":"number","description":"The total of the fees included in the total price","format":"float","example":201},"TotalPrice":{"type":"number","description":"The total price of the product in the currency indicated","format":"float","example":34},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"discriminator":{"propertyName":"@type"}}},"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/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/ReferenceListExchangedPrice":{"id":"components/schemas/ReferenceListExchangedPrice","kind":"json-schema","title":"ReferenceListExchangedPrice","data":{"description":"ReferenceList is used to reduce the size of the payload when multiple occurrences of the same object appear in the response. This is used in the TripChange responses to expose the original Price information","allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"required":["Price"],"properties":{"Price":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Price"}}}}]}},"components/schemas/TextBlockDetail":{"id":"components/schemas/TextBlockDetail","kind":"json-schema","title":"TextBlockDetail","data":{"description":"The extended class of Text Block.","allOf":[{"$ref":"#/components/schemas/TextBlock"},{"required":["DateCreateModify"],"properties":{"sequence":{"type":"integer","description":"The order of the text block, if there are more than one block.","format":"int32","example":2},"description":{"maxLength":1024,"type":"string","description":"Text block detail description","example":"description"},"Image":{"$ref":"#/components/schemas/Image"},"URL":{"type":"string","description":"A URL for this block"},"DateCreateModify":{"$ref":"#/components/schemas/DateCreateModify"}}}]}},"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.","discriminator":{"propertyName":"@type"}}},"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/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/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/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/DateCreateModify":{"id":"components/schemas/DateCreateModify","kind":"json-schema","title":"DateCreateModify","data":{"properties":{"value":{"type":"string","format":"date-time","example":"2026-03-04T11:22:00Z"},"creatorID":{"maxLength":32,"type":"string","description":"ID of creator. Software system identifier or an employee id","example":"c1234563"},"lastModify":{"type":"string","description":"Time stamp of last modification.","format":"date-time","example":"2026-03-04T11:24:00Z"},"lastModifierID":{"maxLength":32,"type":"string","description":"Identifies the last software system or person to modify a record","example":"m346789"},"purge":{"type":"string","description":"Date an item will be purged from a system of record","format":"date","example":"2026-03-03"}},"description":"Time stamp of the creation."}},"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/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/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/BuildOptionsFromCatalogProductOptions":{"id":"components/schemas/BuildOptionsFromCatalogProductOptions","kind":"json-schema","title":"BuildOptionsFromCatalogProductOptions","data":{"description":"Reference payload for flight specific search. Send the transaction identifiers from the Search or Next Leg Search response. The Search response does not return the CatalogProductOfferings/Identifier object if caching is not invoked with offersPerPage in the Search request. A subsequent reference payload request to those search results cannot be sent without caching and the CatalogProductOfferings/Identifier value.","allOf":[{"$ref":"#/components/schemas/BuildOptions"},{"required":["BuildFromCatalogProductOfferingsRequest"],"properties":{"BuildFromCatalogProductOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"}}}]}},"components/schemas/AncillaryAir":{"id":"components/schemas/AncillaryAir","kind":"json-schema","title":"AncillaryAir","data":{"description":"A type of Ancillary contains both paid (e.g., lounge access, priority boarding, paid seat assignments) and free ancillaries (e.g., wheelchair, free seat assignments).","allOf":[{"$ref":"#/components/schemas/Ancillary"},{"properties":{"FlightRef":{"type":"array","description":"The list of travel segments the ancillary applies to","items":{"type":"string"}}}}]}},"components/schemas/Ancillary":{"id":"components/schemas/Ancillary","kind":"json-schema","title":"Ancillary","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Ancillary, AncillaryAir, AncillaryAirBaggage, and AncillaryAirSeat","example":"AncillaryAir"},"quantity":{"type":"integer","description":"The quantity value","format":"int32"},"Description":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/AncillaryDescription"}},"Comments":{"$ref":"#/components/schemas/Comments"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/AncillaryDescription":{"id":"components/schemas/AncillaryDescription","kind":"json-schema","title":"AncillaryDescription","data":{"properties":{"value":{"maxLength":512,"type":"string","description":"The text description of the ancillary.","example":"Vegetarian Meal"},"code":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"The ATPCO group code.","example":"BG"},"subCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"The ATPCO RFISC subcode.","example":"0D4"},"subGroup":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"The ATPCO sub group code.","example":"SP"},"codeContext":{"maxLength":32,"type":"string","description":"The code context value.","example":"ATPCO"},"ssrCode":{"maxLength":4,"type":"string","description":"The four character AIRIMP SSR code for this ancillary.","example":"VGML"},"issuanceReasonCode":{"maxLength":32,"type":"string","description":"The airline provided reason for issuance code.","example":"C"},"geographicSpecification":{"$ref":"#/components/schemas/AncillaryGeographicSpecificationEnum"}},"description":"A description of the ancillary with description codes."}},"components/schemas/AncillaryGeographicSpecificationEnum":{"id":"components/schemas/AncillaryGeographicSpecificationEnum","kind":"json-schema","title":"AncillaryGeographicSpecificationEnum","data":{"type":"string","description":"How the ancillary is applied across the itinerary.","example":"Journey","enum":["Sector","Portion","Journey"]}},"components/schemas/AncillaryAirBaggage":{"id":"components/schemas/AncillaryAirBaggage","kind":"json-schema","title":"AncillaryAirBaggage","data":{"description":"A type of Ancillary used for paid baggage.","allOf":[{"$ref":"#/components/schemas/AncillaryAir"},{"required":["BaggageType","Measurement"],"properties":{"BaggageType":{"$ref":"#/components/schemas/BaggageTypeEnum"},"Measurement":{"maxItems":6,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Measurement"}},"soldByPieceInd":{"type":"boolean","description":"If true, the ancillary bag is sold per piece."},"soldByWeightInd":{"type":"boolean","description":"If true, the ancillary bag is sold by weight."}}}]}},"components/schemas/PriceBreakdownAncillaryAir":{"id":"components/schemas/PriceBreakdownAncillaryAir","kind":"json-schema","title":"PriceBreakdownAncillaryAir","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains a detailed breakdown of the Price provided for each PTC or each Traveler."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If NDC bundled offers were requested in the Search request by sending includeBundledAncillariesInd, for any NDC bundled offers, PriceBreakdown returns an instance with the @type PriceBreakdownAncillaryAir to define the included ancillary and pricing."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NDC only; bundled offers not supported for GDS."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/PriceBreakdownAncillary"},{"properties":{"PassengerTypeCode":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","description":"The passenger type code the ancillary is valid for","example":"ADT"},"approximateInd":{"type":"boolean","description":"Used to indicate that the Price is approximate. Often used to allow for currency fluctuations when supplier currency is different to agency currency."}}}]}},"components/schemas/PriceBreakdownAncillary":{"id":"components/schemas/PriceBreakdownAncillary","kind":"json-schema","title":"PriceBreakdownAncillary","data":{"description":"Detailed price information for this ancillary offer broken down by passenger type.","allOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"properties":{"inclusiveOfTaxInd":{"type":"boolean","description":"If true, this ancillary is sold inclusive of tax.","example":true},"quantity":{"type":"integer","description":"The quantity of ancillary items included in this PriceBreakdown.","format":"int32","example":1},"Description":{"$ref":"#/components/schemas/AncillaryDescription"},"ProductRef":{"type":"string","description":"The product ref this PriceBreakdown applies to. If no productRef exists then the PriceBreakdown applies to all Products within the Offer.","example":"p_1"},"Discount":{"$ref":"#/components/schemas/Discount"},"TravelerIdentifierRef":{"$ref":"#/components/schemas/TravelerIdentifierRef"},"AncillaryPriceApplicationCode":{"$ref":"#/components/schemas/AncillaryPriceApplicationCode"}}}]}},"components/schemas/AncillaryPriceApplicationCode":{"id":"components/schemas/AncillaryPriceApplicationCode","kind":"json-schema","title":"AncillaryPriceApplicationCode","data":{"properties":{"value":{"maxLength":2,"type":"string","example":"3"},"application":{"maxLength":32,"type":"string","description":"Associated text.","example":"PerItem"}},"description":"Determines how an ancillary price has been built."}},"components/schemas/TermsAndConditionsAirChange":{"id":"components/schemas/TermsAndConditionsAirChange","kind":"json-schema","title":"TermsAndConditionsAirChange","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditionsAir"},{"properties":{"FulfillmentMethod":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/FulfillmentMethod"}}}}]}},"components/schemas/FulfillmentMethod":{"id":"components/schemas/FulfillmentMethod","kind":"json-schema","title":"FulfillmentMethod","data":{"properties":{"@type":{"type":"string","example":"FulfillmentMethod"},"productRefs":{"type":"array","description":"The product(s) the Fulfillment Method applies to. If blank applies to all products in the Offer","example":["p1","p2"],"items":{"type":"string"}},"segmentSequenceList":{"type":"array","description":"List of segment sequence","example":[234,518,9023],"items":{"type":"integer","format":"int32"}},"RefundMethod":{"$ref":"#/components/schemas/RefundMethodEnum"},"ChangeFeeCollectionMethod":{"$ref":"#/components/schemas/ChangeFeeCollectionMethod"}}}},"components/schemas/RefundMethodEnum":{"id":"components/schemas/RefundMethodEnum","kind":"json-schema","title":"RefundMethodEnum","data":{"properties":{"value":{"$ref":"#/components/schemas/RefundMethodEnum_Base"}},"example":"MCO"}},"components/schemas/RefundMethodEnum_Base":{"id":"components/schemas/RefundMethodEnum_Base","kind":"json-schema","title":"RefundMethodEnum_Base","data":{"type":"string","example":"MCO","enum":["RefundToOriginalFOP","EMD","MCO","Unknown"]}},"components/schemas/ProductCriteriaAirDetail":{"id":"components/schemas/ProductCriteriaAirDetail","kind":"json-schema","title":"ProductCriteriaAirDetail","data":{"description":"The extended class of Product Criteria Air.","allOf":[{"$ref":"#/components/schemas/ProductCriteriaAir"},{"properties":{"ReplaceFlightCriteria":{"$ref":"#/components/schemas/ReplaceFlightCriteria"}}}]}},"components/schemas/ReplaceFlightCriteria":{"id":"components/schemas/ReplaceFlightCriteria","kind":"json-schema","title":"ReplaceFlightCriteria","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class ReplaceFlightCriteria only"},"Flight":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/FlightID"}}}}},"components/schemas/PassengerCriteriaAirChange":{"id":"components/schemas/PassengerCriteriaAirChange","kind":"json-schema","title":"PassengerCriteriaAirChange","data":{"allOf":[{"$ref":"#/components/schemas/PassengerCriteria"},{"required":["TravelerIdentifierRef"],"properties":{"TravelerIdentifierRef":{"$ref":"#/components/schemas/TravelerIdentifierRef"}}}]}},"components/schemas/CatalogOfferingModify":{"id":"components/schemas/CatalogOfferingModify","kind":"json-schema","title":"CatalogOfferingModify","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOffering"},{"required":["ModifyPrice"],"properties":{"isNetted":{"$ref":"#/components/schemas/AllSomeNoneEnum"},"ModifyPrice":{"$ref":"#/components/schemas/ModifyPrice"},"SupplierRetainedPrice":{"$ref":"#/components/schemas/SupplierRetainedPriceDetail"},"ResidualPrice":{"$ref":"#/components/schemas/ResidualPriceDetail"},"AdditionalCollectionPrice":{"$ref":"#/components/schemas/AdditionalCollectionPriceDetail"}}}]}},"components/schemas/SupplierRetainedPriceDetail":{"id":"components/schemas/SupplierRetainedPriceDetail","kind":"json-schema","title":"SupplierRetainedPriceDetail","data":{"description":"The amount that is retained by the supplier and not refundable.","allOf":[{"$ref":"#/components/schemas/SupplierRetainedPrice"},{"properties":{"FlightPassCredits":{"type":"integer","description":"The total number of flight pass credits consumed for this offer.","format":"int32","example":2},"PriceBreakdown":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/SupplierRetainedPrice":{"id":"components/schemas/SupplierRetainedPrice","kind":"json-schema","title":"SupplierRetainedPrice","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"SupplierRetainedPriceDetail"},"id":{"type":"string","description":"Internally referenced id"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount not including taxes and/or fees"},"children":[]}]}]}],"format":"float"},"TotalTaxes":{"type":"number","description":"The total of the taxes included in the total price","format":"float"},"TotalFees":{"type":"number","description":"The total of the fees included in the total price","format":"float"},"TotalPrice":{"type":"number","description":"The total price of the product in the currency indicated","format":"float"},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"description":"The amount that is retained by the supplier and not refundable.","discriminator":{"propertyName":"@type"}}},"components/schemas/ResidualPriceDetail":{"id":"components/schemas/ResidualPriceDetail","kind":"json-schema","title":"ResidualPriceDetail","data":{"description":"The Residual amount that will be refunded separately for this transaction.","allOf":[{"$ref":"#/components/schemas/ResidualPrice"},{"properties":{"PriceBreakdown":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/ResidualPrice":{"id":"components/schemas/ResidualPrice","kind":"json-schema","title":"ResidualPrice","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"ResidualPriceDetail"},"id":{"type":"string","description":"Internally referenced id"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"The total amount not including taxes and/or fees","format":"float","example":12.2},"TotalTaxes":{"type":"number","description":"The total of the taxes included in the total price","format":"float","example":24},"TotalFees":{"type":"number","description":"The total of the fees included in the total price","format":"float","example":10.5},"TotalPrice":{"type":"number","description":"The total price of the product in the currency indicated","format":"float","example":34.7},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"description":"The Residual amount that will be refunded separately for this transaction.","discriminator":{"propertyName":"@type"}}},"components/schemas/AdditionalCollectionPriceDetail":{"id":"components/schemas/AdditionalCollectionPriceDetail","kind":"json-schema","title":"AdditionalCollectionPriceDetail","data":{"description":"The Additional Collection amount for this transaction.","allOf":[{"$ref":"#/components/schemas/AdditionalCollectionPrice"},{"properties":{"PriceBreakdown":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/AdditionalCollectionPrice":{"id":"components/schemas/AdditionalCollectionPrice","kind":"json-schema","title":"AdditionalCollectionPrice","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"AdditionalCollectionPrice"},"id":{"type":"string","description":"Internally referenced id","example":"adcolPrice_1"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":"The total amount not including taxes and/or fees","format":"float"},"TotalTaxes":{"type":"number","description":"The total of the taxes included in the total price","format":"float"},"TotalFees":{"type":"number","description":"The total of the fees included in the total price","format":"float"},"TotalPrice":{"type":"number","description":"The total price of the product in the currency indicated","format":"float"},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"description":"The Additional Collection amount for this transaction.","discriminator":{"propertyName":"@type"}}},"components/schemas/BuildFromCatalogOfferingsRequestAirChange":{"id":"components/schemas/BuildFromCatalogOfferingsRequestAirChange","kind":"json-schema","title":"BuildFromCatalogOfferingsRequestAirChange","data":{"description":"reference path payload used to build an Offer","allOf":[{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"},{"required":["PricingModifiersAirChange"],"properties":{"PricingModifiersAirChange":{"$ref":"#/components/schemas/PricingModifiersAirChange"}}}]}},"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/TermsAndConditionsAncillary":{"id":"components/schemas/TermsAndConditionsAncillary","kind":"json-schema","title":"TermsAndConditionsAncillary","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditions"},{"properties":{"ApplicationLimit":{"$ref":"#/components/schemas/ApplicationLimit"},"Refundability":{"$ref":"#/components/schemas/RefundabilityEnum"},"validatingAirline":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"Represents the airline responsible for ticketing/fulfillment of this Offer.","example":"AA"},"fulfillmentType":{"$ref":"#/components/schemas/EMDFulfillmentTypeEnum"},"associatedItem":{"$ref":"#/components/schemas/EMDAssociationEnum"},"unsellableInd":{"type":"boolean","description":"If true, this ancillary product can not be sold through Travelport systems."},"instantPurchaseInd":{"type":"boolean","description":"If true, the Offer/Offering must be paid for at the same time as creating the Reservation."}}}]}},"components/schemas/ApplicationLimit":{"id":"components/schemas/ApplicationLimit","kind":"json-schema","title":"ApplicationLimit","data":{"properties":{"value":{"$ref":"#/components/schemas/ApplicableLevelEnum"},"start":{"maxLength":32,"type":"string","description":"The start value","example":"45"},"end":{"maxLength":32,"type":"string","description":"The end value","example":"67"}},"description":"Exposes any limitation on the amount of ancillaries available for purchase. Example, start 1 end 3 ApplicableLevel Passenger would mean a minumum of 1 and maximum of 3 ancillary items may be purchased."}},"components/schemas/ApplicableLevelEnum":{"id":"components/schemas/ApplicableLevelEnum","kind":"json-schema","title":"ApplicableLevelEnum","data":{"type":"string","description":"The application of the ancillary","enum":["PassengerSegment","Segment","Itinerary","Passengers","PassengerOD","Other"]}},"components/schemas/RefundabilityEnum":{"id":"components/schemas/RefundabilityEnum","kind":"json-schema","title":"RefundabilityEnum","data":{"properties":{"value":{"$ref":"#/components/schemas/RefundabilityEnum_Base"}},"description":"Describes the refundability of an Offer"}},"components/schemas/RefundabilityEnum_Base":{"id":"components/schemas/RefundabilityEnum_Base","kind":"json-schema","title":"RefundabilityEnum_Base","data":{"type":"string","description":"Describes the refundability of an Offer","enum":["Refundable","NonRefundable","Reusable"]}},"components/schemas/EMDFulfillmentTypeEnum":{"id":"components/schemas/EMDFulfillmentTypeEnum","kind":"json-schema","title":"EMDFulfillmentTypeEnum","data":{"type":"string","description":"The EMD fulfillment types","example":"EMD-S Standalone","enum":["EMD-S Standalone","EMD-A Associated","EMD-S Referenced","Other"],"x-enumDescriptions":{"EMD-S Standalone":"The EMD fulfillment must be a standalone EMD.","EMD-A Associated":"The EMD fulfillment must be by EMD-A, associated to a flight coupon of a ticket.","EMD-S Referenced":"The EMD fulfillment must be by standalone EMD which references a ticket number but not associated to a flight coupon of a ticket.","Other":"Fulfillment method is by other than EMD."}}},"components/schemas/EMDAssociationEnum":{"id":"components/schemas/EMDAssociationEnum","kind":"json-schema","title":"EMDAssociationEnum","data":{"type":"string","description":"The EMD Association types","example":"Flight","enum":["Flight","BaggageCharges"],"x-enumDescriptions":{"Flight":"The EMD is associated to a flight.","BaggageCharges":"The EMD is associated to baggage charges."}}},"components/schemas/ProductAncillary":{"id":"components/schemas/ProductAncillary","kind":"json-schema","title":"ProductAncillary","data":{"allOf":[{"$ref":"#/components/schemas/Product"},{"properties":{"Ancillary":{"$ref":"#/components/schemas/Ancillary"},"selectedByDefaultInd":{"type":"boolean"},"bundledInd":{"type":"boolean","description":"If true, this product is the lead ancillary bundle and is followed by a list of individual ancillary products."}}}]}},"components/schemas/AncillaryOfferingsBuildFromOfferList":{"id":"components/schemas/AncillaryOfferingsBuildFromOfferList","kind":"json-schema","title":"AncillaryOfferingsBuildFromOfferList","data":{"allOf":[{"$ref":"#/components/schemas/AncillaryOfferings"},{"properties":{"BuildFromOfferList":{"$ref":"#/components/schemas/BuildFromOfferList"}}}]}},"components/schemas/AncillaryOfferingsBuildFromCatalogOfferings":{"id":"components/schemas/AncillaryOfferingsBuildFromCatalogOfferings","kind":"json-schema","title":"AncillaryOfferingsBuildFromCatalogOfferings","data":{"allOf":[{"$ref":"#/components/schemas/AncillaryOfferings"},{"required":["BuildFromCatalogOfferingsRequest"],"properties":{"BuildFromCatalogOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"}}}]}},"components/schemas/AncillaryOfferingsBuildFromCatalogProductOfferings":{"id":"components/schemas/AncillaryOfferingsBuildFromCatalogProductOfferings","kind":"json-schema","title":"AncillaryOfferingsBuildFromCatalogProductOfferings","data":{"allOf":[{"$ref":"#/components/schemas/AncillaryOfferings"},{"required":["BuildFromCatalogProductOfferingsRequest"],"properties":{"BuildFromCatalogProductOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"}}}]}},"components/schemas/AncillaryOfferingsBuildFromReservationWorkbench":{"id":"components/schemas/AncillaryOfferingsBuildFromReservationWorkbench","kind":"json-schema","title":"AncillaryOfferingsBuildFromReservationWorkbench","data":{"allOf":[{"$ref":"#/components/schemas/AncillaryOfferings"},{"properties":{"BuildFromReservationWorkbench":{"$ref":"#/components/schemas/BuildFromReservationWorkbench"}}}]}},"components/schemas/SeatAvailabilityOfferingsBuildFromOfferList":{"id":"components/schemas/SeatAvailabilityOfferingsBuildFromOfferList","kind":"json-schema","title":"SeatAvailabilityOfferingsBuildFromOfferList","data":{"allOf":[{"$ref":"#/components/schemas/SeatAvailabilityOfferings"},{"properties":{"BuildFromOfferList":{"$ref":"#/components/schemas/BuildFromOfferList"}}}]}},"components/schemas/SeatAvailabilityOfferingsBuildFromCatalogOfferings":{"id":"components/schemas/SeatAvailabilityOfferingsBuildFromCatalogOfferings","kind":"json-schema","title":"SeatAvailabilityOfferingsBuildFromCatalogOfferings","data":{"allOf":[{"$ref":"#/components/schemas/SeatAvailabilityOfferings"},{"required":["BuildFromCatalogOfferingsRequest"],"properties":{"BuildFromCatalogOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"}}}]}},"components/schemas/SeatAvailabilityOfferingsBuildFromCatalogProductOfferings":{"id":"components/schemas/SeatAvailabilityOfferingsBuildFromCatalogProductOfferings","kind":"json-schema","title":"SeatAvailabilityOfferingsBuildFromCatalogProductOfferings","data":{"allOf":[{"$ref":"#/components/schemas/SeatAvailabilityOfferings"},{"required":["BuildFromCatalogProductOfferingsRequest"],"properties":{"BuildFromCatalogProductOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"}}}]}},"components/schemas/SeatAvailabilityOfferingsBuildFromProducts":{"id":"components/schemas/SeatAvailabilityOfferingsBuildFromProducts","kind":"json-schema","title":"SeatAvailabilityOfferingsBuildFromProducts","data":{"allOf":[{"$ref":"#/components/schemas/SeatAvailabilityOfferings"},{"required":["ProductCriteriaAir"],"properties":{"ProductCriteriaAir":{"$ref":"#/components/schemas/ProductCriteriaAir"}}}]}},"components/schemas/CatalogOfferingsTravelerFlight":{"id":"components/schemas/CatalogOfferingsTravelerFlight","kind":"json-schema","title":"CatalogOfferingsTravelerFlight","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOfferingsTraveler"},{"required":["Flight"],"properties":{"Flight":{"maxItems":5,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/FlightID"}}}}]}},"components/schemas/CatalogOfferingsTraveler":{"id":"components/schemas/CatalogOfferingsTraveler","kind":"json-schema","title":"CatalogOfferingsTraveler","data":{"allOf":[{"$ref":"#/components/schemas/CatalogOfferings"},{"required":["TravelerIdentifierRef"],"properties":{"TravelerIdentifierRef":{"maxItems":9,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TravelerIdentifierRef"}},"HeldAncillary":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/HeldAncillary"}}}}]}},"components/schemas/HeldAncillary":{"id":"components/schemas/HeldAncillary","kind":"json-schema","title":"HeldAncillary","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class HeldAncillary only","example":"HeldAncillary"},"Ancillary":{"$ref":"#/components/schemas/Ancillary"},"travelerRef":{"type":"string","example":"Trav_1"}}}},"components/schemas/ProductSeatAvailability":{"id":"components/schemas/ProductSeatAvailability","kind":"json-schema","title":"ProductSeatAvailability","data":{"description":"The availability of the product seat.","allOf":[{"$ref":"#/components/schemas/Product"},{"required":["SeatAvailability"],"properties":{"SeatAvailability":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/SeatAvailability"}},"Brand":{"$ref":"#/components/schemas/BrandID"},"SeatingChartRef":{"type":"string","description":"The reference id of the SeatingChart in the reference list"}}}]}},"components/schemas/SeatAvailability":{"id":"components/schemas/SeatAvailability","kind":"json-schema","title":"SeatAvailability","data":{"properties":{"value":{"type":"array","items":{"maxLength":32,"type":"string"}},"seatAvailabilityStatus":{"$ref":"#/components/schemas/SeatAvailability_Enum"},"codeContext":{"maxLength":32,"type":"string","description":"The code context value","example":"ATPCO"},"paidSeatInd":{"type":"boolean","description":"If true, the seat is a paid ancillary seat. This seat may be zero value due to traveler specific conditions"}},"description":"The row, seat, and availability of the seat."}},"components/schemas/SeatAvailability_Enum":{"id":"components/schemas/SeatAvailability_Enum","kind":"json-schema","title":"SeatAvailability_Enum","data":{"type":"string","description":"The list of availabile statuses of the seat for a traveler.","enum":["Available","Blocked","Reserved","Unavailable","Requested","NoSeat","Pending"]}},"components/schemas/AncillaryAirSeat":{"id":"components/schemas/AncillaryAirSeat","kind":"json-schema","title":"AncillaryAirSeat","data":{"allOf":[{"$ref":"#/components/schemas/AncillaryAir"},{"required":["SeatAssignment"],"properties":{"SeatAssignment":{"$ref":"#/components/schemas/SeatAssignment"}}}]}},"components/schemas/SeatAssignment":{"id":"components/schemas/SeatAssignment","kind":"json-schema","title":"SeatAssignment","data":{"required":["Characteristic","Seat"],"properties":{"@type":{"type":"string","example":"SeatAssignment"},"Seat":{"maxLength":32,"type":"string","description":"Seat"},"Characteristic":{"maxItems":100,"minItems":1,"type":"array","items":{"maxLength":1024,"type":"string"}},"SeatFeature":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/SpaceFeature"}}},"description":"Top-level object for current seat assignment."}},"components/schemas/SpaceFeature":{"id":"components/schemas/SpaceFeature","kind":"json-schema","title":"SpaceFeature","data":{"properties":{"value":{"maxLength":1024,"type":"string"},"context":{"maxLength":32,"type":"string","description":"The source of the code","example":"IATA"},"seatType":{"maxLength":32,"type":"string","description":"The type of object that occupies the space","example":"seat"},"description":{"maxLength":1024,"type":"string","description":"The description of the space feature"},"power":{"maxLength":32,"type":"string","description":"The type of power provided, if any"},"video":{"maxLength":32,"type":"string","description":"The type of video provided, if any"},"rating":{"maxLength":32,"type":"string","description":"The seat guru rating of the seat"}},"description":"Descriptive information about the seat."}},"components/schemas/SeatAvailabilityOfferingsBuildFromReservationWorkbench":{"id":"components/schemas/SeatAvailabilityOfferingsBuildFromReservationWorkbench","kind":"json-schema","title":"SeatAvailabilityOfferingsBuildFromReservationWorkbench","data":{"allOf":[{"$ref":"#/components/schemas/SeatAvailabilityOfferings"},{"required":["BuildFromReservationWorkbench"],"properties":{"BuildFromReservationWorkbench":{"$ref":"#/components/schemas/BuildFromReservationWorkbench"}}}]}},"components/schemas/OfferAncillaryModify":{"id":"components/schemas/OfferAncillaryModify","kind":"json-schema","title":"OfferAncillaryModify","data":{"allOf":[{"$ref":"#/components/schemas/Offer"},{"properties":{"ModifyPrice":{"$ref":"#/components/schemas/ModifyPrice"}}}]}},"components/schemas/SeatingChart":{"id":"components/schemas/SeatingChart","kind":"json-schema","title":"SeatingChart","data":{"description":"One instance of SeatingChart is returned for each flight requested.","allOf":[{"$ref":"#/components/schemas/SeatingChartID"},{"required":["Cabin"],"properties":{"Cabin":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Cabin"}}}}]}},"components/schemas/SeatingChartID":{"id":"components/schemas/SeatingChartID","kind":"json-schema","title":"SeatingChartID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"SeatingChart"},"id":{"type":"string","description":"Internally reference id"}},"description":"Discriminator classes SeatingChartID or SeatingChart","discriminator":{"propertyName":"@type"}}},"components/schemas/Cabin":{"id":"components/schemas/Cabin","kind":"json-schema","title":"Cabin","data":{"required":["Layout","Row","name"],"properties":{"@type":{"type":"string","example":"Cabin"},"name":{"maxLength":128,"type":"string","description":"The name of the cabin","example":"Economy"},"Layout":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/CabinLayout"}},"Row":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Row"}}},"description":"Cabin class."}},"components/schemas/CabinLayout":{"id":"components/schemas/CabinLayout","kind":"json-schema","title":"CabinLayout","data":{"required":["endRow","position","startRow"],"properties":{"value":{"maxLength":1,"type":"string"},"position":{"type":"array","items":{"$ref":"#/components/schemas/SeatPositionEnum"}},"startRow":{"type":"integer","description":"Start row for this Cabin Layout","format":"int32"},"endRow":{"type":"integer","description":"End row for this Cabin Layout","format":"int32"}},"description":"One character to represent the seat column position, (A, B, C)"}},"components/schemas/SeatPositionEnum":{"id":"components/schemas/SeatPositionEnum","kind":"json-schema","title":"SeatPositionEnum","data":{"type":"string","description":"Seat position PADIS codes","enum":["W","C","A","WA","U","L","M"]}},"components/schemas/Row":{"id":"components/schemas/Row","kind":"json-schema","title":"Row","data":{"required":["Space"],"properties":{"@type":{"type":"string","example":"Row"},"label":{"maxLength":32,"type":"string","description":"The identifier for the row","example":"78"},"Space":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/Seat"}},"Characteristic":{"maxItems":1000,"type":"array","items":{"maxLength":32,"type":"string"}}},"description":"One instance for each row in this cabin class; returns details for each seat in that row."}},"components/schemas/Seat":{"id":"components/schemas/Seat","kind":"json-schema","title":"Seat","data":{"required":["SeatFeature"],"properties":{"@type":{"type":"string","example":"Seat"},"location":{"maxLength":32,"type":"string","description":"The seat location","example":"10A"},"seatType":{"maxLength":32,"type":"string","description":"The type of seat. Code used for LCC seat types.","example":"SA/123456"},"Characteristic":{"maxItems":100,"type":"array","items":{"maxLength":1024,"type":"string"}},"SeatFeature":{"$ref":"#/components/schemas/SpaceFeature"}},"description":"Current seat assignment value including row and seat number."}},"components/schemas/TermsAndConditionsFullAncillary":{"id":"components/schemas/TermsAndConditionsFullAncillary","kind":"json-schema","title":"TermsAndConditionsFullAncillary","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFull"},{"properties":{"ApplicationLimit":{"$ref":"#/components/schemas/ApplicationLimit"},"Refundability":{"$ref":"#/components/schemas/RefundabilityEnum"},"validatingAirline":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"Represents the airline responsible for ticketing/fulfillment of this Offer.","example":"AA"},"fulfillmentType":{"$ref":"#/components/schemas/EMDFulfillmentTypeEnum"},"associatedItem":{"$ref":"#/components/schemas/EMDAssociationEnum"},"unsellableInd":{"type":"boolean","description":"If true, this ancillary product can not be sold through Travelport systems."},"instantPurchaseInd":{"type":"boolean","description":"If true, the Offer/Offering must be paid for at the same time as creating the Reservation."}}}]}},"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/TermsAndConditionsFullSummary":{"id":"components/schemas/TermsAndConditionsFullSummary","kind":"json-schema","title":"TermsAndConditionsFullSummary","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFullID"},{"properties":{"ExpiryDate":{"type":"string","description":"The data and time the offer will expire","format":"date-time","example":"2022-08-07T12:12:00Z"},"CustomerLoyalty":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/CustomerLoyalty"}},"TextBlock":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/TextBlock"}}}}]}},"components/schemas/AncillaryOfferingsBuildFromOffer":{"id":"components/schemas/AncillaryOfferingsBuildFromOffer","kind":"json-schema","title":"AncillaryOfferingsBuildFromOffer","data":{"allOf":[{"$ref":"#/components/schemas/AncillaryOfferings"},{"required":["BuildFromOffer"],"properties":{"BuildFromOffer":{"$ref":"#/components/schemas/BuildFromOffer"}}}]}},"components/schemas/FareRuleStructured":{"id":"components/schemas/FareRuleStructured","kind":"json-schema","title":"FareRuleStructured","data":{"allOf":[{"$ref":"#/components/schemas/FareRule"},{"required":["StructuredFareRules"],"properties":{"StructuredFareRules":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/StructuredFareRules"}}}}]}},"components/schemas/StructuredFareRules":{"id":"components/schemas/StructuredFareRules","kind":"json-schema","title":"StructuredFareRules","data":{"properties":{"@type":{"type":"string","example":"StructuredFareRules"},"passengerTypeCodes":{"type":"array","description":"List of passenger type codes","items":{"maxLength":5,"minLength":3,"pattern":"([a-zA-Z0-9]{3,5})","type":"string","example":"[\"ADT\",\"CHD\"]"}},"fareClassCode":{"maxLength":10,"type":"string","description":"The code of the fare class to which the rule applies, or the generic fare","example":"QVM0Z0H"},"fareTypeCode":{"maxLength":3,"type":"string","description":"ATPCO fare type code","example":"ERU"},"seasonType":{"$ref":"#/components/schemas/SeasonTypeEnum"},"dayOfWeekType":{"$ref":"#/components/schemas/DayOfWeekTypeEnum"},"oneWayRoundTripRestrictions":{"$ref":"#/components/schemas/OneWayRoundTripEnum"},"routingNumber":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"00000 - 09999;  00000 = MPM; 88888 = Specified Routing"},"children":[]}]}]}],"format":"int32","example":9999},"effectiveDate":{"type":"string","format":"date"},"discontinueDate":{"type":"string","format":"date"},"inboundOutboundApplication":{"$ref":"#/components/schemas/InboundOutboundEnum"},"geographicDirectionApplication":{"$ref":"#/components/schemas/GeographicDirectionEnum"},"Penalties":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Penalties"}},"MinimumStay":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/MinimumStay"}},"MaximumStay":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/MaximumStay"}},"AdvanceReservation":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/AdvanceReservation"}},"AdvancePayment":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/AdvancePayment"}},"Stopover":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Stopover"}},"Location1GeographicSpecification":{"$ref":"#/components/schemas/Location1GeographicSpecification"},"Location2GeographicSpecification":{"$ref":"#/components/schemas/Location2GeographicSpecification"},"generalRuleDoesNotApplyInd":{"type":"boolean","description":"if true, general rule does not apply. Specific data in this rule overrides general rule application."}}}},"components/schemas/SeasonTypeEnum":{"id":"components/schemas/SeasonTypeEnum","kind":"json-schema","title":"SeasonTypeEnum","data":{"type":"string","enum":["Basic","High/Peak","HolidaySurcharge","Low/OffPeak","SecondWinter","Shoulder"]}},"components/schemas/DayOfWeekTypeEnum":{"id":"components/schemas/DayOfWeekTypeEnum","kind":"json-schema","title":"DayOfWeekTypeEnum","data":{"type":"string","enum":["Midweek","MidweekNight","Night","OffPeak","Weekend","WeekendNight"]}},"components/schemas/OneWayRoundTripEnum":{"id":"components/schemas/OneWayRoundTripEnum","kind":"json-schema","title":"OneWayRoundTripEnum","data":{"type":"string","enum":["OneWay","RoundTrip","All"]}},"components/schemas/InboundOutboundEnum":{"id":"components/schemas/InboundOutboundEnum","kind":"json-schema","title":"InboundOutboundEnum","data":{"type":"string","enum":["InboundTravelOnly","OutboundTravelOnly","AlwaysApplies"]}},"components/schemas/GeographicDirectionEnum":{"id":"components/schemas/GeographicDirectionEnum","kind":"json-schema","title":"GeographicDirectionEnum","data":{"type":"string","enum":["FromLocation1ToLocation2","ToLocation1FromLocation2","OriginatingFromLocation1ToLocation2","OriginatingFromLocation2ToLocation1"]}},"components/schemas/MinimumStay":{"id":"components/schemas/MinimumStay","kind":"json-schema","title":"MinimumStay","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"MinimumStayApplies"},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info","example":"01634"}},"description":"Discriminator classes MinimumStay, MinimumStayApplies or MinimumStayIndeterminate","discriminator":{"propertyName":"@type"}}},"components/schemas/MaximumStay":{"id":"components/schemas/MaximumStay","kind":"json-schema","title":"MaximumStay","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator","example":"MaximumStayApplies"},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info","example":"01634"}},"description":"Discriminator classes MaximumStay, MaximumStayApplies or MaximumStayIndeterminate","discriminator":{"propertyName":"@type"}}},"components/schemas/AdvanceReservation":{"id":"components/schemas/AdvanceReservation","kind":"json-schema","title":"AdvanceReservation","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"AdvanceReservationRequired"},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info","example":"01634"}},"description":"Discriminator classes AdvanceReservation, AdvanceReservationRequired, AdvanceReservationIndeterminate","discriminator":{"propertyName":"@type"}}},"components/schemas/AdvancePayment":{"id":"components/schemas/AdvancePayment","kind":"json-schema","title":"AdvancePayment","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"AdvancePayment"},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info","example":"01634"}},"description":"Discriminator classes AdvancePayment, AdvancePaymentRequired or AdvancePaymentIndeterminate","discriminator":{"propertyName":"@type"}}},"components/schemas/Stopover":{"id":"components/schemas/Stopover","kind":"json-schema","title":"Stopover","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator.","example":"StopoverPermitted"},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info","example":"01634"}},"description":"Discriminator classes Stopover, StopoverPermitted, StopoverNotPermitted or StopoverIndeterminate","discriminator":{"propertyName":"@type"}}},"components/schemas/Location1GeographicSpecification":{"id":"components/schemas/Location1GeographicSpecification","kind":"json-schema","title":"Location1GeographicSpecification","data":{"properties":{"value":{"maxLength":5,"type":"string"},"geographicSpecificationType":{"$ref":"#/components/schemas/geographicSpecificationTypeEnum"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of geographic specification. AREA-a one-digit numeric area designator. 1= Western Hemisphere 2 = Europe, Africa & Near East 3 = Far East, Australia and Pacific, ZONE-a numeric value assigned to a non-standard geographic description of cities, states, countries, sub-continents, and/or traffic conferences COUNTRY- The standard IATA country code,CITY-The standard industry city code STATE -the standard Postal state code. Two-character alpha codes.  When used, it will always be preceded by a country code"},"children":[]}]}]}]}},"components/schemas/geographicSpecificationTypeEnum":{"id":"components/schemas/geographicSpecificationTypeEnum","kind":"json-schema","title":"geographicSpecificationTypeEnum","data":{"type":"string","enum":["Area","City","Country","State","Zone"]}},"components/schemas/Location2GeographicSpecification":{"id":"components/schemas/Location2GeographicSpecification","kind":"json-schema","title":"Location2GeographicSpecification","data":{"properties":{"value":{"maxLength":5,"type":"string"},"geographicSpecificationType":{"$ref":"#/components/schemas/geographicSpecificationTypeEnum"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of geographic specification. AREA-a one-digit numeric area designator. 1= Western Hemisphere 2 = Europe, Africa and Near East 3 = Far East, Australia and Pacific, ZONE-a numeric value assigned to a non-standard geographic description of cities, states, countries, sub-continents, and/or traffic conferences COUNTRY- The standard IATA country code,CITY-The standard industry city code STATE -the standard Postal state code. Two-character alpha codes.  When used, it will always be preceded by a country code"},"children":[]}]}]}]}},"components/schemas/FareRuleText":{"id":"components/schemas/FareRuleText","kind":"json-schema","title":"FareRuleText","data":{"allOf":[{"$ref":"#/components/schemas/FareRule"},{"required":["TextFareRule"],"properties":{"TextFareRule":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TextFareRule"}}}}]}},"components/schemas/TextFareRule":{"id":"components/schemas/TextFareRule","kind":"json-schema","title":"TextFareRule","data":{"properties":{"value":{"maxLength":4096,"type":"string","example":"Fare cannot be changed. Refundable before departure with 4100.00 penalty"},"language":{"type":"string","description":"A three letter code for the representation of names of languages defined by ISO639-3","example":"ENG"},"name":{"maxLength":32,"type":"string","description":"The name of the text fare rule","example":"Penalties"}},"description":"fare rules in text format"}},"components/schemas/MinimumStayApplies":{"id":"components/schemas/MinimumStayApplies","kind":"json-schema","title":"MinimumStayApplies","data":{"allOf":[{"$ref":"#/components/schemas/MinimumStay"},{"required":["Duration"],"properties":{"mustIncludeDayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"},"originDayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"},"returnTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Return time in local time zone","example":"43200"},"Duration":{"type":"string","description":"Minimum duration","example":"5 days"},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number associated to this fare rule info","example":"D38"},"tariffNumber":{"maxLength":32,"type":"string","description":"The tariff number associated to this fare rule info","example":"01634"}}}]}},"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/MinimumStayIndeterminate":{"id":"components/schemas/MinimumStayIndeterminate","kind":"json-schema","title":"MinimumStayIndeterminate","data":{"allOf":[{"$ref":"#/components/schemas/MinimumStay"},{"properties":{"IndeterminateInd":{"type":"string","description":"Structured fare rules could not be determined for this category","example":"true"}}}]}},"components/schemas/MaximumStayApplies":{"id":"components/schemas/MaximumStayApplies","kind":"json-schema","title":"MaximumStayApplies","data":{"allOf":[{"$ref":"#/components/schemas/MaximumStay"},{"properties":{"maximumStayDuration":{"type":"string"},"maximumStayDate":{"type":"string","format":"date"},"returnTime":{"pattern":"^(2[0-3]|[01]?[0-9]):([0-5]?[0-9]):([0-5]?[0-9])$","type":"string","description":"Return time in local time zone","example":"64800"},"mustCommenceByInd":{"type":"boolean","description":"Indicates if travel must commence by this date/duration","example":true},"mustCompleteByInd":{"type":"boolean","description":"Indicates if travel must complete by this date/duration","example":true},"fromDateOfIssueInd":{"type":"boolean","description":"If true the Maximum stay is calculated from the date of ticket issuance","example":true},"earliestAppliesInd":{"type":"boolean","description":"If true, the earlier of the Maximum stay conditions apply","example":true},"latestAppliesInd":{"type":"boolean","description":"If true, the later of the Maximum stay conditions apply","example":true}}}]}},"components/schemas/MaximumStayIndeterminate":{"id":"components/schemas/MaximumStayIndeterminate","kind":"json-schema","title":"MaximumStayIndeterminate","data":{"allOf":[{"$ref":"#/components/schemas/MaximumStay"},{"properties":{"IndeterminateInd":{"type":"string","description":"Structured fare rules could not be determined for this category","example":"true"}}}]}},"components/schemas/AdvancePaymentRequired":{"id":"components/schemas/AdvancePaymentRequired","kind":"json-schema","title":"AdvancePaymentRequired","data":{"allOf":[{"$ref":"#/components/schemas/AdvancePayment"},{"required":["PaymentAfterReservation","PaymentBeforeDeparture"],"properties":{"waverDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"Waver date","example":"2024-05-20"},"PaymentAfterReservation":{"$ref":"#/components/schemas/PaymentAfterReservation"},"PaymentBeforeDeparture":{"$ref":"#/components/schemas/PaymentBeforeDeparture"},"PaymentTravelSegmentIndicatorATPCO":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ATPCO paymentgeographic indicator. Example = 1st segment over the water between area 2 and 3"},"children":[]}]}]}],"format":"int32","example":55},"instantPaymentInd":{"type":"boolean","description":"if true, the Offer must be paid at the same time as the reservation is created","example":true},"ealierAppliesInd":{"type":"boolean","description":"If true, the earlier of the payment restrictions apply","example":true},"laterAppliesInd":{"type":"boolean","description":"If true, the later of the payment restrictions apply","example":true}}}]}},"components/schemas/PaymentAfterReservation":{"id":"components/schemas/PaymentAfterReservation","kind":"json-schema","title":"PaymentAfterReservation","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"PaymentAfterReservation"},"TimeOfDay":{"type":"string","description":"The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration","example":"07:00"}},"description":"Discriminator classes PaymentAfterReservationDuration or PaymentAfterReservationDayOfWeek","discriminator":{"propertyName":"@type"}}},"components/schemas/PaymentBeforeDeparture":{"id":"components/schemas/PaymentBeforeDeparture","kind":"json-schema","title":"PaymentBeforeDeparture","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"PaymentBeforeDeparture"},"TimeOfDay":{"type":"string","description":"The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration","example":"07:00"}},"description":"Discriminator classes PaymentBeforeDepartureDuration or PaymentBeforeDepartureDayOfWeek","discriminator":{"propertyName":"@type"}}},"components/schemas/AdvancePaymentIndeterminate":{"id":"components/schemas/AdvancePaymentIndeterminate","kind":"json-schema","title":"AdvancePaymentIndeterminate","data":{"allOf":[{"$ref":"#/components/schemas/AdvancePayment"},{"properties":{"IndeterminateInd":{"type":"string","description":"If true the advance Payment restrictions could not be determined","example":"true"}}}]}},"components/schemas/DayOfWeekDurationDuration":{"id":"components/schemas/DayOfWeekDurationDuration","kind":"json-schema","title":"DayOfWeekDurationDuration","data":{"allOf":[{"$ref":"#/components/schemas/DayOfWeekDuration"},{"required":["Duration"],"properties":{"Duration":{"type":"string","description":"The advance duration the Offer can be reserved.","example":"50 days in advance of the first flight"}}}]}},"components/schemas/DayOfWeekDuration":{"id":"components/schemas/DayOfWeekDuration","kind":"json-schema","title":"DayOfWeekDuration","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"DayOfWeekDuration"},"TimeOfDay":{"type":"string","description":"The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration","example":"07:00"}},"description":"Discriminator classes DayOfWeekDurationDuration or DayOfWeekDurationDayOfWeek","discriminator":{"propertyName":"@type"}}},"components/schemas/DayOfWeekDurationDayOfWeek":{"id":"components/schemas/DayOfWeekDurationDayOfWeek","kind":"json-schema","title":"DayOfWeekDurationDayOfWeek","data":{"allOf":[{"$ref":"#/components/schemas/DayOfWeekDuration"},{"required":["DayOfWeek"],"properties":{"DayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"}}}]}},"components/schemas/FirstReservationDuration":{"id":"components/schemas/FirstReservationDuration","kind":"json-schema","title":"FirstReservationDuration","data":{"allOf":[{"$ref":"#/components/schemas/FirstReservation"},{"required":["Duration"],"properties":{"Duration":{"type":"string","description":"The advance duration the Offer can be reserved.","example":"50 days in advance of the first flight"}}}]}},"components/schemas/FirstReservation":{"id":"components/schemas/FirstReservation","kind":"json-schema","title":"FirstReservation","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"FirstReservation"},"TimeOfDay":{"type":"string","description":"The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration","example":"07:00"}},"description":"Discriminator classes FirstReservationDuration or FirstReservationDayOfWeek","discriminator":{"propertyName":"@type"}}},"components/schemas/FirstReservationDayOfWeek":{"id":"components/schemas/FirstReservationDayOfWeek","kind":"json-schema","title":"FirstReservationDayOfWeek","data":{"allOf":[{"$ref":"#/components/schemas/FirstReservation"},{"required":["DayOfWeek"],"properties":{"DayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"}}}]}},"components/schemas/LastReservationDuration":{"id":"components/schemas/LastReservationDuration","kind":"json-schema","title":"LastReservationDuration","data":{"allOf":[{"$ref":"#/components/schemas/LastReservation"},{"required":["Duration"],"properties":{"Duration":{"type":"string","description":"The advance duration the Offer can be reserved.","example":"50 days in advance of the first flight"}}}]}},"components/schemas/LastReservation":{"id":"components/schemas/LastReservation","kind":"json-schema","title":"LastReservation","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"LastReservation"},"TimeOfDay":{"type":"string","description":"The time of day indicates the earliest time the Offer can be reserved. Used in conjunction with DayOfWeek or Duration","example":"07:00"}},"description":"Discriminator classes LastReservationDuration or LastReservationDayOfWeek","discriminator":{"propertyName":"@type"}}},"components/schemas/LastReservationDayOfWeek":{"id":"components/schemas/LastReservationDayOfWeek","kind":"json-schema","title":"LastReservationDayOfWeek","data":{"allOf":[{"$ref":"#/components/schemas/LastReservation"},{"required":["DayOfWeek"],"properties":{"DayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"}}}]}},"components/schemas/PaymentAfterReservationDuration":{"id":"components/schemas/PaymentAfterReservationDuration","kind":"json-schema","title":"PaymentAfterReservationDuration","data":{"allOf":[{"$ref":"#/components/schemas/PaymentAfterReservation"},{"required":["Duration"],"properties":{"Duration":{"type":"string","description":"The advance duration the Offer can be reserved.","example":"50 days in advance of the first flight"}}}]}},"components/schemas/PaymentAfterReservationDayOfWeek":{"id":"components/schemas/PaymentAfterReservationDayOfWeek","kind":"json-schema","title":"PaymentAfterReservationDayOfWeek","data":{"allOf":[{"$ref":"#/components/schemas/PaymentAfterReservation"},{"required":["DayOfWeek"],"properties":{"DayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"}}}]}},"components/schemas/PaymentBeforeDepartureDuration":{"id":"components/schemas/PaymentBeforeDepartureDuration","kind":"json-schema","title":"PaymentBeforeDepartureDuration","data":{"allOf":[{"$ref":"#/components/schemas/PaymentBeforeDeparture"},{"required":["Duration"],"properties":{"Duration":{"type":"string","description":"The advance duration the Offer can be reserved.","example":"50 days in advance of the first flight"}}}]}},"components/schemas/PaymentBeforeDepartureDayOfWeek":{"id":"components/schemas/PaymentBeforeDepartureDayOfWeek","kind":"json-schema","title":"PaymentBeforeDepartureDayOfWeek","data":{"allOf":[{"$ref":"#/components/schemas/PaymentBeforeDeparture"},{"required":["DayOfWeek"],"properties":{"DayOfWeek":{"$ref":"#/components/schemas/DayOfWeekEnum"}}}]}},"components/schemas/StopoverPermitted":{"id":"components/schemas/StopoverPermitted","kind":"json-schema","title":"StopoverPermitted","data":{"allOf":[{"$ref":"#/components/schemas/Stopover"},{"required":["StopoverCharge","maximum","maximumDuration","minimum","minimumDuration"],"properties":{"journeyTypes":{"type":"array","items":{"$ref":"#/components/schemas/JourneyTypeEnum"}},"minimumDuration":{"type":"string","description":"The minimum amount of time permitted for a stopover","example":"1 hour"},"maximumDuration":{"type":"string","description":"The maximum amount of time permitted for a stopover","example":"12 hours"},"minimum":{"type":"integer","description":"The minimum permitted for a stopover","format":"int32","example":3},"maximum":{"type":"integer","description":"The maximum permitted for a stopover","format":"int32","example":5},"outbound":{"type":"integer","description":"Stopover outbound","format":"int32","example":2},"inbound":{"type":"integer","description":"Stopover inbound","format":"int32","example":3},"StopoverCharge":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/StopoverCharge"}},"StopoverRestriction":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/StopoverRestriction"}},"permittedAtGatewayOnlyInd":{"type":"boolean","description":"If true, stopovers are permitted at gateway points only","example":true}}}]}},"components/schemas/JourneyTypeEnum":{"id":"components/schemas/JourneyTypeEnum","kind":"json-schema","title":"JourneyTypeEnum","data":{"type":"string","example":"OpenJaw","enum":["OpenJaw","RoundTrip","CircleTrip","Outbound","Inbound"]}},"components/schemas/StopoverCharge":{"id":"components/schemas/StopoverCharge","kind":"json-schema","title":"StopoverCharge","data":{"required":["Amount","id","quantity"],"properties":{"@type":{"type":"string","example":"StopoverCharge"},"id":{"type":"string","description":"The ID of the stopoverCharge","example":"125"},"quantity":{"type":"integer","description":"The quantity of stopovers permitted at this charge","format":"int32","example":2},"Amount":{"$ref":"#/components/schemas/CurrencyAmount"},"AlternativeAmount":{"$ref":"#/components/schemas/CurrencyAmount"}}}},"components/schemas/StopoverRestriction":{"id":"components/schemas/StopoverRestriction","kind":"json-schema","title":"StopoverRestriction","data":{"required":["stopoverChargeRef"],"properties":{"@type":{"type":"string","example":"StopoverRestrictions"},"stopoverChargeRef":{"type":"string","description":"Reference to the Stopover Charge","example":"Reference1"},"journeyTypes":{"type":"array","items":{"$ref":"#/components/schemas/JourneyTypeEnum"}},"departureCarrier":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"Departure carrier airline code","example":"XPE"},"arrivalAirline":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"Arrival carrier airline code","example":"AEH"},"GeographicRestriction":{"maxItems":5,"type":"array","example":["Airport","City","Country","StateProvince","Zone"],"items":{"$ref":"#/components/schemas/GeographicRestriction"}},"onlineStopoverOnlyInd":{"type":"boolean","description":"If true, the stopover may only take place when the arriving and departing airline are the same","example":true}}}},"components/schemas/GeographicRestriction":{"id":"components/schemas/GeographicRestriction","kind":"json-schema","title":"GeographicRestriction","data":{"required":["geographicRestrictionType"],"properties":{"value":{"maxLength":32,"type":"string"},"geographicRestrictionType":{"$ref":"#/components/schemas/GeographicRestrictionTypeEnum"}}}},"components/schemas/GeographicRestrictionTypeEnum":{"id":"components/schemas/GeographicRestrictionTypeEnum","kind":"json-schema","title":"GeographicRestrictionTypeEnum","data":{"type":"string","example":"Airport","enum":["Area","Airport","City","Country","StateProvince","Zone"]}},"components/schemas/StopoverNotPermitted":{"id":"components/schemas/StopoverNotPermitted","kind":"json-schema","title":"StopoverNotPermitted","data":{"allOf":[{"$ref":"#/components/schemas/Stopover"},{"properties":{"NotPermittedInd":{"type":"string","description":"if true, stopovers are not permitted","example":"true"}}}]}},"components/schemas/StopoverIndeterminate":{"id":"components/schemas/StopoverIndeterminate","kind":"json-schema","title":"StopoverIndeterminate","data":{"allOf":[{"$ref":"#/components/schemas/Stopover"},{"properties":{"IndeterminatedInd":{"type":"string","description":"If true the stopover restrictions could not be determined","example":"true"}}}]}},"components/schemas/AdvanceReservationRequired":{"id":"components/schemas/AdvanceReservationRequired","kind":"json-schema","title":"AdvanceReservationRequired","data":{"allOf":[{"$ref":"#/components/schemas/AdvanceReservation"},{"required":["FirstReservation","LastReservation","instantPurchase","standby"],"properties":{"instantPurchase":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"standby":{"$ref":"#/components/schemas/YesNoUnknownEnum"},"waiverDate":{"pattern":"(\\d{4}-\\d{2}-\\d{2})","type":"string","description":"Waiver date","example":"2026/3/12"},"ReservationTravelSegmentIndicatorATPCO":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ATPCO travel segment geographic indicator. Example= 1st segment over the water"},"children":[]}]}]}],"format":"int32","example":55},"ConfirmedStatus":{"maxItems":10,"type":"array","example":["AllFlightsMustBeConfirmed","OpenReturnsNotPermitted","FirstFlightMustBeConfirmed","OpenReturnsArePermitted","Other_"],"items":{"$ref":"#/components/schemas/ConfirmedStatusEnum"}},"WaitlistStandbyCondition":{"maxItems":10,"type":"array","example":["WaitlistStandbyNotPermitted","WaitlistNotPermitted","WaitlistStandbyNotPermittedOrigin","StandbyNotPermittedOrigin","WaitlistNotPermittedOrigin","WaitlistNotPermittedOnAny","StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermitted","StandbyPermittedEarlierLaterSameDayElseStandbyNotPermitted","StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermittedOrigin"],"items":{"$ref":"#/components/schemas/WaitlistStandbyConditionEnum"}},"FirstReservation":{"$ref":"#/components/schemas/FirstReservation"},"LastReservation":{"$ref":"#/components/schemas/LastReservation"}}}]}},"components/schemas/ConfirmedStatusEnum":{"id":"components/schemas/ConfirmedStatusEnum","kind":"json-schema","title":"ConfirmedStatusEnum","data":{"properties":{"value":{"$ref":"#/components/schemas/ConfirmedStatusEnum_Base"}}}},"components/schemas/ConfirmedStatusEnum_Base":{"id":"components/schemas/ConfirmedStatusEnum_Base","kind":"json-schema","title":"ConfirmedStatusEnum_Base","data":{"type":"string","example":"OpenReturnsArePermitted","enum":["AllFlightsMustBeConfirmed","OpenReturnsNotPermitted","FirstFlightMustBeConfirmed","OpenReturnsArePermitted"]}},"components/schemas/WaitlistStandbyConditionEnum":{"id":"components/schemas/WaitlistStandbyConditionEnum","kind":"json-schema","title":"WaitlistStandbyConditionEnum","data":{"properties":{"value":{"$ref":"#/components/schemas/WaitlistStandbyConditionEnum_Base"}}}},"components/schemas/WaitlistStandbyConditionEnum_Base":{"id":"components/schemas/WaitlistStandbyConditionEnum_Base","kind":"json-schema","title":"WaitlistStandbyConditionEnum_Base","data":{"type":"string","example":"WaitlistNotPermitted","enum":["WaitlistStandbyNotPermitted","WaitlistNotPermitted","WaitlistStandbyNotPermittedOrigin","StandbyNotPermittedOrigin","WaitlistNotPermittedOrigin","WaitlistNotPermittedOnAny","StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermitted","StandbyPermittedEarlierLaterSameDayElseStandbyNotPermitted","StandbyPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermittedOrigin","WaitlistPermittedEarlierLaterSameDayElseWaitlistStandbyNotPermittedOrigin","StandbyPermittedSameDateOriginallyTicketedProvidedFlightTimeSpecificRulesMet","StandbyNotPermitted"]}},"components/schemas/AdvanceReservationIndeterminate":{"id":"components/schemas/AdvanceReservationIndeterminate","kind":"json-schema","title":"AdvanceReservationIndeterminate","data":{"allOf":[{"$ref":"#/components/schemas/AdvanceReservation"},{"properties":{"IndeterminateInd":{"type":"string","description":"If true the advance Reservation restrictions could not be determined","example":"true"}}}]}},"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/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/ReceiptConfirmationDivide":{"id":"components/schemas/ReceiptConfirmationDivide","kind":"json-schema","title":"ReceiptConfirmationDivide","data":{"allOf":[{"$ref":"#/components/schemas/ReceiptConfirmation"},{"required":["ParentLocator"],"properties":{"ParentLocator":{"$ref":"#/components/schemas/Locator"}}}]}},"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/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/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/DocumentTicket":{"id":"components/schemas/DocumentTicket","kind":"json-schema","title":"DocumentTicket","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"required":["ControlNumber"],"properties":{"ControlNumber":{"maxLength":32,"type":"string","description":"The control number assigned to the Ticket","example":"1234568780"},"FlightPassCredits":{"type":"integer","description":"The total number of flight pass credits consumed for this document.","format":"int32","example":1},"historicInd":{"type":"boolean","description":"If true, this document has been superseded by a new Document facet and may have been exchanged, voided or refunded.","example":true}}}]}},"components/schemas/DocumentTicketRefund":{"id":"components/schemas/DocumentTicketRefund","kind":"json-schema","title":"DocumentTicketRefund","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"required":["ControlNumber"],"properties":{"ControlNumber":{"maxLength":32,"type":"string","description":"The control number assigned to the TicketRefund","example":"060-02134569"},"partialRefundInd":{"type":"boolean","description":"if true, the ticket has been partially refunded","example":true},"refundGuaranteedInd":{"type":"boolean","description":"if true, this refund amount is guaranteed by Travelport TripServices automated refunds","example":true},"historicInd":{"type":"boolean","description":"if true this document refund has been cancelled/voided","example":true},"agencySettlementNotReportedInd":{"type":"boolean","description":"If true, this refund is settled by the agency directly with the traveler. Transaction is not reported to BSP or ARC. Ticket coupon is updated to RFND status","example":true},"FareGuaranteePolicy":{"$ref":"#/components/schemas/FareGuaranteePolicy"},"SupplierRetainedPrice":{"$ref":"#/components/schemas/SupplierRetainedPriceDetail"},"ConsumedPrice":{"$ref":"#/components/schemas/ConsumedPriceDetail"}}}]}},"components/schemas/ConsumedPriceDetail":{"id":"components/schemas/ConsumedPriceDetail","kind":"json-schema","title":"ConsumedPriceDetail","data":{"description":"Detail facet of consumed price.","allOf":[{"$ref":"#/components/schemas/ConsumedPrice"},{"properties":{"FlightPassCredits":{"type":"integer","description":"The total number of flight pass credits consumed for this offer.","format":"int32","example":2},"PriceBreakdown":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PriceBreakdown"}}}}]}},"components/schemas/ConsumedPrice":{"id":"components/schemas/ConsumedPrice","kind":"json-schema","title":"ConsumedPrice","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"ConsumedPriceDetail"},"id":{"type":"string","description":"Internally referenced id"},"CurrencyCode":{"$ref":"#/components/schemas/CurrencyCode"},"Base":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount not including taxes and/or fees"},"children":[]}]}]}],"format":"float"},"TotalTaxes":{"type":"number","description":"The total of the taxes included in the total price","format":"float"},"TotalFees":{"type":"number","description":"The total of the fees included in the total price","format":"float"},"TotalPrice":{"type":"number","description":"The total price of the product in the currency indicated","format":"float"},"VendorCurrencyTotal":{"$ref":"#/components/schemas/VendorCurrencyTotal"}},"description":"The consumed price for this refund or exchange.","discriminator":{"propertyName":"@type"}}},"components/schemas/DocumentTicketVoid":{"id":"components/schemas/DocumentTicketVoid","kind":"json-schema","title":"DocumentTicketVoid","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"VoidInd":{"type":"string","description":"If true the document has been voided","example":"true"}}}]}},"components/schemas/DocumentTicketExchange":{"id":"components/schemas/DocumentTicketExchange","kind":"json-schema","title":"DocumentTicketExchange","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"exchangeInd":{"type":"boolean","description":"If true this document has been exchanged for a new document","example":true},"historicInd":{"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 this document exchange has been cancelled/voided"},"children":[]}]}]}],"example":true},"SupplierRetainedPrice":{"$ref":"#/components/schemas/SupplierRetainedPriceDetail"},"ConsumedPrice":{"$ref":"#/components/schemas/ConsumedPriceDetail"}}}]}},"components/schemas/DocumentTicketRetained":{"id":"components/schemas/DocumentTicketRetained","kind":"json-schema","title":"DocumentTicketRetained","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"ValueRetainedInd":{"type":"string","description":"If true the Document Ticket Value has been retained for future use","example":"true"}}}]}},"components/schemas/DocumentForfeit":{"id":"components/schemas/DocumentForfeit","kind":"json-schema","title":"DocumentForfeit","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"forfeitInd":{"type":"boolean","description":"If true the value of the document has been forfeited","example":true}}}]}},"components/schemas/DocumentEMD":{"id":"components/schemas/DocumentEMD","kind":"json-schema","title":"DocumentEMD","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"required":["EMDDescription"],"properties":{"EMDDescription":{"$ref":"#/components/schemas/EMDDescription"}}}]}},"components/schemas/DocumentEMDRefund":{"id":"components/schemas/DocumentEMDRefund","kind":"json-schema","title":"DocumentEMDRefund","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"required":["EMDDescription"],"properties":{"EMDDescription":{"$ref":"#/components/schemas/EMDDescription"}}}]}},"components/schemas/DocumentEMDVoid":{"id":"components/schemas/DocumentEMDVoid","kind":"json-schema","title":"DocumentEMDVoid","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"VoidInd":{"type":"string","description":"If true the EMD has been voided","example":"true"}}}]}},"components/schemas/DocumentEMDExchange":{"id":"components/schemas/DocumentEMDExchange","kind":"json-schema","title":"DocumentEMDExchange","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"exchangeInd":{"type":"boolean","description":"If true this document has been exchanged for a new document","example":true}}}]}},"components/schemas/DocumentMCO":{"id":"components/schemas/DocumentMCO","kind":"json-schema","title":"DocumentMCO","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"mcoInd":{"type":"boolean","description":"If true, the document issues is an MCO.","example":true},"issuedFor":{"maxLength":32,"type":"string","description":"MCO issued for.","example":"Residual Value"},"reasonForIssuanceCode":{"maxLength":1,"type":"string","description":"MCO reason for issuance code.","example":"K"},"issuedAt":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"MCO issued at IATA location code","example":"LON"},"Comment":{"maxItems":5,"type":"array","items":{"maxLength":128,"type":"string","example":"MCO issued for residual value."}},"RelatedDocumentNumbers":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DocumentNumber"}}}}]}},"components/schemas/DocumentMCORefund":{"id":"components/schemas/DocumentMCORefund","kind":"json-schema","title":"DocumentMCORefund","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"required":["ControlNumber"],"properties":{"ControlNumber":{"maxLength":32,"type":"string","description":"Reference for tracking refund","example":"3212112321"},"issuedFor":{"maxLength":32,"type":"string","description":"MCO issued for.","example":"Residual Value"},"reasonForIssuanceCode":{"maxLength":1,"type":"string","description":"MCO reason for issuance code.","example":"K"},"issuedAt":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"MCO issued at IATA location code","example":"LON"},"Comment":{"maxItems":5,"type":"array","items":{"maxLength":128,"type":"string","example":"MCO issued for residual value."}},"RelatedDocumentNumbers":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DocumentNumber"}}}}]}},"components/schemas/DocumentMCOVoid":{"id":"components/schemas/DocumentMCOVoid","kind":"json-schema","title":"DocumentMCOVoid","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"VoidInd":{"type":"string","description":"If true, the MCO has been voided","example":"true"},"issuedFor":{"maxLength":32,"type":"string","description":"MCO issued for.","example":"Residual Value"},"reasonForIssuanceCode":{"maxLength":1,"type":"string","description":"MCO reason for issuance code.","example":"K"},"issuedAt":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"MCO issued at IATA location code","example":"LON"},"Comment":{"maxItems":5,"type":"array","items":{"maxLength":128,"type":"string","example":"MCO issued for residual value."}},"RelatedDocumentNumbers":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DocumentNumber"}}}}]}},"components/schemas/DocumentMCOExchange":{"id":"components/schemas/DocumentMCOExchange","kind":"json-schema","title":"DocumentMCOExchange","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"exchangeInd":{"type":"boolean","description":"If true, this MCO has been exchanged","example":true},"issuedFor":{"maxLength":32,"type":"string","description":"MCO issued for.","example":"Residual Value"},"reasonForIssuanceCode":{"maxLength":1,"type":"string","description":"MCO reason for issuance code.","example":"K"},"issuedAt":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","description":"MCO issued at IATA location code","example":"LON"},"Comment":{"maxItems":5,"type":"array","items":{"maxLength":128,"type":"string","example":"MCO issued for residual value."}},"RelatedDocumentNumbers":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/DocumentNumber"}}}}]}},"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/DocumentAgencyServiceFeeVoid":{"id":"components/schemas/DocumentAgencyServiceFeeVoid","kind":"json-schema","title":"DocumentAgencyServiceFeeVoid","data":{"allOf":[{"$ref":"#/components/schemas/Document"},{"properties":{"voidInd":{"type":"boolean","description":"If true, this agency service fee has been voided"}}}]}},"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/AppliesToOfferProductSegment":{"id":"components/schemas/AppliesToOfferProductSegment","kind":"json-schema","title":"AppliesToOfferProductSegment","data":{"allOf":[{"$ref":"#/components/schemas/AppliesTo"},{"properties":{"OfferIdentifier":{"$ref":"#/components/schemas/OfferIdentifier"},"ProductIdentifier":{"$ref":"#/components/schemas/ProductIdentifier"},"SegmentSequenceList":{"type":"array","description":"Segment Sequence List","example":[23,12,34,51],"items":{"type":"integer","format":"int32"}}}}]}},"components/schemas/SpecialServiceBassinet":{"id":"components/schemas/SpecialServiceBassinet","kind":"json-schema","title":"SpecialServiceBassinet","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"bassinetRequiredInd":{"type":"boolean","description":"If true, a bassinet is required","example":true}}}]}},"components/schemas/SpecialServiceBlind":{"id":"components/schemas/SpecialServiceBlind","kind":"json-schema","title":"SpecialServiceBlind","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"blindAssistanceRequestedInd":{"type":"boolean","description":"If true the Traveler is Blind and requests assistance"}}}]}},"components/schemas/SpecialServiceDeaf":{"id":"components/schemas/SpecialServiceDeaf","kind":"json-schema","title":"SpecialServiceDeaf","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"deafAssistanceRequestedInd":{"type":"boolean","description":"If True the Traveler is Deaf and requests assistance"}}}]}},"components/schemas/SpecialServiceDPNA":{"id":"components/schemas/SpecialServiceDPNA","kind":"json-schema","title":"SpecialServiceDPNA","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"required":["Description"],"properties":{"Description":{"maxLength":1024,"type":"string","description":"Describes the Traveler development or intellectual disability"}}}]}},"components/schemas/SpecialServiceUnaccompaniedMinor":{"id":"components/schemas/SpecialServiceUnaccompaniedMinor","kind":"json-schema","title":"SpecialServiceUnaccompaniedMinor","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"unaccompaniedMinorInd":{"type":"boolean","description":"Indicates that the Traveler is an Unaccompanied minor"}}}]}},"components/schemas/SpecialServiceWheelchairAirlineSupplied":{"id":"components/schemas/SpecialServiceWheelchairAirlineSupplied","kind":"json-schema","title":"SpecialServiceWheelchairAirlineSupplied","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"cannotAscendStairsInd":{"type":"boolean","description":"if true, traveler needs assistance ascending and descending stairs"},"travelerImmobileInd":{"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, traveler is completely immobile and requires assistance to/from aircraft/mobile lounge and ascending/descending stairs"},"children":[]}]}]}]}}}]}},"components/schemas/SpecialServiceWheelchairTravelerSupplied":{"id":"components/schemas/SpecialServiceWheelchairTravelerSupplied","kind":"json-schema","title":"SpecialServiceWheelchairTravelerSupplied","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"BatteryTypeEnum":{"$ref":"#/components/schemas/BatteryTypeEnum"},"Measurement":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Measurement"}},"cannotAscendStairsInd":{"type":"boolean","description":"if true, traveler needs assistance ascending and descending stairs","example":true},"travelerImmobileInd":{"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, traveler is completely immobile and requires assistance to/from aircraft/mobile lounge and ascending/descending stairs"},"children":[]}]}]}]}}}]}},"components/schemas/BatteryTypeEnum":{"id":"components/schemas/BatteryTypeEnum","kind":"json-schema","title":"BatteryTypeEnum","data":{"type":"string","description":"The type of battery that is used in the device","example":"LithiumION","enum":["LithiumION","NonSpillableBattery","WetCellBattery","NoBatteryManualPower"]}},"components/schemas/SpecialServiceMeal":{"id":"components/schemas/SpecialServiceMeal","kind":"json-schema","title":"SpecialServiceMeal","data":{"description":"Traveler Special Meal Assistance","allOf":[{"$ref":"#/components/schemas/SpecialService"},{"properties":{"SpecialMealTypeEnum":{"$ref":"#/components/schemas/SpecialMealTypeEnum"}}}]}},"components/schemas/SpecialMealTypeEnum":{"id":"components/schemas/SpecialMealTypeEnum","kind":"json-schema","title":"SpecialMealTypeEnum","data":{"type":"string","description":"Special Meal Type","example":"Vegan","enum":["Baby","Bland","Child","Diabetic","FruitPlatter","GlutenIntolerant","Hindu","Jain","Kosher","LowCalorie","LowFat","LowSalt","Muslim","NonLactose","None","Seafood","Vegan","VegetarianHindu","VegetarianLactoOvo","VegetarianOriental","VegetarianRaw"]}},"components/schemas/ReservationBuildFromCatalogProductOfferings":{"id":"components/schemas/ReservationBuildFromCatalogProductOfferings","kind":"json-schema","title":"ReservationBuildFromCatalogProductOfferings","data":{"description":"Defines the reservation build details used to create an air reservation from a cached air search (catalog product offerings), including traveler, payment, and related booking details. May also include NDC ancillary seat allocation.","allOf":[{"$ref":"#/components/schemas/ReservationBuild"},{"properties":{"BuildFromCatalogProductOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogProductOfferingsRequest"},"BuildAncillaryOffersFromCatalogOfferings":{"maxItems":100,"type":"array","description":"Add an ancillary or seat reservation referencing the ancillary list or seat map.","items":{"$ref":"#/components/schemas/BuildAncillaryOffersFromCatalogOfferings"}}}}]}},"components/schemas/ReservationBuildFromCatalogOfferings":{"id":"components/schemas/ReservationBuildFromCatalogOfferings","kind":"json-schema","title":"ReservationBuildFromCatalogOfferings","data":{"allOf":[{"$ref":"#/components/schemas/ReservationBuild"},{"required":["BuildFromCatalogOfferingsRequest"],"properties":{"BuildFromCatalogOfferingsRequest":{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"}}}]}},"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/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/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/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/OfferStatusAncillary":{"id":"components/schemas/OfferStatusAncillary","kind":"json-schema","title":"OfferStatusAncillary","data":{"allOf":[{"$ref":"#/components/schemas/OfferStatus"},{"required":["StatusAncillary"],"properties":{"StatusAncillary":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/StatusAncillary"}}}}]}},"components/schemas/StatusAncillary":{"id":"components/schemas/StatusAncillary","kind":"json-schema","title":"StatusAncillary","data":{"properties":{"value":{"$ref":"#/components/schemas/OfferStatusEnum"},"code":{"maxLength":32,"type":"string","description":"Assigned Type: c-1100:StringTiny"}}}},"components/schemas/OfferStatusAir":{"id":"components/schemas/OfferStatusAir","kind":"json-schema","title":"OfferStatusAir","data":{"allOf":[{"$ref":"#/components/schemas/OfferStatus"},{"properties":{"StatusAir":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/StatusAir"}}}}]}},"components/schemas/TermsAndConditionsFullScheduleChange":{"id":"components/schemas/TermsAndConditionsFullScheduleChange","kind":"json-schema","title":"TermsAndConditionsFullScheduleChange","data":{"description":"Terms and conditions of the offer when a schedule change has ocurred.","allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFull"},{"properties":{"ScheduleChangeOptions":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ScheduleChangeOptions"}}}}]}},"components/schemas/ScheduleChangeOptions":{"id":"components/schemas/ScheduleChangeOptions","kind":"json-schema","title":"ScheduleChangeOptions","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"ScheduleChangeOptions"},"options":{"type":"array","description":"List of available options.","items":{"$ref":"#/components/schemas/OptionsEnum"}},"waiverCodeRequiredInd":{"type":"boolean","description":"If true, a waiver code is required in subsequent reshop or refund transactions.","example":true},"reissueRequiredInd":{"type":"boolean","description":"If true, the schedule change requires the original document to be reissued.","example":true},"documentsRevalidatedInd":{"type":"boolean","description":"If true, the original documents associated to the Offer have already been revalidated with the new flight details.","example":true}},"description":"Options available after an airline initiated schedule change."}},"components/schemas/OptionsEnum":{"id":"components/schemas/OptionsEnum","kind":"json-schema","title":"OptionsEnum","data":{"type":"string","description":"Available options after a schedule change.","example":"Accept","enum":["Accept","Reshop","Refund"]}},"components/schemas/TermsAndConditionsScheduleChange":{"id":"components/schemas/TermsAndConditionsScheduleChange","kind":"json-schema","title":"TermsAndConditionsScheduleChange","data":{"description":"Terms and conditions of the offer when a schedule change has ocurred.","allOf":[{"$ref":"#/components/schemas/TermsAndConditions"},{"properties":{"ScheduleChangeOptions":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ScheduleChangeOptions"}}}}]}},"components/schemas/BuildFromUnpricedSegmentsAutoPrice":{"id":"components/schemas/BuildFromUnpricedSegmentsAutoPrice","kind":"json-schema","title":"BuildFromUnpricedSegmentsAutoPrice","data":{"description":"Build an auto priced offer from unpriced flight segments in the reservation offer.","allOf":[{"$ref":"#/components/schemas/BuildFromUnpricedSegments"},{"properties":{"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"CustomResponseModifiersAir":{"$ref":"#/components/schemas/CustomResponseModifiersAir"},"PaymentCriteria":{"$ref":"#/components/schemas/PaymentCriteria"},"CabinPreference":{"maxItems":10,"type":"array","description":"Array of cabin preference. Use sequence in UnpricedFlightSegmentCriteria to map the leg sequence to request different cabin classes on each leg of the journey.","items":{"$ref":"#/components/schemas/CabinPreference"}},"NumberOfDownsellsToReturn":{"minimum":0,"type":"integer","description":"Number of downsells to be returned.","format":"int32","example":1},"MaxNumberOfUpsellsToReturn":{"minimum":0,"type":"integer","description":"Number of upsells to be returned.","format":"int32","example":2},"inhibitBrandContentInd":{"type":"boolean","description":"If true, brand information will not be returned.","example":true},"lowFareFinderInd":{"type":"boolean","description":"If true, the lowest fare will be returned in the Offer but the flight segments will not be rebooked.","example":true},"validateInventoryInd":{"type":"boolean","description":"If true, when used in conjunction with lowFareFinderInd, the flight inventory will be checked for availability.","example":true},"lowFareFindAndRebookInd":{"type":"boolean","description":"If true, a new Offer will be created with the lowest fare available. Flight segments will be rebooked if required in the correct class of travel.","example":true}}}]}},"components/schemas/BuildFromUnpricedSegmentsManualPrice":{"id":"components/schemas/BuildFromUnpricedSegmentsManualPrice","kind":"json-schema","title":"BuildFromUnpricedSegmentsManualPrice","data":{"description":"Build a manual offer from unpriced flight segments in the reservation offer.","allOf":[{"$ref":"#/components/schemas/BuildFromUnpricedSegments"},{"required":["ManualPrice"],"properties":{"ManualPrice":{"$ref":"#/components/schemas/ManualPrice"}}}]}},"components/schemas/ManualPrice":{"id":"components/schemas/ManualPrice","kind":"json-schema","title":"ManualPrice","data":{"required":["@type","PassengerFlight","PriceDetail","TermsAndConditionsFullAir"],"properties":{"@type":{"type":"string","description":"Discriminator. No child classes.","example":"ManualPrice"},"PassengerFlight":{"maxItems":10,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PassengerFlight"}},"PriceDetail":{"$ref":"#/components/schemas/PriceDetail"},"TermsAndConditionsFullAir":{"$ref":"#/components/schemas/TermsAndConditionsFullAir"}},"description":"Create an offer using manual pricing.  \nWithin the workbench create a manually priced offer by referencing the sequence in \"UnpricedFlightSegmentCriteria\" from FlightProduct segmentSequence.  \nFor single payload match the segmentSequence in SpecificFlightCriteria against the segmentSequence in the flight product, TermsAndConditions etc.  "}},"components/schemas/TermsAndConditionsFullAir":{"id":"components/schemas/TermsAndConditionsFullAir","kind":"json-schema","title":"TermsAndConditionsFullAir","data":{"description":"Provides applicable terms and conditions for air offers.  \nFareRuleIdentifierRef is deprecated and not in use. Use Fare Rule end points directly for detailed fare rules.  \nStandalone Price does not return TermsAndConditionsFull.","allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFull"},{"properties":{"BaggageAllowance":{"maxItems":99,"type":"array","description":"If returned by the carrier, lists details about a specific type of baggage, or if a baggage embargo is in effect.","items":{"$ref":"#/components/schemas/BaggageAllowance"}},"FareRuleIdentifierRef":{"$ref":"#/components/schemas/IdentifierRef"},"Restriction":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Restriction"}},"OrganizationInformation":{"$ref":"#/components/schemas/OrganizationInformation"},"ValidatingAirline":{"maxItems":10,"type":"array","description":"Each instance lists the carrier code for the carrier on which the ticket is issued.","items":{"$ref":"#/components/schemas/ValidatingAirline"}},"BaggageRecheck":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/BaggageRecheck"}},"TicketingAgency":{"maxItems":10,"type":"array","description":"GDS only; not supported for NDC.  \nIf TicketingPCC was sent in the request to override the default ticketing agency, TicketingAgency returns the PCC of the overriding agency.  \nIf no override request was made, TicketingAgency returns the default PCC. ","items":{"$ref":"#/components/schemas/TicketingAgency"}},"PaymentTimeLimit":{"type":"string","description":"Returned for GDS offers and some NDC airlines.  \nThe local (per the point of sale) date and time by which the offer must be ticketed.  \nNot returned for a ticketed booking.","format":"date-time","example":"2022-08-07T12:12:00Z"},"PromotionalCode":{"$ref":"#/components/schemas/PromotionalCode"},"Penalties":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns change and cancel penalties for this set of terms and conditions. For GDS, Penalties returns the most restrictive CAT16 penalty details; NDC penalty rules are not necessarily filed in a specific category (CAT)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes PassengerTypeCodes and either or both the Change and Cancel objects."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the AirPrice responses for both full and reference payload, Penalties is not returned if excludePenaltiesInd=true was sent in the AirPrice request, or requested in the Search request and not overridden by excludePenaltiesInd=false in the AirPrice request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not all NDC carriers return penalty details. Some NDC carriers may not return Change or Cancel/Penalty/Amount when a change is permitted, which means there is no charge for the change."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Penalties"}},"FareGuaranteePolicy":{"maxItems":10,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GDS only; NDC does not support net fares."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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)."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When NTD is returned, TermsAndConditionsFull includes FareGuaranteePolicy to return the fare calculation indicator for the fare."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/FareGuaranteePolicy"}},"PricingAgency":{"maxItems":10,"type":"array","description":"GDS only; not supported for NDC  \nIf PricingPCC was sent in a request to override the default pricing agency, PricingAgency returns the PCC of the overriding agency. Not returned if no override request was made.","items":{"$ref":"#/components/schemas/PricingAgency"}},"FlightPass":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/FlightPass"}},"instantPurchaseInd":{"type":"boolean","description":"If true the Offer/Offering must be paid for at the same time as creating the Reservation.","example":true},"secureFlightPassengerDataRequiredInd":{"type":"boolean","description":"Returned only when true to indicate the airline requires additional passenger data for one or more travelers to complete the reservation per Secure Flight Passenger Data requirements.  \nReturned for both GDS and NDC in AirPrice; returned only for GDS in Reservation Retrieve.","example":true},"TourCodes":{"maxItems":10,"type":"array","description":"GDS only; not supported for NDC. Any tour code applicable to this fare, per PTC. Includes TravelerIdentifierRef and TourCode objects.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.","items":{"$ref":"#/components/schemas/TourCodes"}},"DocumentValidDateRange":{"$ref":"#/components/schemas/DocumentValidDateRange"},"flightPassInd":{"type":"boolean","description":"If true, indicates a flight pass offer. A response may include both regular priced offers (non flight pass) and flight pass offers."},"TextBlock":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/TextBlock"}},"FareRuleInfo":{"type":"array","description":"NDC use only. Returned in ReservationResponse.","deprecated":true,"items":{"$ref":"#/components/schemas/FareRuleInfoText"}}}}]}},"components/schemas/FareRuleInfoText":{"id":"components/schemas/FareRuleInfoText","kind":"json-schema","title":"FareRuleInfoText","data":{"allOf":[{"$ref":"#/components/schemas/FareRuleInfo"},{"required":["TextFareRule"],"properties":{"TextFareRule":{"maxItems":100,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TextFareRule"}}}}]}},"components/schemas/FareRuleInfo":{"id":"components/schemas/FareRuleInfo","kind":"json-schema","title":"FareRuleInfo","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes FareRuleInfoText or FareRuleInfoStructured","example":"FareRuleInfoText"},"flightsRefs":{"type":"array","description":"The flight refs associated to this fare rule info","example":"s1","items":{"type":"string"}},"ruleNumber":{"maxLength":32,"type":"string","description":"The rule number of a fare rule","example":"ruleNo"},"tariffNumber":{"maxLength":32,"type":"string","description":"Tarrif number","example":"46"}},"description":"When fare rules are requested with FareRuleType (use not recommended; send the Fare Rules request instead), the response returns fare rules in FareRuleInfo.","discriminator":{"propertyName":"@type"}}},"components/schemas/TravelerUpdatedItemBirthDate":{"id":"components/schemas/TravelerUpdatedItemBirthDate","kind":"json-schema","title":"TravelerUpdatedItemBirthDate","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"properties":{"BirthDateUpdatable":{"type":"string","description":"The updated birth date","format":"date"}}}]}},"components/schemas/TravelerUpdatedItemGender":{"id":"components/schemas/TravelerUpdatedItemGender","kind":"json-schema","title":"TravelerUpdatedItemGender","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"properties":{"GenderUpdatable":{"$ref":"#/components/schemas/GenderEnum"}}}]}},"components/schemas/TravelerUpdatedItemCustomerLoyalty":{"id":"components/schemas/TravelerUpdatedItemCustomerLoyalty","kind":"json-schema","title":"TravelerUpdatedItemCustomerLoyalty","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"required":["CustomerLoyalty"],"properties":{"CustomerLoyalty":{"$ref":"#/components/schemas/CustomerLoyalty"}}}]}},"components/schemas/TravelerUpdatedItemTelephone":{"id":"components/schemas/TravelerUpdatedItemTelephone","kind":"json-schema","title":"TravelerUpdatedItemTelephone","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"required":["Telephone"],"properties":{"Telephone":{"$ref":"#/components/schemas/Telephone"}}}]}},"components/schemas/TravelerUpdatedItemTravelDocument":{"id":"components/schemas/TravelerUpdatedItemTravelDocument","kind":"json-schema","title":"TravelerUpdatedItemTravelDocument","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"required":["TravelDocument"],"properties":{"TravelDocument":{"$ref":"#/components/schemas/TravelDocument"}}}]}},"components/schemas/TravelerUpdatedItemAddress":{"id":"components/schemas/TravelerUpdatedItemAddress","kind":"json-schema","title":"TravelerUpdatedItemAddress","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"required":["Address"],"properties":{"Address":{"$ref":"#/components/schemas/Address"}}}]}},"components/schemas/TravelerUpdatedItemEmail":{"id":"components/schemas/TravelerUpdatedItemEmail","kind":"json-schema","title":"TravelerUpdatedItemEmail","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"required":["Email"],"properties":{"Email":{"$ref":"#/components/schemas/Email"}}}]}},"components/schemas/TravelerUpdatedItemPersonName":{"id":"components/schemas/TravelerUpdatedItemPersonName","kind":"json-schema","title":"TravelerUpdatedItemPersonName","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"required":["PersonNameUpdatable"],"properties":{"PersonNameUpdatable":{"$ref":"#/components/schemas/PersonNameUpdatable"}}}]}},"components/schemas/PersonNameUpdatable":{"id":"components/schemas/PersonNameUpdatable","kind":"json-schema","title":"PersonNameUpdatable","data":{"required":["Given","Middle","Prefix","Suffix","Surname"],"properties":{"@type":{"type":"string","default":"PersonNameUpdatable"},"Prefix":{"maxLength":10,"type":"string","description":"Salutation of honorific","example":"Snr"},"Given":{"maxLength":30,"type":"string","description":"The first given name of the person","example":"John"},"Middle":{"maxLength":30,"type":"string","description":"The middle name of the person","example":"Leslie"},"Surname":{"maxLength":30,"minLength":1,"type":"string","description":"Family name, last name","example":"Smith"},"Suffix":{"maxLength":10,"type":"string","description":"Name suffix","example":"Mr"}}}},"components/schemas/TravelerUpdatedItemComments":{"id":"components/schemas/TravelerUpdatedItemComments","kind":"json-schema","title":"TravelerUpdatedItemComments","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatedItem"},{"properties":{"Comments":{"$ref":"#/components/schemas/Comments"}}}]}},"components/schemas/TermsAndConditionsFullAirChange":{"id":"components/schemas/TermsAndConditionsFullAirChange","kind":"json-schema","title":"TermsAndConditionsFullAirChange","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFullAir"},{"properties":{"FulfillmentMethod":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/FulfillmentMethod"}}}}]}},"components/schemas/OfferModify":{"id":"components/schemas/OfferModify","kind":"json-schema","title":"OfferModify","data":{"allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["ModifyPrice"],"properties":{"isNetted":{"$ref":"#/components/schemas/AllSomeNoneEnum"},"OfferIdentifier":{"$ref":"#/components/schemas/OfferIdentifier"},"ModifyPrice":{"$ref":"#/components/schemas/ModifyPriceDetail"},"scheduleChangeInd":{"type":"boolean","description":"Indicator not used. scheduleChangeInd will be passed in Offer schema","example":true,"deprecated":true},"retainedValueInd":{"type":"boolean","description":"If true, the value will be retained on a document for future use","example":true},"productsUpdatedInd":{"type":"boolean","description":"If present and true, the products in the host copy of the reservation have already been updated","example":true},"priceUpdatedInd":{"type":"boolean","description":"If present and true, the price in the host copy of the reservation has already been updated","example":true},"documentVoidPeriodInd":{"type":"boolean","description":"If true, when the Offer is cancelled the document will be voided.","example":true},"refundValueInd":{"type":"boolean","description":"If true, when the Offer is cancelled the document value can be refunded.","example":true},"SupplierRetainedPrice":{"$ref":"#/components/schemas/SupplierRetainedPriceDetail"},"ConsumedPrice":{"$ref":"#/components/schemas/ConsumedPriceDetail"},"ResidualPrice":{"$ref":"#/components/schemas/ResidualPriceDetail"},"AdditionalCollectionPrice":{"$ref":"#/components/schemas/AdditionalCollectionPrice"}}}]}},"components/schemas/PaidTaxesDetail":{"id":"components/schemas/PaidTaxesDetail","kind":"json-schema","title":"PaidTaxesDetail","data":{"description":"Taxes Detail contains the breakdown of individual Taxes that make up the summary total","allOf":[{"$ref":"#/components/schemas/PaidTaxes"},{"properties":{"Tax":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"TaxPercent":{"$ref":"#/components/schemas/TaxPercent"}}}]}},"components/schemas/TravelerUpdatableItems":{"id":"components/schemas/TravelerUpdatableItems","kind":"json-schema","title":"TravelerUpdatableItems","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItemsID"},{"properties":{"travelerIdentifier":{"maxLength":128,"type":"string","description":"Traveler identifier value","example":"7435"},"TravelerUpdatableItem":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TravelerUpdatableItem"}}}}]}},"components/schemas/TravelerUpdatableItem":{"id":"components/schemas/TravelerUpdatableItem","kind":"json-schema","title":"TravelerUpdatableItem","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelerUpdatableItemAddress, TravelerUpdatableItemBirthDate, TravelerUpdatableItemComments, TravelerUpdatableItemCustomerLoyalty, TravelerUpdatableItemEmail, TravelerUpdatableItemGender, TravelerUpdatableItemPersonName, TravelerUpdatableItemTelephone, TravelerUpdatableItemTravelDocument, TravelerUpdatableItemAge","example":"TravelerUpdatableItem"},"Identifier":{"maxLength":128,"type":"string","description":"A unique GUID to identify the TravelerUpdatableItem","example":"J3754"},"addableInd":{"type":"boolean","description":"If true the TravelerUpdateableItem can be added to the Traveler","example":true},"modifiableInd":{"type":"boolean","description":"If true the TravelerUpdateableItem can be modified in the Traveler","example":true},"deletableInd":{"type":"boolean","description":"If true the TravelerUpdateableItem can be deleted from the Traveler","example":true}},"discriminator":{"propertyName":"@type"}}},"components/schemas/TravelerUpdatableItemBirthDate":{"id":"components/schemas/TravelerUpdatableItemBirthDate","kind":"json-schema","title":"TravelerUpdatableItemBirthDate","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"BirthDateUpdatable":{"type":"string","description":"This birth date can be updated","format":"date"}}}]}},"components/schemas/TravelerUpdatableItemGender":{"id":"components/schemas/TravelerUpdatableItemGender","kind":"json-schema","title":"TravelerUpdatableItemGender","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"GenderUpdatable":{"$ref":"#/components/schemas/GenderEnum"}}}]}},"components/schemas/TravelerUpdatableItemCustomerLoyalty":{"id":"components/schemas/TravelerUpdatableItemCustomerLoyalty","kind":"json-schema","title":"TravelerUpdatableItemCustomerLoyalty","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"CustomerLoyalty":{"$ref":"#/components/schemas/CustomerLoyalty"}}}]}},"components/schemas/TravelerUpdatableItemTravelDocument":{"id":"components/schemas/TravelerUpdatableItemTravelDocument","kind":"json-schema","title":"TravelerUpdatableItemTravelDocument","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"TravelDocument":{"$ref":"#/components/schemas/TravelDocument"}}}]}},"components/schemas/TravelerUpdatableItemPersonName":{"id":"components/schemas/TravelerUpdatableItemPersonName","kind":"json-schema","title":"TravelerUpdatableItemPersonName","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"required":["PersonNameUpdatable"],"properties":{"PersonNameUpdatable":{"$ref":"#/components/schemas/PersonNameUpdatable"}}}]}},"components/schemas/TravelerUpdatableItemEmail":{"id":"components/schemas/TravelerUpdatableItemEmail","kind":"json-schema","title":"TravelerUpdatableItemEmail","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"Email":{"$ref":"#/components/schemas/Email"}}}]}},"components/schemas/TravelerUpdatableItemAddress":{"id":"components/schemas/TravelerUpdatableItemAddress","kind":"json-schema","title":"TravelerUpdatableItemAddress","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"Address":{"$ref":"#/components/schemas/Address"}}}]}},"components/schemas/TravelerUpdatableItemTelephone":{"id":"components/schemas/TravelerUpdatableItemTelephone","kind":"json-schema","title":"TravelerUpdatableItemTelephone","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"Telephone":{"$ref":"#/components/schemas/Telephone"}}}]}},"components/schemas/TravelerUpdatableItemComments":{"id":"components/schemas/TravelerUpdatableItemComments","kind":"json-schema","title":"TravelerUpdatableItemComments","data":{"allOf":[{"$ref":"#/components/schemas/TravelerUpdatableItem"},{"properties":{"Comments":{"$ref":"#/components/schemas/Comments"}}}]}},"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/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/OfferUpsell":{"id":"components/schemas/OfferUpsell","kind":"json-schema","title":"OfferUpsell","data":{"allOf":[{"$ref":"#/components/schemas/Offer"},{"properties":{"OfferUpsellInd":{"type":"string","description":"If true, the OfferUpsell contains ancillary offerings offered in connection with the ParentOffer","example":"true"}}}]}},"components/schemas/BuildAncillaryOffersFromCatalogOfferingsAirSeat":{"id":"components/schemas/BuildAncillaryOffersFromCatalogOfferingsAirSeat","kind":"json-schema","title":"BuildAncillaryOffersFromCatalogOfferingsAirSeat","data":{"allOf":[{"$ref":"#/components/schemas/BuildAncillaryOffersFromCatalogOfferings"},{"required":["SeatAssignment"],"properties":{"SeatAssignment":{"maxLength":32,"type":"string","description":"The specific seat number to be assigned to a Traveler"}}}]}},"components/schemas/ParentOfferAir":{"id":"components/schemas/ParentOfferAir","kind":"json-schema","title":"ParentOfferAir","data":{"allOf":[{"$ref":"#/components/schemas/ParentOffer"},{"properties":{"FlightSegmentRef":{"type":"string"}}}]}},"components/schemas/PreferenceAirSeat":{"id":"components/schemas/PreferenceAirSeat","kind":"json-schema","title":"PreferenceAirSeat","data":{"allOf":[{"$ref":"#/components/schemas/Preference"},{"required":["SeatLocation"],"properties":{"SeatLocation":{"$ref":"#/components/schemas/SeatLocationEnum"}}}]}},"components/schemas/SeatLocationEnum":{"id":"components/schemas/SeatLocationEnum","kind":"json-schema","title":"SeatLocationEnum","data":{"type":"string","description":"Window, aisle, middle, etc.","enum":["Aisle","Window","Middle"]}},"components/schemas/ReservationBuildFromProducts":{"id":"components/schemas/ReservationBuildFromProducts","kind":"json-schema","title":"ReservationBuildFromProducts","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This single payload function supports AutoPrice, ManualPrice, and UnpricedSegment workflows. Pass the required flight information in ProductCriteriaAir."},"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":"For AutoPrice add additional pricing modifiers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ManualPrice pass the Manual Price object. This cannot be combined with PricingModifiersAir."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For booking unpriced segments send ProductCriteriaAir with the bookAsUnpricedSegmentInd."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/ReservationBuild"},{"required":["ProductCriteriaAir"],"properties":{"ProductCriteriaAir":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ProductCriteriaAir"}},"PricingModifiersAir":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/PricingModifiersAir"}},"ManualPrice":{"$ref":"#/components/schemas/ManualPrice"},"bookAsUnpricedSegmentsInd":{"type":"boolean","description":"If true, the flights sent in ProductCriteriaAir will be booked as unpriced segments. An Offer will not be created."}}}]}},"components/schemas/ReservationBuildFromCatalogOfferingsAir":{"id":"components/schemas/ReservationBuildFromCatalogOfferingsAir","kind":"json-schema","title":"ReservationBuildFromCatalogOfferingsAir","data":{"allOf":[{"$ref":"#/components/schemas/ReservationBuildFromCatalogOfferings"},{"required":["PricingModifiersAir"],"properties":{"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"}}}]}},"components/schemas/BuildFromCatalogOfferingsRequestAir":{"id":"components/schemas/BuildFromCatalogOfferingsRequestAir","kind":"json-schema","title":"BuildFromCatalogOfferingsRequestAir","data":{"description":"reference path payload used to build an Offer","allOf":[{"$ref":"#/components/schemas/BuildFromCatalogOfferingsRequest"},{"properties":{"PricingModifiersAir":{"$ref":"#/components/schemas/PricingModifiersAir"},"SegmentSequence":{"type":"array","description":"The segmentSequence within the product the action is being requested for. Used when multiple flights exist within a product. Only one product may be selected with this option.","example":[1],"items":{"type":"integer","format":"int32"}}}}]}},"components/schemas/BuildFromOfferAir":{"id":"components/schemas/BuildFromOfferAir","kind":"json-schema","title":"BuildFromOfferAir","data":{"allOf":[{"$ref":"#/components/schemas/BuildFromOffer"},{"properties":{"SegmentSequence":{"type":"array","description":"The segmentSequence within the product the action is being requested for. Used when multiple in a product","example":[2,6,8],"items":{"type":"integer","format":"int32"}}}}]}},"components/schemas/OfferConstructionReservation":{"id":"components/schemas/OfferConstructionReservation","kind":"json-schema","title":"OfferConstructionReservation","data":{"allOf":[{"$ref":"#/components/schemas/OfferConstruction"},{"properties":{"travelerRefs":{"type":"array","description":"GDS only; not supported for NDC.  \nFor full payload book or workbench Add Offer. References the traveler id passed in the full payload request or the existing traveler id in the workbench.  \nWhen building the request, send the travelerRef id/s of one or more traveler/s to apply the fare in PricingModifiersAir to.","example":"traveler_1","items":{"type":"string"}}}}]}},"components/schemas/OfferConstruction":{"id":"components/schemas/OfferConstruction","kind":"json-schema","title":"OfferConstruction","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator options OfferConstructionPrice or OfferConstructionReservation.","example":"OfferConstructionReservation"},"specificFlightCriteriaRefs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References the SpecificFlightCriteria id passed in the 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":"At AirPrice: Send to request pricing for one or more specific segments. Must match a custom flight identifier value (such as f1, f2, and so on) sent in SpecificFlightCriteria/id."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At Add Offer: Send the SpecificFlightCriteria id of the segment/s to apply the fare in PricingModifiersAir to."},"children":[]}]}]}]}],"example":"specificFlightCriteria_1","items":{"type":"string"}},"pricingModifiersAirRefs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References the pricingModifiers associated to this OfferConstruction."},"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":"Add Offer: Send the standard PricingModifiersAir object to specify the fare to apply to this traveler, segment, or both."},"children":[]}]}]}]}],"items":{"type":"string"}},"customResponseModifiersAirRefs":{"type":"array","description":"References the custom response modifiers air associated to this OfferConstruction.","items":{"type":"string"}}},"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":"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":"At AirPrice Full Payload, send to request pricing for specific passenger/s and/or air segment/s."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must also send PassengerCriteria/id, SpecificFlightCriteria/id, BuildFromProductsRequest with @type BuildFromProductsRequestOfferConstruction, and PricingModifiersAir/OrganizationInformation with the value Account. No other pricing modifiers are supported with OfferConstruction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Add Offer Full Payload, send to file separate fares by either traveler, segment, or both."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must include either all travelerRefs, all specificFlightCriteriaRefs, or all of both, as well as PricingModifiersAir."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After booking, fares can be autopriced as needed with the Autoprice / Manual Fare API."},"children":[]}]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/OfferConstructionPrice":{"id":"components/schemas/OfferConstructionPrice","kind":"json-schema","title":"OfferConstructionPrice","data":{"allOf":[{"$ref":"#/components/schemas/OfferConstruction"},{"properties":{"passengerCriteriaRefs":{"type":"array","description":"GDS only; not supported for NDC.  \nSend to request pricing for one or more specific passengers. Must match a custom passenger identifier value sent in PassengerCriteria/id.  ","example":"passengerCriteria_1","items":{"type":"string"}}}}]}},"components/schemas/TicketDetail":{"id":"components/schemas/TicketDetail","kind":"json-schema","title":"TicketDetail","data":{"description":"The extended class of Ticket.","allOf":[{"$ref":"#/components/schemas/Ticket"},{"properties":{"SellAmount":{"$ref":"#/components/schemas/AlternateAmount"},"PricingPCC":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string"}}}]}},"components/schemas/TicketSummary":{"id":"components/schemas/TicketSummary","kind":"json-schema","title":"TicketSummary","data":{"deprecated":true,"allOf":[{"$ref":"#/components/schemas/Ticket"}]}},"components/schemas/EMDSummary":{"id":"components/schemas/EMDSummary","kind":"json-schema","title":"EMDSummary","data":{"allOf":[{"$ref":"#/components/schemas/EMD"}]}},"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/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/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/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/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/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/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/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/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/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/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/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/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/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. When calculating a nights-based cancellation penalty (HotelPenaltyNights), be aware that the hotel's own charge may be based on either the actual nightly rate(s) for the specific nights covered by the penalty, or on the average nightly rate multiplied by the penalty night count. The response does not indicate which method applies. A calculation performed from NightlyRate should be treated as a best-effort estimate and may not exactly match the amount the hotel ultimately charges."}},"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/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. In current hotel supplier responses this array will contain a single CurrencyAmount entry. A second entry is reserved for future use and should not be expected in typical responses.","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","description":"A pre-calculated penalty amount, when returned by the supplier, representing Percent already applied to the relevant nights. When present, use this value directly rather than recalculating from Offer.Price.Base.","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/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/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/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/PropertyAddress":{"id":"components/schemas/PropertyAddress","kind":"json-schema","title":"PropertyAddress","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/Address"}]}},"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/ProductVehicle":{"id":"components/schemas/ProductVehicle","kind":"json-schema","title":"ProductVehicle","data":{"allOf":[{"$ref":"#/components/schemas/Product"},{"properties":{"Vehicle":{"$ref":"#/components/schemas/VehicleDetail"}}}]}},"components/schemas/VehicleDetail":{"id":"components/schemas/VehicleDetail","kind":"json-schema","title":"VehicleDetail","data":{"allOf":[{"$ref":"#/components/schemas/Vehicle"},{"properties":{"VehicleDateLocation":{"$ref":"#/components/schemas/VehicleDateLocation"}}}]}},"components/schemas/Vehicle":{"id":"components/schemas/Vehicle","kind":"json-schema","title":"Vehicle","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"VehicleDetail"},"TransmissionTypeCode":{"$ref":"#/components/schemas/Code"},"VehicleCategoryCode":{"$ref":"#/components/schemas/Code"},"FuelTypeCode":{"$ref":"#/components/schemas/Code"},"VehicleSizeCode":{"$ref":"#/components/schemas/Code"},"VehicleClassCode":{"$ref":"#/components/schemas/Code"},"baggageQuantity":{"type":"integer","description":"Baggage Quantity that is able to fit into the car with passengers","format":"int32"},"passengerQuantity":{"maxLength":32,"type":"string","description":"Assigned Type: c-1100:StringTiny"},"doorCount":{"maxLength":32,"type":"string","description":"The number of doors for the vehicle"},"Image":{"$ref":"#/components/schemas/Image"},"VehicleMakeModel":{"$ref":"#/components/schemas/VehicleMakeModel"},"airConditioningInd":{"type":"boolean","description":"True if vehicle has air conditioning"}},"description":"Vehicles such as rental cars, buses, trams, motorcycles.","discriminator":{"propertyName":"@type"}}},"components/schemas/VehicleMakeModel":{"id":"components/schemas/VehicleMakeModel","kind":"json-schema","title":"VehicleMakeModel","data":{"properties":{"value":{"maxLength":128,"type":"string"},"code":{"maxLength":4,"minLength":4,"type":"string","description":"The 4 character code for the make and model of the vehicle.","example":"ECMR"},"supplierReference":{"maxLength":64,"type":"string"},"codeContext":{"maxLength":32,"type":"string","description":"Code context","example":"ISO"},"vendorCode":{"maxLength":2,"minLength":2,"pattern":"([a-zA-Z0-9]{2,2})","type":"string","description":"The 2 character vendor code","example":"ZI"},"operatingSupplierCode":{"maxLength":32,"type":"string"},"operatingSupplierName":{"maxLength":32,"type":"string"}},"description":"The make and model of the vehicle along with a description"}},"components/schemas/VehicleDateLocation":{"id":"components/schemas/VehicleDateLocation","kind":"json-schema","title":"VehicleDateLocation","data":{"required":["@type","RentalPickup","RentalReturn"],"properties":{"@type":{"type":"string","example":"VehicleDateLocation"},"RentalPickup":{"$ref":"#/components/schemas/RentalPickup"},"RentalReturn":{"$ref":"#/components/schemas/RentalReturn"}},"description":"Pickup, return and vendor datetime and locations."}},"components/schemas/RentalPickup":{"id":"components/schemas/RentalPickup","kind":"json-schema","title":"RentalPickup","data":{"required":["@type","VendorLocation","date","time"],"properties":{"@type":{"type":"string","example":"RentalPickup"},"date":{"type":"string","description":"The local date of the pickup or return","format":"date","example":"2024-10-23"},"time":{"type":"string","description":"The local time of the pickup or return"},"timeString":{"maxLength":32,"type":"string","deprecated":true},"VendorLocation":{"$ref":"#/components/schemas/VendorLocation"},"GeoLocation":{"$ref":"#/components/schemas/GeoLocation"}}}},"components/schemas/VendorLocation":{"id":"components/schemas/VendorLocation","kind":"json-schema","title":"VendorLocation","data":{"required":["@type","code"],"properties":{"@type":{"type":"string","example":"VendorLocation"},"rentalLocationNumber":{"maxLength":5,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"Assigned Type: ctvh-1100:RentalLocationNumber"},"vendorCode":{"maxLength":2,"minLength":2,"pattern":"([a-zA-Z0-9]{2,2})","type":"string","description":"The two character vendor code","example":"ZI"},"RentalLocationCode":{"description":"Locations based on the OTA VWF list","allOf":[{"$ref":"#/components/schemas/Code"}]},"CounterLocationCode":{"description":"Counter location of the vehicle rental","allOf":[{"$ref":"#/components/schemas/Code"}]},"rentalLocationName":{"maxLength":128,"type":"string","description":"Assigned Type: c-1100:StringShort"},"code":{"maxLength":6,"minLength":3,"pattern":"([a-zA-Z0-9]{3,6})","type":"string","description":"The vendor location code"},"Address":{"$ref":"#/components/schemas/Address"},"Telephone":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/Telephone"}},"Description":{"maxLength":1024,"type":"string","description":"Detailed location information on where to pick up and return a vehicle"},"OperationTimes":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/OperationTimes"}},"Directions":{"maxLength":512,"type":"string","description":"Directions for collecting the vehicle"},"AdditionalInstructions":{"maxLength":512,"type":"string","description":"Additional instructions regarding the vendor location"},"ShuttleService":{"maxLength":512,"type":"string","description":"Information on shuttle service"}},"description":"The vendor's location number for pickup or return"}},"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/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/RentalReturn":{"id":"components/schemas/RentalReturn","kind":"json-schema","title":"RentalReturn","data":{"required":["@type","VendorLocation","date","time"],"properties":{"@type":{"type":"string","example":"RentalReturn"},"date":{"type":"string","description":"The local date of the pickup or return","format":"date","example":"2024-10-23"},"time":{"type":"string","description":"The local time of the pickup or return","example":"54000"},"VendorLocation":{"$ref":"#/components/schemas/VendorLocation"},"GeoLocation":{"$ref":"#/components/schemas/GeoLocation"}}}},"components/schemas/ProductAncillaryVehicle":{"id":"components/schemas/ProductAncillaryVehicle","kind":"json-schema","title":"ProductAncillaryVehicle","data":{"allOf":[{"$ref":"#/components/schemas/ProductAncillary"},{"required":["EquipmentTypeCode"],"properties":{"EquipmentTypeCode":{"description":"The type of vehicle Ancillary","allOf":[{"$ref":"#/components/schemas/Code"}]},"freeQuantityIncludedInPrice":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The mount of this ancillary that is included with the vehicle rental","format":"int32"},"maxBookableQuantity":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The maximum amount of this ancillary that may be booked with the vehicle rental","format":"int32"}}}]}},"components/schemas/PriceBreakdownVehiclePrice":{"id":"components/schemas/PriceBreakdownVehiclePrice","kind":"json-schema","title":"PriceBreakdownVehiclePrice","data":{"allOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"required":["VehiclePrice"],"properties":{"VehiclePrice":{"$ref":"#/components/schemas/VehiclePrice"},"rateGuaranteedInd":{"type":"boolean"}}}]}},"components/schemas/VehiclePrice":{"id":"components/schemas/VehiclePrice","kind":"json-schema","title":"VehiclePrice","data":{"required":["@type","SupplierRate"],"properties":{"@type":{"type":"string","example":"VehiclePrice"},"id":{"type":"string","description":"Internal ID"},"rateSource":{"maxLength":32,"type":"string","description":"Assigned Type: c-1100:StringTiny"},"rateGuaranteedInd":{"type":"boolean","description":"Assigned Type: c-1100:OptionalIndicator"},"ratePeriod":{"$ref":"#/components/schemas/RatePeriodEnum"},"RateDistance":{"$ref":"#/components/schemas/RateDistance"},"RateDescription":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TextBlock"}},"RateAvailability":{"$ref":"#/components/schemas/RateAvailabilityEnum"},"SupplierRate":{"$ref":"#/components/schemas/SupplierRate"},"ApproximateRate":{"$ref":"#/components/schemas/ApproximateRate"},"CustomerLoyalty":{"$ref":"#/components/schemas/CustomerLoyalty"},"RateQualifier":{"$ref":"#/components/schemas/RateQualifierEnum"}},"description":"Rate summary for rental of the vehicle."}},"components/schemas/RatePeriodEnum":{"id":"components/schemas/RatePeriodEnum","kind":"json-schema","title":"RatePeriodEnum","data":{"type":"string","description":"The time period for a rate such as daily, weekly, monthly","enum":["Hour","Day","Week","Month","Year","Total","RentalPeriod","Weekend","Bundle","Package","ExtraHour","ExtraDay","ExtraWeek","ExtraMonth","Other"]}},"components/schemas/RateDistance":{"id":"components/schemas/RateDistance","kind":"json-schema","title":"RateDistance","data":{"properties":{"value":{"type":"number","format":"float"},"unlimitedDistanceInd":{"type":"boolean","description":" if true unlimited miles is included with the rental"},"requestedCodeAppliedInd":{"type":"boolean","description":"if true, the requested code has been applied"},"allowance":{"type":"integer","description":"The distance allowance permitted with this rate. Use in combination with distanceUnits and ratePeriod","format":"int32"},"distanceUnits":{"$ref":"#/components/schemas/UnitOfDistanceEnum"},"ratePeriod":{"$ref":"#/components/schemas/RatePeriodEnum"}},"description":"Rate for the period defined by the attributes"}},"components/schemas/RateAvailabilityEnum":{"id":"components/schemas/RateAvailabilityEnum","kind":"json-schema","title":"RateAvailabilityEnum","data":{"type":"string","description":"Options are available to sell, need to call, or closed","example":"Available","enum":["Available","NeedToCall","Closed"]}},"components/schemas/SupplierRate":{"id":"components/schemas/SupplierRate","kind":"json-schema","title":"SupplierRate","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"SupplierRate"},"BaseRate":{"$ref":"#/components/schemas/CurrencyAmount"},"RateForPeriod":{"$ref":"#/components/schemas/CurrencyAmount"},"DropOffCharge":{"$ref":"#/components/schemas/CurrencyAmount"},"ExtraMileageCharge":{"$ref":"#/components/schemas/CurrencyAmount"},"EstimatedTotalAmount":{"$ref":"#/components/schemas/CurrencyAmount"}},"description":"Estimated total amount - Monetary amounts expressed in another currency."}},"components/schemas/ApproximateRate":{"id":"components/schemas/ApproximateRate","kind":"json-schema","title":"ApproximateRate","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"ApproximateRate"},"BaseRate":{"$ref":"#/components/schemas/CurrencyAmount"},"RateForPeriod":{"$ref":"#/components/schemas/CurrencyAmount"},"DropOffCharge":{"$ref":"#/components/schemas/CurrencyAmount"},"ExtraMileageCharge":{"$ref":"#/components/schemas/CurrencyAmount"},"EstimatedTotalAmount":{"$ref":"#/components/schemas/CurrencyAmount"}},"description":"Estimated total amount - Monetary amounts expressed in another currency."}},"components/schemas/RateQualifierEnum":{"id":"components/schemas/RateQualifierEnum","kind":"json-schema","title":"RateQualifierEnum","data":{"type":"string","description":"A closed enumeration of possible rate qualifiers for vehicle rental","example":"PrePayment","enum":["Other","PostPayment","Guarantee","PrePayment","Deposit"]}},"components/schemas/PriceBreakdownVehicleDeposit":{"id":"components/schemas/PriceBreakdownVehicleDeposit","kind":"json-schema","title":"PriceBreakdownVehicleDeposit","data":{"allOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"properties":{"totalPayableNowInd":{"type":"boolean","description":"If True the Amount is the total amount payable now"},"totalPayableLaterInd":{"type":"boolean","description":"If True the Amount is the total amount payable later"}}}]}},"components/schemas/PriceBreakdownAncillaryVehicle":{"id":"components/schemas/PriceBreakdownAncillaryVehicle","kind":"json-schema","title":"PriceBreakdownAncillaryVehicle","data":{"allOf":[{"$ref":"#/components/schemas/PriceBreakdownAncillary"},{"properties":{"RatePeriod":{"$ref":"#/components/schemas/RatePeriodEnum"},"payNowInd":{"type":"boolean","description":"If true the vehicle ancillary must be paid now and is included in the totalPrice calculation"},"includedInEstimatedTotalInd":{"type":"boolean","description":"If true the AncillaryVehicle is included in the estimated totalPrice."}}}]}},"components/schemas/PriceBreakdownVehicleCharges":{"id":"components/schemas/PriceBreakdownVehicleCharges","kind":"json-schema","title":"PriceBreakdownVehicleCharges","data":{"allOf":[{"$ref":"#/components/schemas/PriceBreakdown"},{"properties":{"VehicleCharges":{"$ref":"#/components/schemas/VehicleCharges"}}}]}},"components/schemas/VehicleCharges":{"id":"components/schemas/VehicleCharges","kind":"json-schema","title":"VehicleCharges","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"VehicleCharges"},"description":{"maxLength":512,"type":"string","description":"Assigned Type: c-1100:String"},"VehicleChargePurposeCode":{"$ref":"#/components/schemas/Code"},"ratePeriod":{"$ref":"#/components/schemas/RatePeriodEnum"},"rateChargeInfo":{"maxLength":512,"type":"string","description":"Assigned Type: c-1100:String"},"RateCategory":{"$ref":"#/components/schemas/RateCategoryEnum"},"VehicleCoverageTypeCode":{"description":"The OTA code defined for the Vehicle Coverage Type","allOf":[{"$ref":"#/components/schemas/Code"}]},"Calculation":{"maxItems":3,"type":"array","items":{"$ref":"#/components/schemas/Calculation"}},"taxInclusiveInd":{"type":"boolean"},"guaranteedInd":{"type":"boolean"},"payNowInd":{"type":"boolean","description":"If true the vehicle charge must be paid now and is included in the totalPrice calculation"},"includedInEstimatedTotalInd":{"type":"boolean"},"includedInBaseRateInd":{"type":"boolean","description":"If true the Vehicle Charge has been included in the base rate of the Vehicle price"}}}},"components/schemas/Calculation":{"id":"components/schemas/Calculation","kind":"json-schema","title":"Calculation","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"Calculation"},"UnitAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"UnitName":{"$ref":"#/components/schemas/RatePeriodEnum"},"Quantity":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The quantity used in the calculation of the vehicle charge e.g 2 x $500 per week"},"children":[]}]}]}],"format":"int32"},"MaxQuantity":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum quantity allowed for a charge e.g Baby seat charged at $10 per day for a maximum of 10 days"},"children":[]}]}]}],"format":"int32"},"TotalAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"Percent":{"minimum":0,"exclusiveMinimum":false,"type":"number","description":"Used when the charge is based on a percentage of a TotalAmount","format":"float"},"Applicability":{"$ref":"#/components/schemas/Comment"}},"description":"How the vehicle rate or charge was calculated."}},"components/schemas/TermsAndConditionsFullVehicle":{"id":"components/schemas/TermsAndConditionsFullVehicle","kind":"json-schema","title":"TermsAndConditionsFullVehicle","data":{"allOf":[{"$ref":"#/components/schemas/TermsAndConditionsFull"},{"properties":{"TermsAndConditionsSubCategory":{"$ref":"#/components/schemas/TextBlock"},"DriverInfo":{"$ref":"#/components/schemas/DriverInfo"},"ProductRateCodeInfo":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/ProductRateCodeInfo"}},"Policy":{"$ref":"#/components/schemas/Policy"},"flightRestrictionInd":{"type":"boolean","description":"if true, the traveler must have a valid flight to qualify for this Offer"}}}]}},"components/schemas/DriverInfo":{"id":"components/schemas/DriverInfo","kind":"json-schema","title":"DriverInfo","data":{"required":["age"],"properties":{"age":{"maximum":99,"minimum":18,"type":"integer","description":"the age of the driver from 18 - 99","format":"int32","example":52},"countryOfDocIssue":{"pattern":"[a-zA-Z]{2}","type":"string","description":"The country code that issued the document"}},"description":"Basic information (metadata) about the intended driver of the vehicle"}},"components/schemas/Policy":{"id":"components/schemas/Policy","kind":"json-schema","title":"Policy","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"Policy"},"title":{"maxLength":512,"type":"string","description":"Assigned Type: c-1100:String"},"TextFormatted":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/TextFormatted"}},"SubPolicy":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/SubPolicy"}}},"description":"A rule or guideline relating to the vehicle rental."}},"components/schemas/SubPolicy":{"id":"components/schemas/SubPolicy","kind":"json-schema","title":"SubPolicy","data":{"required":["@type"],"properties":{"@type":{"type":"string","example":"SubPolicy"},"title":{"maxLength":512,"type":"string","description":"Assigned Type: c-1100:String"},"id":{"type":"string"},"TextFormatted":{"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/TextFormatted"}}}}},"components/schemas/OfferStatusVehicle":{"id":"components/schemas/OfferStatusVehicle","kind":"json-schema","title":"OfferStatusVehicle","data":{"allOf":[{"$ref":"#/components/schemas/OfferStatus"},{"properties":{"Status":{"$ref":"#/components/schemas/OfferStatusEnum"}}}]}},"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_382":{"kind":"json-schema","data":{"maxLength":89,"minLength":10,"type":"string","example":"TraceID_123456789"},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"maxLength":36,"minLength":36,"pattern":"([a-zA-Z-0-9-_]*)","type":"string","example":"19Y88702-C27A-4E5D-829A-89D7016688B1"},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"maxLength":100,"minLength":0,"pattern":"([a-zA-Z-0-9-_]*)","type":"string","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z\\d]{3,4}_\\w{2}$","type":"string","example":"DU7_1G"},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"type":"string"},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"type":"object","additionalProperties":true},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"[\"offer_1\"]"}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"[\"product_1\"]"}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"[\"flight_1\"]"}},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"array","items":{"maxLength":32,"type":"string","example":"[\"Penalties\"]"}},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"maxLength":32,"type":"string","example":"Structured"},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"maxLength":1024,"type":"string","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"string","example":"cpo_01234"},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"maxLength":32,"type":"string","example":"LongText"},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"maxLength":16,"pattern":"([A-Z0-9]+)?","type":"string","example":"ABC123"},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"maxLength":32,"type":"string","example":"GDS"},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"1G"},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"GDS"},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","example":"31"},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"1253300123456"},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"1253303123456"},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"maxLength":128,"type":"string"},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"string","enum":["Ticket","BackOffice","All","Invoice"]},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"string","enum":["Retain","Refund","Forfeit","Void"]},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"382c74c3-721d-4f34-80e5-57657b6cbc27"},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"string","example":"accounting_123"},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"maxLength":512,"type":"string","example":"1 ,2, 3"},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"string","example":"reservationcomment_123"},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"maxLength":512,"type":"string","example":"1, 2, 3"},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"string","example":"specialservice_123"},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"type":"string","example":"primary_001"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"1259900123456"},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"DVZJ8M"},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"TVPT"},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"$ref":"#/components/schemas/IdentifierTypeENUM"},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DocumentTypeEnum"},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"string","enum":["Cancellation","Payment","ConfirmationHold","ConfirmationTicket","ConfirmationVehicle"]},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"maxLength":8,"type":"string","example":"ABC123"},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"string","example":"59f58f5f-c443-43b4-9f5d-be999fd00a01"},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"maxLength":1024,"type":"string","example":"offer_1"},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"ABC123"},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"type":"string","example":"payment_1"},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"agency_001"},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"address_001"},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"email_001"},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"maxLength":128,"type":"string","example":"telephone_001"},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"string","example":"0XS4"},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"type":"array","items":{"maxLength":10,"type":"string","example":"CORPCODE"}},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":1},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"maxLength":32,"type":"string","example":"ABC123456"},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"type":"string","example":"offer_1"},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"maxLength":32,"type":"string","example":"detail"},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"string","example":"All","enum":["Ticket","BackOffice","All","Invoice"]},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"$ref":"#/components/schemas/OfferTypeENUM"},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"maxLength":32,"type":"string","example":"offer_1"},"id":"schema_443"}},"exampleStore":{"paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-19","From":{"value":"LAX"},"To":{"value":"JNB"}},{"@type":"SearchCriteriaFlight","arrivalDate":"2026-12-29","From":{"value":"JNB"},"To":{"value":"LAX"}}],"SearchModifiersAir":{"@type":"SearchModifiersAir","ConnectionPreferences":[{"@type":"ConnectionPreferences","preferenceType":"Permitted","legSequence":[1],"ConnectionPoint":["AMS"]},{"@type":"ConnectionPreferences","preferenceType":"Prohibited","legSequence":[2],"ConnectionPoint":["FRA"]}]}}},"key":"air_availability","summary":"Round trip with optional modifiers","id":"paths/~1air~1search~1airAvailability/post/requestBody/content/application~1json/examples/air_availability"},"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","maxNumberOfUpsellsToReturn":1,"offersPerPage":15,"contentSourceList":["GDS"],"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"age":25,"passengerTypeCode":"ADT"}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-20","From":{"value":"DEN"},"To":{"value":"ORD"}},{"@type":"SearchCriteriaFlight","departureDate":"2026-12-27","From":{"value":"ORD"},"To":{"value":"DEN"}}],"SearchModifiersAir":{"@type":"SearchModifiersAir","CarrierPreference":[{"@type":"CarrierPreference","preferenceType":"Preferred","carriers":["UA"]}]}}},"key":"GDS_RoundTrip_JourneyBased","summary":"GDS round trip journey-based search with CarrierPreference","id":"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_JourneyBased"},"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","maxNumberOfUpsellsToReturn":4,"offersPerPage":10,"contentSourceList":["NDC"],"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-21","From":{"value":"HKG"},"To":{"value":"SIN"}}],"SearchModifiersAir":{"@type":"SearchModifiersAir","CarrierPreference":[{"@type":"CarrierPreference","preferenceType":"Permitted","carriers":["SQ"]}]}}},"key":"NDC_OneWay","summary":"NDC one way search with one permitted carrier","id":"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/NDC_OneWay"},"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","maxNumberOfUpsellsToReturn":0,"contentSourceList":["GDS"],"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT","TravelerGeographicLocation":{"travelerGeographicLocationType":"City","value":"LON"}},{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"CNN","age":8}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-13","DepartureTimeRange":{"start":"10:00:00","end":"13:00:00"},"From":{"value":"LGW"},"To":{"value":"SIN"}}],"SearchModifiersAir":{"@type":"SearchModifiersAir","CabinPreference":[{"@type":"CabinPreference","preferenceType":"Permitted","cabins":["Business"]}],"ConnectionPreferences":[{"@type":"ConnectionPreferencesAir","preferenceType":"Prohibited","ConnectionPoint":["LON","MIL","ROM"],"FlightType":{"@type":"FlightType","connectionType":"NonStopDirect"}}]},"PricingModifiersAir":{"@type":"PricingModifiersAir","currencyCode":"USD","FareSelection":{"@type":"FareSelectionDetail","refundableOnlyInd":true}}}},"key":"GDS_OneWay","summary":"GDS one way search with multiple modifiers and no upsells","id":"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_OneWay"},"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","maxNumberOfUpsellsToReturn":4,"contentSourceList":["GDS"],"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"age":25,"passengerTypeCode":"ADT"}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-21","From":{"value":"SYD"},"To":{"value":"MEL"}},{"@type":"SearchCriteriaFlight","departureDate":"2026-11-28","From":{"value":"MEL"},"To":{"value":"SYD"}}],"SearchModifiersAir":{"@type":"SearchModifiersAir","CarrierPreference":[{"@type":"CarrierPreference","preferenceType":"Permitted","carriers":["QF"]}]},"CustomResponseModifiersAir":{"@type":"CustomResponseModifiersAir","SearchRepresentation":"Leg"}}},"key":"GDS_RoundTrip_LegBased","summary":"GDS round trip leg based","id":"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/GDS_RoundTrip_LegBased"},"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","offersPerPage":999,"contentSourceList":["GDS"],"maxNumberOfUpsellsToReturn":0,"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"},{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"INF"}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-23","From":{"value":"SYD"},"To":{"value":"CHC"}},{"@type":"SearchCriteriaFlight","departureDate":"2026-11-27","From":{"value":"CHC"},"To":{"value":"SYD"}}],"PricingModifiersAir":{"@type":"PricingModifiersAir","includeSplitPaymentInd":true}}},"key":"Split_Ticketing","summary":"Split ticketing request","id":"paths/~1air~1catalog~1search~1catalogproductofferings/post/requestBody/content/application~1json/examples/Split_Ticketing"},"paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch":{"value":{"@type":"CatalogProductOfferingsQueryBuildNext","BuildFromCatalogProductOfferingsRequest":{"@type":"BuildFromCatalogProductOfferingsRequest","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"29db38d6-0a86-45de-be4d-5310ab0bbffa"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"o1"}},"ProductIdentifier":[{"Identifier":{"value":"p10"}}]}]}},"key":"NextLegSearch","summary":"Next leg search request","id":"paths/~1air~1catalog~1search~1catalogproductofferings~1buildnext/post/requestBody/content/application~1json/examples/NextLegSearch"},"paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS":{"value":{"@type":"CatalogProductOfferingsQueryBuildOptions","BuildOptions":{"@type":"BuildOptionsFromProducts","maxNumberOfUpsellsToReturn":99,"BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"age":25,"passengerTypeCode":"ADT"}],"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"405","carrier":"QF","departureDate":"2026-11-02","departureTime":"06:30:00","arrivalDate":"2026-11-02","arrivalTime":"08:05:00","from":"SYD","to":"MEL","classOfService":"E","cabin":"Economy","segmentSequence":1,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]},{"SpecificFlightCriteria":[{"flightNumber":"422","carrier":"QF","departureDate":"2026-11-09","departureTime":"09:00:00","arrivalDate":"2026-11-09","arrivalTime":"10:25:00","from":"MEL","to":"SYD","classOfService":"E","cabin":"Economy","segmentSequence":2,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]}]}}},"key":"GDS_FSLS","summary":"GDS flight specific led search","id":"paths/~1air~1catalog~1search~1catalogproductofferings~1buildoptions/post/requestBody/content/application~1json/examples/GDS_FSLS"},"paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","contentSourceList":["GDS"],"maxNumberOfUpsellsToReturn":4,"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"}],"SearchCriteriaFlight":[{"departureDate":"2026-11-29","daysBeforeDeparture":1,"daysAfterDeparture":2,"From":{"value":"PEN"},"To":{"value":"MEL"}},{"departureDate":"2026-12-04","daysBeforeDeparture":2,"daysAfterDeparture":1,"From":{"value":"MEL"},"To":{"value":"PEN"}}]}},"key":"GDS_RoundTrip_FlexDates","summary":"GDS round trip with flexible dates","id":"paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_RoundTrip_FlexDates"},"paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency":{"value":{"@type":"CatalogProductOfferingsQueryRequest","CatalogProductOfferingsRequest":{"@type":"CatalogProductOfferingsRequestAir","contentSourceList":["GDS"],"maxNumberOfUpsellsToReturn":0,"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"},{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"CHD"}],"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-29","From":{"value":"MOW"},"To":{"value":"DXB"}}],"PricingModifiersAir":{"@type":"PricingModifiersAir","FareSelection":{"@type":"FareSelectionDetail","fareType":"PrivateFaresOnly"},"MultiPricingAgency":["DU7","EA9"]},"CustomResponseModifiersAir":{"@type":"CustomResponseModifiersAir","SearchRepresentation":"Journey","includeFareCalculationInd":false}}},"key":"GDS_OneWay_PrivateFares_and_multi_agency","summary":"GDS one way with private fares and multi agency","id":"paths/~1air~1catalog~1search~1catalogproductofferings~1premiumflex/post/requestBody/content/application~1json/examples/GDS_OneWay_PrivateFares_and_multi_agency"},"paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS":{"value":{"@type":"CatalogProductOfferingsQueryBuildOptions","BuildOptions":{"@type":"BuildOptionsFromProducts","maxNumberOfUpsellsToReturn":99,"BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"age":25,"passengerTypeCode":"ADT"}],"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"405","carrier":"QF","departureDate":"2026-11-02","departureTime":"06:30:00","arrivalDate":"2026-11-02","arrivalTime":"08:05:00","from":"SYD","to":"MEL","classOfService":"E","cabin":"Economy","segmentSequence":1,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]},{"SpecificFlightCriteria":[{"flightNumber":"422","carrier":"QF","departureDate":"2026-11-09","departureTime":"09:00:00","arrivalDate":"2026-11-09","arrivalTime":"10:25:00","from":"MEL","to":"SYD","classOfService":"E","cabin":"Economy","segmentSequence":2,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]}],"PricingModifiersAir":{"@type":"PricingModifiersAir","fareSelection":{"@type":"FareSelectionDetail","fareType":"PrivateFaresOnly"},"MultiPricingAgency":["DU7","EA9"]},"CustomResponseModifiersAir":{"SearchRepresentation":"Journey","includeFareCalculationInd":false}}}},"key":"GDS_flex_FSLS","summary":"GDS flex flight specific led search - premium","id":"paths/~1air~1catalog~1search~1catalogproductofferings~1buildpremiumflexoptions/post/requestBody/content/application~1json/examples/GDS_flex_FSLS"},"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","BuildFromCatalogProductOfferingsRequest":{"@type":"BuildFromCatalogProductOfferingsRequestAir","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"27b2c0df-6d1f-4aaa-addb-d84b8a7727b2"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"QF_CPO0"}},"ProductBrandOfferingIdentifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"TVPT"},"ProductIdentifier":[{"Identifier":{"value":"QFp26"}}]}],"PricingModifiersAir":{"@type":"PricingModifiersAir","FareSelection":{"@type":"FareSelection"},"OrganizationInformation":{"OrganizationIdentifier":[{"supplier":"QF","type":"Account","value":"FLX50"}]}}}},"key":"NDC_with_Organization_AccountCode","summary":"NDC request with organization information - account code","id":"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_Organization_AccountCode"},"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","BuildFromCatalogProductOfferingsRequest":{"@type":"BuildFromCatalogProductOfferingsRequestAir","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"bfb9388c-8a72-49aa-af37-7de740611a0f"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"o1"}},"ProductIdentifier":[{"Identifier":{"value":"p0"}}]}],"PricingModifiersAir":{"@type":"PricingModifiersAir","SellCity":"DEN"}}},"key":"NDC_SellCity_Pricing_modifier","summary":"NDC with SellCity pricing modifier","id":"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_SellCity_Pricing_modifier"},"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","BuildFromCatalogProductOfferingsRequest":{"@type":"BuildFromCatalogProductOfferingsRequest","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"27b2c0df-6d1f-4aaa-addb-d84b8a7727b2"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"QF_CPO0"}},"ProductBrandOfferingIdentifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"TVPT"},"ProductIdentifier":[{"Identifier":{"value":"QFp26"}}]}]},"PaymentCriteria":{"@type":"PaymentCriteria","IssuerIdentificationNumber":"498765"}},"key":"OB_Fees_with_BIN_number","summary":"OB fees charged based on credit card BIN","id":"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/OB_Fees_with_BIN_number"},"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","BuildFromCatalogProductOfferingsRequestAir":{"@type":"BuildFromCatalogProductOfferingsRequestAir","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"3727fcf1-4e0a-4807-90be-f965baa3f8a4"}},"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT","CustomerLoyalty":[{"supplier":"1925825570","cardHolderName":"MEMBER LOYTEST"}]},{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"CHD","CustomerLoyalty":[{"value":"8345357","supplier":"1295036","cardHolderName":"JORDAN LOYTEST"}]}],"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"UA_CPO0"}},"ProductIdentifier":[{"Identifier":{"value":"UAp0"}}]}]}},"key":"NDC_with_customerLoyalty","summary":"NDC with CustomerLoyalty","id":"paths/~1air~1price~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/NDC_with_customerLoyalty"},"paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty":{"value":{"@type":"OfferQueryBuildFromProducts","BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":2,"age":25,"passengerTypeCode":"ADT","CustomerLoyalty":[{"value":"1900007921","supplier":"AA","cardHolderName":"MEMBER LOYTEST"}]}],"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"1551","carrier":"QF","departureDate":"2026-11-03","departureTime":"10:00:00","arrivalDate":"2026-11-03","arrivalTime":"11:50:00","from":"SYD","to":"LST","classOfService":"O","cabin":"Economy","segmentSequence":1,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS","boundFlightsInd":true},{"flightNumber":"2092","carrier":"QF","departureDate":"2026-11-10","departureTime":"14:15:00","arrivalDate":"2026-11-10","arrivalTime":"15:35:00","from":"LST","to":"MEL","classOfService":"K","cabin":"Economy","segmentSequence":2,"AvailabilitySourceCode":"Q","ContentSource":"GDS"}]},{"SpecificFlightCriteria":[{"flightNumber":"422","carrier":"QF","departureDate":"2026-11-10","departureTime":"09:00:00","arrivalDate":"2026-11-10","arrivalTime":"10:25:00","from":"MEL","to":"SYD","classOfService":"E","cabin":"Economy","segmentSequence":3,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]}]},"validateInventoryInd":true},"key":"GDS_roundtrip_with_customerLoyalty","summary":"GDS round trip with CustomerLoyalty","id":"paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_roundtrip_with_customerLoyalty"},"paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier":{"value":{"@type":"OfferQueryBuildFromProducts","BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"}],"PricingModifiersAir":{"@type":"PricingModifiersAir","SellCity":"SIN"},"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"1387","carrier":"AA","departureDate":"2026-11-19","departureTime":"18:41:00","arrivalDate":"2026-11-19","arrivalTime":"20:35:00","from":"ORD","to":"DEN","classOfService":"Y","cabin":"Economy","segmentSequence":1,"brandTier":"4","AvailabilitySourceCode":"Q","ContentSource":"GDS"}],"sequence":1}]},"validateInventoryInd":true},"key":"GDS_SellCity_Pricing_modifier","summary":"GDS with SellCity pricing modifier","id":"paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/GDS_SellCity_Pricing_modifier"},"paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","MaxNumberOfUpsellsToReturn":2,"BuildFromCatalogProductOfferingsRequest":{"@type":"BuildFromCatalogProductOfferingsRequestAir","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"20541e8c-a94d-4da7-a942-d372e9156cca"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"QF_CPO0"}},"ProductIdentifier":[{"Identifier":{"value":"QFp0"}}]}]}},"key":"upsells_with_pricing","summary":"NDC upsells along with pricing","id":"paths/~1air~1price~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/upsells_with_pricing"},"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg":{"value":{"@type":"CatalogOfferingsQuerySeatAvailability","SeatAvailabilityOfferings":{"@type":"SeatAvailabilityOfferingsBuildFromProducts","ProductCriteriaAir":{"@type":"ProductCriteriaAir","sequence":1,"SpecificFlightCriteria":[{"flightNumber":"1387","carrier":"AA","departureDate":"2026-11-19","departureTime":"18:41:00","arrivalDate":"2026-11-19","arrivalTime":"20:35:00","from":"ORD","to":"DEN","classOfService":"Y","cabin":"Economy","segmentSequence":1,"brandTier":"4","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]}}},"key":"Seat_map_request_after_product_search_one_leg","summary":"Request after search by product - one leg","id":"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_product_search_one_leg"},"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench":{"value":{"@type":"CatalogOfferingsQuerySeatAvailability","SeatAvailabilityOfferings":{"@type":"SeatAvailabilityOfferingsBuildFromOfferList","BuildFromOfferList":{"OfferListIdentifier":"ea219f0f-26ca-415b-ab76-f5e882b788ff_PC","OfferIdentifier":[{"id":"o0"}],"ProductIdentifier":[{"id":"p0"}]}}},"key":"Seat_map_request_after_AirPrice_no_workbench","summary":"Request after air price (no workbench)","id":"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_after_AirPrice_no_workbench"},"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary":{"value":{"@type":"CatalogOfferingsQuerySeatAvailability","SeatAvailabilityOfferings":{"@type":"SeatAvailabilityOfferingsBuildFromReservationWorkbench","BuildFromReservationWorkbench":{"ReservationIdentifier":{"Identifier":{"authority":"Travelport","value":"bc3df585-1194-4e39-83a6-e9c721c175a5"}},"OfferIdentifier":{"Identifier":{"authority":"Travelport","value":"5f476fac-f5a8-439f-9c54-61249cd311dc"}}}}},"key":"Seat_map_request_in_workbench_by_offer_whole_itinerary","summary":"Request in workbench by offer (all flights on itinerary)","id":"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_offer_whole_itinerary"},"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg":{"value":{"@type":"CatalogOfferingsQuerySeatAvailability","SeatAvailabilityOfferings":{"@type":"SeatAvailabilityOfferingsBuildFromReservationWorkbench","BuildFromReservationWorkbench":{"ReservationIdentifier":{"Identifier":{"authority":"Travelport","value":"b0c1c36b-4929-4074-bb99-0c5be9c33906"}},"OfferIdentifier":{"Identifier":{"authority":"Travelport","value":"c3898c0d-8e82-4daf-b59e-08573048f105"}},"ProductIdentifier":[{"Identifier":{"value":"e173d605-1e47-4eac-a885-cec10833ccd3"}}]}}},"key":"Seat_map_request_in_workbench_by_product_one_leg","summary":"Request in workbench by product (one leg)","id":"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_product_one_leg"},"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment":{"value":{"@type":"CatalogOfferingsQuerySeatAvailability","SeatAvailabilityOfferings":{"@type":"SeatAvailabilityOfferingsBuildFromReservationWorkbench","BuildFromReservationWorkbench":{"ReservationIdentifier":{"Identifier":{"authority":"Travelport","value":"b0c1c36b-4929-4074-bb99-0c5be9c33906"}},"OfferIdentifier":{"Identifier":{"authority":"Travelport","value":"c3898c0d-8e82-4daf-b59e-08573048f105"}},"ProductIdentifier":[{"Identifier":{"value":"e173d605-1e47-4eac-a885-cec10833ccd3"}}],"SegmentSequenceList":[1]}}},"key":"Seat_map_request_in_workbench_by_segment","summary":"Request in workbench by segment (flight)","id":"paths/~1air~1search~1seat~1catalogofferingsancillaries~1seatavailabilities/post/requestBody/content/application~1json/examples/Seat_map_request_in_workbench_by_segment"},"paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price":{"value":{"@type":"OfferQueryBuildAncillaryOffersFromCatalogOfferings","BuildAncillaryOffersFromCatalogOfferings":[{"@type":"BuildAncillaryOffersFromCatalogOfferings","CatalogOfferingsIdentifier":{"Identifier":{"value":"653f9c6f-4618-44e5-8f2d-2a23dd6fcc40_PC","authority":"Travelport"}},"CatalogOfferingIdentifier":{"id":"SQa1"},"ProductIdentifier":{"id":"SQpa0"},"TravelerIdentifierRef":{"id":"CT1"},"Quantity":1}]},"key":"NDC_ancillary_price","summary":"NDC with SellCity pricing modifier","id":"paths/~1air~1ancillaryprice~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_ancillary_price"},"paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice":{"value":{"@type":"CatalogOfferingsQueryAncillaries","AncillaryOfferings":{"@type":"AncillaryOfferingsBuildFromOfferList","BuildFromOfferList":{"OfferListIdentifier":"238ef294-4d0f-4d6f-838e-154ddaf2c7be_PC","OfferIdentifier":[{"id":"o0"}]}}},"key":"GDS_ancillary_shop_request_after_AirPrice","summary":"Request after air price, no workbench (GDS only)","id":"paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/GDS_ancillary_shop_request_after_AirPrice"},"paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit":{"value":{"@type":"CatalogOfferingsQueryAncillaries","AncillaryOfferings":{"@type":"AncillaryOfferingsBuildFromOffer","BuildFromOffer":{"@type":"BuildFromOfferAir","OfferIdentifier":{"Identifier":{"value":"653f9c6f-4618-44e5-8f2d-2a23dd6fcc40_PC"}},"ProductIdentifier":[{"Identifier":{"value":"p0"}}]}}},"key":"Ancillary_shop_request_pre_commit","summary":"Request in initial booking workflow (pre-commit)","id":"paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_pre_commit"},"paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_reservation":{"value":{"@type":"CatalogOfferingsQueryAncillaries","AncillaryOfferings":{"@type":"AncillaryOfferingsBuildFromReservationWorkbench","BuildFromReservationWorkbench":{"ReservationIdentifier":{"Identifier":{"value":"9cc9e9f9-c985-43da-9972-e764cf47dd66"}}}}},"key":"Ancillary_shop_request_for_existing_reservation","summary":"Request for existing reservation","id":"paths/~1air~1ancillaryshop~1catalogofferingsancillaries/post/requestBody/content/application~1json/examples/Ancillary_shop_request_for_existing_reservation"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote":{"value":{"@type":"OfferQueryCancelOffer","BuildFromOffer":{"@type":"BuildFromOfferAir","OfferIdentifier":{"Identifier":{"value":"fbf50c96-b7th-58e2-80a7-c4c965e36e8a"}}}},"key":"refund_quote","summary":"Refund quote","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/refund_quote"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag":{"value":{"@type":"OfferQueryCancelOffer","BuildFromOffer":{"@type":"BuildFromOfferAir","OfferIdentifier":{"Identifier":{"value":"fbf50c96-c8ed-47e1-80a7-f2f065e36e8a"}}}},"key":"cancel_seat_or_bag","summary":"Cancel seat or bag","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1canceloffer/post/requestBody/content/application~1json/examples/cancel_seat_or_bag"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book":{"value":{"@type":"OfferQueryBuildAncillaryOffersFromCatalogOfferings","BuildAncillaryOffersFromCatalogOfferings":[{"@type":"BuildAncillaryOffersFromCatalogOfferingsAirSeat","CatalogOfferingsIdentifier":{"Identifier":{"value":"273da37f-eeb2-4b94-9981-d5a59a757585"}},"CatalogOfferingIdentifier":{"Identifier":{"value":"18e36d6e-0d64-4eb2-8bfd-6fc76ef0280a"}},"ProductIdentifier":{"id":"product_1","productRef":"product_1","Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"TVPT"}},"TravelerIdentifierRef":{"value":"0ae29a03-9e45-4bf5-9a7f-5e69b84adb83"},"SeatAssignment":"32F"}]},"key":"Seat_book","summary":"Seat assignments for travelers on the same flight","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/Seat_book"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book":{"value":{"@type":"OfferQueryBuildAncillaryOffersFromCatalogOfferings","BuildAncillaryOffersFromCatalogOfferings":[{"@type":"BuildAncillaryOffersFromCatalogOfferings","CatalogOfferingsIdentifier":{"id":"CT1","Identifier":{"authority":"Travelport","value":"85d34008-c5ad-42f6-99ee-a7c0e6d5a2a3"}},"CatalogOfferingIdentifier":{"id":"anc_off2"},"ProductIdentifier":{"id":"an2"},"Quantity":1,"TravelerIdentifierRef":{"id":"travelerRefId_1"}}]},"key":"GDS_Ancillary_book","summary":"GDS ancillary book request","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/GDS_Ancillary_book"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book":{"value":{"@type":"OfferQueryBuildAncillaryOffersFromCatalogOfferings","BuildAncillaryOffersFromCatalogOfferings":[{"@type":"BuildAncillaryOffersFromCatalogOfferings","CatalogOfferingsIdentifier":{"Identifier":{"authority":"Travelport","value":"027e6479-56a2-4048-b331-810502d52830"}},"CatalogOfferingIdentifier":{"id":"anc_off4"},"ProductIdentifier":{"id":"an4"},"TravelerIdentifierRef":{"id":"travelerRefId_1"},"Quantity":1}]},"key":"NDC_Ancillary_book","summary":"NDC ancillary book request","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildancillaryoffersfromcatalogofferings/post/requestBody/content/application~1json/examples/NDC_Ancillary_book"},"paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void":{"value":{"@type":"EMDQueryUpdateEMD","status":"Void"},"key":"emd_void","summary":"EMD display void request","id":"paths/~1air~1emds~1{Identifier}/put/requestBody/content/application~1json/examples/emd_void"},"paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench":{"value":{"@type":"ReservationID"},"key":"new-workbench","summary":"Workbench for a new reservation","id":"paths/~1air~1book~1session~1reservationworkbench/post/requestBody/content/application~1json/examples/new-workbench"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking":{"value":{"@type":"CancelRequest","cancelAllInd":true},"key":"cancel-air-booking","summary":"Cancels the entire booking","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-air-booking"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelAllOffers"}},"key":"cancel-all-offers","summary":"Cancels all offers","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-offers"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelAllOffers","retainSegmentsInd":true}},"key":"cancel-the-filed-fare-from-all-air-offers","summary":"retainSegmentsInd - cancel the filed fare from all air offers","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-all-air-offers"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelSelectedOffers","offerProductSelection":[{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"30420d72-2d73-4506-bd93-e4f7da67d04d"}}},{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"8b72118d-0247-449b-89bd-6ab554f550df"}}}]}},"key":"cancels-multiple-offers","summary":"Cancels multiple offers","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancels-multiple-offers"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelSelectedOffers","offerProductSelection":[{"sendPassiveNotificationInd":true,"retainSegmentsInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"d937ddcd-34a0-4da9-aa97-ad54056a726b"}}}]}},"key":"cancel-the-filed-fare-from-specified-air-offers","summary":"retainSegmentsInd - cancel the filed fare from specified air offers","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-the-filed-fare-from-specified-air-offers"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelSelectedOffers","offerProductSelection":[{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"672ccee8-d754-48a6-a5be-830098eb6429"}},"productSegmentSequenceArray":[{"productID":{"Identifier":{"authority":"Travelport","value":"7687b84c-aa13-4d8c-b7d0-622ea57a9573"}}}]}]}},"key":"cancel-product-within-an-offer","summary":"Cancels a product within an offer","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-product-within-an-offer"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelSelectedOffers","offerProductSelection":[{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"64efc64a-6871-479f-873f-2ccde84da74b"}},"productSegmentSequenceArray":[{"productID":{"Identifier":{"authority":"Travelport","value":"4ac1483f-4d8b-405a-b90b-b1ea00f8f069"}},"segmentSequenceArray":[4,5]}]}]}},"key":"cancel-segment-within-product","summary":"Cancels a segment within a product","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-segment-within-product"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelSelectedOffers","offerProductSelection":[{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"ada4e19a-b52a-43cd-b1ed-e9a1c5cee7d8"}}},{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"accc35ff-9dde-45cd-810e-afc2612f74c2"}},"productSegmentSequenceArray":[{"productID":{"Identifier":{"authority":"Travelport","value":"ae4ee9ee-88de-4d05-a07a-360c2e8aaad6"}}}]}]}},"key":"cancel-multiple-product-and-segment-combinations","summary":"Cancels multiple product and segment combinations","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-multiple-product-and-segment-combinations"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments":{"value":{"@type":"CancelRequest","cancelUnpricedSegments":{"objectType":"CancelAllUnpricedSegments"}},"key":"cancel-all-unpriced-segments","summary":"Cancels all unpriced segments","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-all-unpriced-segments"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments":{"value":{"@type":"CancelRequest","cancelUnpricedSegments":{"objectType":"CancelSelectedUnpricedSegments","flightSegmentSelection":[{"sendPassiveNotificationInd":true,"unpricedFlightSegmentIDRefs":["unPricedFlightSegment_1"]}]}},"key":"cancel-specific-unpriced-segments","summary":"Cancels specific unpriced segments.","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-specific-unpriced-segments"},"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment":{"value":{"@type":"CancelRequest","cancelOffers":{"objectType":"CancelSelectedOffers","offerProductSelection":[{"sendPassiveNotificationInd":true,"offerID":{"Identifier":{"authority":"Travelport","value":"f09eb521-0b9f-463e-8176-025356af0d7b"}}}]},"cancelUnpricedSegments":{"objectType":"CancelSelectedUnpricedSegments","flightSegmentSelection":[{"sendPassiveNotificationInd":true,"unpricedFlightSegmentIDRefs":["unPricedFlightSegment_1","unPricedFlightSegment_2"]}]}},"key":"cancel-offer-and-unpriced-segment","summary":"Cancels offer and unpriced segment","id":"paths/~1book~1reservationworkbench~1{ReservationResource_Identifier}~1reservations~1cancelitems/post/requestBody/content/application~1json/examples/cancel-offer-and-unpriced-segment"},"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings":{"value":{"enableTwoStepCommitInd":true,"overrideMCTInd":false,"errorWhenScheduleChangesInd":true,"errorWhenOfferPriceChangesInd":true},"key":"two-step-commit-and-warnings","summary":"Triggers a two-step commit and MCT warning","id":"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/two-step-commit-and-warnings"},"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change":{"value":{"scheduleChangeAcceptedInd":true},"key":"accepts-involuntary-schedule-change","summary":"Accepts involuntary schedule change from the carrier","id":"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/accepts-involuntary-schedule-change"},"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit":{"value":{"@type":"ReservationQueryCommitReservation","Notification":[{"@type":"Notification","QueueNumber":[{"category":"DM","overridePCC":"39RA","value":5}],"Date":"2026-11-16"}]},"key":"to-place-booking-on-queue-and-update-ticketing-time-limit","summary":"Places booking on queue and updates ticketing time limit","id":"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/to-place-booking-on-queue-and-update-ticketing-time-limit"},"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom":{"value":{"ReceivedFrom":"AgentName"},"key":"adds-receivedfrom","summary":"Adds ReceivedFrom","id":"paths/~1air~1book~1reservation~1reservations~1{Identifier}/post/requestBody/content/application~1json/examples/adds-receivedfrom"},"paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile":{"value":{"ClientProfileMoveHeaderModifiers":{"BusinessTitle":"TESTBUSINESS1","PersonalTitle":"TESTPERSONAL4","MultipleIndicator":false,"SelectIndicator":false,"MergeIndicator":false,"RelatedMoveIndicator":"N","ProfilePCC":"XY5"}},"key":"business_profile","summary":"Business profile","id":"paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/business_profile"},"paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile":{"value":{"ClientProfileMoveHeaderModifiers":{"BusinessTitle":"TESTBUSINESS1","PersonalTitle":"TESTPERSONAL4","MultipleIndicator":false,"SelectIndicator":false,"MergeIndicator":false,"RelatedMoveIndicator":"N"}},"key":"personal_profile","summary":"Personal profile","id":"paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/personal_profile"},"paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers":{"value":{"ClientProfileMoveHeaderModifiers":{"BusinessTitle":"HEMPSTOCK","PersonalTitle":"TRACEY","MultipleIndicator":false,"SelectIndicator":true,"MergeIndicator":false,"RelatedMoveIndicator":"N"},"ClientProfileMoveLineModifiers":[{"LineNumber":1,"AppendedData":"TEST"}]},"key":"ClientProfileMoveLineModifiers","summary":"With ClientProfileMoveLineModifiers","id":"paths/~1air~1book~1profile~1reservationworkbench~1{identifier}~1clientprofile/put/requestBody/content/application~1json/examples/ClientProfileMoveLineModifiers"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","BuildFromCatalogProductOfferingsRequestAir":{"@type":"BuildFromCatalogProductOfferingsRequestAir","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"dcc7cda4-454a-4790-b713-04e7d74417da"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"o1"}},"ProductIdentifier":[{"Identifier":{"value":"p9"}}]}]}},"key":"one_way_offer","summary":"One way offer","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/one_way_offer"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer":{"value":{"@type":"OfferQueryBuildFromCatalogProductOfferings","BuildFromCatalogProductOfferingsRequestAir":{"@type":"BuildFromCatalogProductOfferingsRequestAir","CatalogProductOfferingsIdentifier":{"Identifier":{"value":"e1ac2382-e5cf-488c-8095-eef9f79622a3"}},"CatalogProductOfferingSelection":[{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"o1"}},"ProductIdentifier":[{"Identifier":{"value":"p0"}}]},{"CatalogProductOfferingIdentifier":{"Identifier":{"value":"o2"}},"ProductIdentifier":[{"Identifier":{"value":"p4"}}]}]}},"key":"round_trip_offer","summary":"Round trip offer","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogproductofferings/post/requestBody/content/application~1json/examples/round_trip_offer"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer":{"value":{"@type":"OfferQueryBuildFromProducts","BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"}],"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"2833","carrier":"AA","departureDate":"2026-11-02","departureTime":"08:20:00","arrivalDate":"2026-11-02","arrivalTime":"10:08:00","from":"ORD","to":"DEN","classOfService":"Y","cabin":"Economy","segmentSequence":1,"brandTier":"4","AvailabilitySourceCode":"S","ContentSource":"GDS"}],"sequence":1}]}},"key":"one_way_offer","summary":"One way offer","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/one_way_offer"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer":{"value":{"@type":"OfferQueryBuildFromProducts","BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PassengerCriteria":[{"@type":"PassengerCriteria","number":2,"age":25,"passengerTypeCode":"ADT"}],"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"1551","carrier":"QF","departureDate":"2026-11-03","departureTime":"10:00:00","arrivalDate":"2026-11-03","arrivalTime":"11:50:00","from":"SYD","to":"LST","classOfService":"O","cabin":"Economy","segmentSequence":1,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS","boundFlightsInd":true},{"flightNumber":"2092","carrier":"QF","departureDate":"2026-11-03","departureTime":"14:15:00","arrivalDate":"2026-11-03","arrivalTime":"15:35:00","from":"LST","to":"MEL","classOfService":"K","cabin":"","segmentSequence":2,"AvailabilitySourceCode":"Q","ContentSource":"GDS"}]},{"SpecificFlightCriteria":[{"flightNumber":"422","carrier":"QF","departureDate":"2026-11-10","departureTime":"09:00:00","arrivalDate":"2026-11-10","arrivalTime":"10:25:00","from":"MEL","to":"SYD","classOfService":"E","cabin":"Economy","segmentSequence":2,"brandTier":"1","AvailabilitySourceCode":"Q","ContentSource":"GDS"}]}]}},"key":"round_trip_offer","summary":"Round trip offer","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/round_trip_offer"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment":{"value":{"@type":"OfferQueryBuildFromProducts","lowFareFinderInd":true,"returnBrandedFaresInd":true,"BuildFromProductsRequest":{"@type":"BuildFromProductsRequestAir","PricingModifiersAir":{"@type":"PricingModifiersAirDetail"},"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"},{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"CHD"}],"ProductCriteriaAir":[{"SpecificFlightCriteria":[{"flightNumber":"1814","carrier":"KL","departureDate":"2026-11-26","departureTime":"07:00:00","arrivalDate":"2026-11-26","arrivalTime":"08:05:00","from":"FRA","to":"AMS","classOfService":"T","cabin":"Economy","segmentSequence":1,"passiveSegmentStatus":"AK"}],"SupplierLocator":{"value":"WTR84G","supplierCode":"KL"}}]}},"key":"book_a_passive_segment","summary":"Book a passive segment","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromproducts/post/requestBody/content/application~1json/examples/book_a_passive_segment"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing":{"value":{"@type":"OfferQueryBuildFromUnpricedSegments","BuildFromUnpricedSegments":[{"@type":"BuildFromUnpricedSegmentsAutoPrice","inhibitBrandContentInd":true,"lowFareFinderInd":true,"validateInventoryInd":true,"lowFareFindAndRebookInd":true,"UnpricedFlightSegmentCriteria":[{"@type":"UnpricedFlightSegmentCriteria","UnpricedFlightSegmentRefs":["unPricedFlightSegment_1"],"Sequence":1,"TravelerRefs":["travelerRefId_1"]}],"PricingModifiersAir":{"@type":"PricingModifiersAir","currencyCode":"AUD"},"CustomResponseModifiersAir":{"@type":"CustomResponseModifiersAir"},"PaymentCriteria":{"@type":"PaymentCriteria"},"CabinPreference":[{"@type":"CabinPreference","preferenceType":"Preferred","cabins":["Business"],"legSequence":[1]}]}]},"key":"auto_pricing","summary":"Auto pricing","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/auto_pricing"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare":{"value":{"@type":"OfferQueryBuildFromUnpricedSegments","BuildFromUnpricedSegments":[{"@type":"BuildFromUnpricedSegmentsManualPrice","UnpricedFlightSegmentCriteria":[{"@type":"UnpricedFlightSegmentCriteria","UnpricedFlightSegmentRefs":["unPricedFlightSegment_1"],"Sequence":1,"TravelerRefs":["travelerRefId_1"]}],"ManualPrice":{"@type":"ManualPrice","id":"manualoffer_1","ContentSource":"GDS","PassengerFlight":[{"@type":"PassengerFlight","passengerQuantity":1,"passengerTypeCode":"ADT","FlightProduct":[{"@type":"FlightProduct","segmentSequence":[1],"classOfService":"Y","cabin":"Economy","fareBasisCode":"YEE1Y"},{"@type":"FlightProduct","segmentSequence":[2],"classOfService":"B","cabin":"Economy","fareBasisCode":"BEE1Y"}]}],"PriceDetail":{"@type":"PriceDetail","id":"price_1","CurrencyCode":{"value":"AUD","decimalPlace":2},"Base":650,"TotalTaxes":70,"TotalPrice":720,"PriceBreakdown":[{"@type":"PriceBreakdownAir","quantity":1,"requestedPassengerType":"ADT","Amount":{"@type":"Amount","CurrencyCode":{"value":"AUD","decimalPlace":2},"Base":250,"Total":280,"Taxes":{"@type":"TaxesDetail","TotalTaxes":20,"Tax":[{"value":20,"currencyCode":"AUD","taxCode":"GB"}]}},"TravelerRefs":["travelerRefId_1"],"FareCalculation":"LON BA AMS R125.00YEE1Y BA LHR R125.00BEE1Y NUC250.00END ROE0.787855"}]}}}]},"key":"manual_fare","summary":"Manual fare","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromunpricedsegments/post/requestBody/content/application~1json/examples/manual_fare"},"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment":{"value":{"@type":"UnpricedSegments","UnpricedFlightSegment":[{"@type":"UnpricedFlightSegment","sequence":1,"passengerQuantity":2,"classOfService":"K","passiveSegmentStatus":"AK","Flight":{"@type":"Flight","id":"1","carrier":"QF","number":"1251","Departure":{"@type":"Departure","location":"BNE","date":"2026-11-30"},"Arrival":{"@type":"Arrival","location":"MEL","date":"2026-11-30"}}}]},"key":"unpriced_segment","summary":"Unpriced segment","id":"paths/~1air~1book~1airoffer~1reservationworkbench~1{ReservationResource_Identifier}~1unpricedsegments/post/requestBody/content/application~1json/examples/unpriced_segment"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail":{"value":{"@type":"TravelerListRequest","Traveler":[{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"JORDAN","Surname":"LOYTEST"},"Telephone":[{"@type":"Telephone","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"275555561","extension":"123","id":"1","cityCode":"DEN","role":"Home"}],"TravelDocument":[{"@type":"TravelDocumentDetail","docNumber":"XXXXXXX88","docType":"Passport","issueDate":"2019-07-06","expireDate":"2023-12-07","issueCountry":"US","birthDate":"1997-12-20","birthPlace":"USA","Gender":"Male","PersonName":{"@type":"PersonNameDetail","Given":"JORDAN","Surname":"LOYTEST"},"IssuedForGeoPoliticalArea":{"value":"USA"}}],"Email":[{"value":"sgd@webjet.com"}],"CustomerLoyalty":[{"value":"1295036","supplier":"AA"}]},{"@type":"Traveler","PersonName":{"@type":"PersonNameDetail","Given":"BOB","Surname":"LOYTEST"},"Telephone":[{"@type":"Telephone","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"217777761","extension":"123","id":"1","cityCode":"DEN","role":"Home"}],"TravelDocument":[{"@type":"TravelDocumentDetail","docNumber":"V127","docType":"Visa","issueDate":"2019-07-04","expireDate":"2021-12-05","issueCountry":"US","birthDate":"1982-01-24","birthPlace":"PARIS","Gender":"Male","PersonName":{"@type":"PersonNameDetail","Given":"BOB","Surname":"LOYTEST"},"IssuedForGeoPoliticalArea":{"value":"USA"},"Address":{"@type":"Address","role":"Destination","Street":"Travers Street","City":"Claremont","StateProv":{"name":"Texas","value":"TX"},"Country":{"value":"US"},"PostalCode":"91711"}}],"Email":[{"value":"exampledomain@example.com"}],"CustomerLoyalty":[{"value":"1900007921","supplier":"AA"}]}]},"key":"multiple_travelers_with_passport_and_visa_detail","summary":"Multiple travelers with passport and visa details","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1list/post/requestBody/content/application~1json/examples/multiple_travelers_with_passport_and_visa_detail"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age":{"value":{"@type":"Traveler","birthDate":"2000-01-01","id":"trav_1","passengerTypeCode":"INF","PersonName":{"@type":"PersonNameDetail","Given":"TestFirstInf","Middle":"","Surname":"TestLastInf","Suffix":"Jr"},"Telephone":[{"@type":"Telephone","countryAccessCode":"1","areaCityCode":"305","phoneNumber":"868767809","id":"telephone_1","role":"Home"}],"TravelDocument":[{"@type":"TravelDocument","docNumber":"H294F6","docType":"Passport","expireDate":"2030-12-29","issueCountry":"US","birthDate":"2000-01-01","Nationality":"US","Gender":"Female","PersonName":{"@type":"PersonName","Given":"TestFirstInf","Surname":"TestLastInf"}}]},"key":"single_passenger_child_PTC_with_age","summary":"Single passenger child PTC with age","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_child_PTC_with_age"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty":{"value":{"@type":"Traveler","birthDate":"1999-02-22","gender":"Male","passengerTypeCode":"ADT","PersonName":{"@type":"PersonNameDetail","Prefix":"Mr","Given":"Px ADTOne","Middle":"MdNm","Surname":"SrNmOne"},"Telephone":[{"@type":"Telephone","countryAccessCode":"1","areaCityCode":"909","phoneNumber":"217678721","extension":"1243","id":"4","cityCode":"ORD","role":"Office"}],"Email":[{"value":"ADTTravelerOneOne@gmail.com"}],"CustomerLoyalty":[{"supplier":"QF","value":"1234"}],"TravelDocument":[{"@type":"TravelDocumentDetail","docNumber":"245968","docType":"Passport","issueDate":"2020-12-22","expireDate":"2027-02-22","issueCountry":"IN","birthDate":"1999-02-22","Nationality":"IN","Gender":"Male","PersonName":{"@type":"PersonName","Given":"Px One","Middle":"MdNmOne","Surname":"SrNmOne"},"IssuedForGeoPoliticalArea":{"value":"IN"}}]},"key":"single_passenger_with_CustomerLoyalty","summary":"Single passenger with CustomerLoyalty","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_CustomerLoyalty"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_ID":{"value":{"@type":"Traveler","birthDate":"1999-02-22","gender":"Male","passengerTypeCode":"ADT","PersonName":{"@type":"PersonNameDetail","Prefix":"Mr","Given":"Px ADTOne","Middle":"MdNm","Surname":"SrNmOne","Suffix":"ADT"},"Comments":{"@type":"Comments","Comment":[{"id":"comment_1","value":"ID-12345671"}]}},"key":"single_passenger_with_name_remark_to_create_custom_traveler_ID","summary":"Single passenger with name remark to create custom traveler ID","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers/post/requestBody/content/application~1json/examples/single_passenger_with_name_remark_to_create_custom_traveler_ID"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","Commissions":[{"Commission":{"@type":"CommissionAmount","Amount":{"code":"USD","value":123}}}],"TourCodes":[{"TourCode":{"tourCodeType":"Bulk Tour","value":"TCS"}}],"Restrictions":[{"Restriction":["NON Refundable"]}],"DestinationPurpose":[{"purpose":"Business","destination":"Europe"}]},"key":"Document_Override_Remarks_tour_code_commission_endorsement","summary":"Tour code, commission, endorsement","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_tour_code_commission_endorsement"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","Commissions":[{"TravelerIdentifierRef":[{"id":"trav_1"},{"id":"trav_2"}],"Commission":{"@type":"CommissionPercent","Percent":5}}]},"key":"Document_Override_Remarks_traveler_specific_commission","summary":"Traveler specific commission","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_traveler_specific_commission"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","ChangeFeeCollectionMethod":{"extension":"Other_Value","code":"D","subCode":"997","description":"REBOOKING","value":"EMD","taxIncludedInBaseAmountInd":true}},"key":"Document_Override_Remarks_with_change_fee_indicator_for_exchange","summary":"Change fee indicator for exchange","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_indicator_for_exchange"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","ChangeFeeCollectionMethod":{"extension":"Other_Value","code":"OA","description":"REBOOKING FEE","value":"Tax"}},"key":"Document_Override_Remarks_with_change_fee_as_tax_for_exchange","summary":"Change fee as a tax for exchange","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/Document_Override_Remarks_with_change_fee_as_tax_for_exchange"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","Restrictions":[{"Restriction":["NON Refundable"],"DocumentType":"EMD"}]},"key":"EMD_endorsement","summary":"EMD endorsement","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/EMD_endorsement"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","Commissions":[{"ApplyTo":"Fee","Commission":{"@type":"CommissionAmount","Amount":{"code":"USD","value":5}}},{"ApplyTo":"Base","Commission":{"@type":"CommissionAmount","Amount":{"code":"USD","value":10}}}]},"key":"commission_with_ApplyTo","summary":"Commission with ApplyTo","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/commission_with_ApplyTo"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","TicketDesignator":"AB123"},"key":"ticketDesignator","summary":"Ticket designator","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/ticketDesignator"},"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd":{"value":{"@type":"DocumentOverrides","id":"documentOverrides_1","DocumentOverridesRef":"documentOverrides_1","residualValueAsEvenExchangeMIRInd":true},"key":"residualValueAsEvenExchangeMIRInd","summary":"Even exchange override for MIR","id":"paths/~1air~1book~1documentoverride~1Reservation~1{ReservationResource_Identifier}~1documentoverrides/post/requestBody/content/application~1json/examples/residualValueAsEvenExchangeMIRInd"},"paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark":{"value":{"@type":"Accounting","id":"accounting_1","AccountingRef":"accounting_1","dataType":"DOCI","NameValuePair":[{"value":"INV123456","name":"AC"}]},"key":"doci_accounting_remark","summary":"DOCI accounting remark","id":"paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_accounting_remark"},"paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve":{"value":{"@type":"Accounting","dataType":"DOCI","id":"accounting_1","Identifier":{"authority":"Travelport","value":"8d92d4ea-0d97-4319-9f6b-fd7f9604da5a"},"NameValuePair":[{"id":"ActComment_1","name":"AC","value":"A53.EXAMPLE213.TEST"},{"id":"ActComment_2","name":"TK","value":"20XXXXXX84"},{"id":"ActComment_3","name":"FT","value":"offerNumber.PTR 41XXXXXXX45"}]},"key":"doci_from_reservation_retrieve","summary":"DOCI remark from reservation retrieve","id":"paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/doci_from_reservation_retrieve"},"paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks":{"value":{"@type":"Accounting","id":"accounting_1","AccountingRef":"accounting_2","NameValuePair":[{"name":"TK","value":"ACCOUNTING REMARKS TESTING"},{"name":"UA","value":"FREETEXT REMARKS TESTING"},{"name":"X*","value":"X remark"},{"name":"FT","value":"Added name FT for acntng rematks testing"}]},"key":"historical_remarks","summary":"Historical remarks","id":"paths/~1air~1book~1accounting~1reservationworkbench~1{ReservationResource_Identifier}~1accountings/post/requestBody/content/application~1json/examples/historical_remarks"},"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general":{"value":{"@type":"ReservationCommentListRequest","ReservationComment":[{"@type":"ReservationComment","id":"reservationComment_1","Comment":[{"name":"RE","value":"DETAILS FOR THE REMARK","id":"comment_1","language":"EN"}]}]},"key":"reservation_comments_general","summary":"General remarks","id":"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_general"},"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi":{"value":{"@type":"ReservationCommentListRequest","ReservationComment":[{"@type":"ReservationComment","id":"reservationComment_1","commentSource":"Agency","shareWith":"Supplier","shareWithSupplier":["YY"],"Comment":[{"id":"comment_1","name":"OSI Remarks","language":"EN","value":"INVOLUNTARY REROUTE PER PUBLISHED FARE RULE"}]}]},"key":"reservation_comments_osi","summary":"OSI remarks","id":"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/reservation_comments_osi"},"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level":{"value":{"@type":"ReservationCommentListRequest","ReservationComment":[{"@type":"ReservationComment","commentSource":"Agency","shareWith":"Traveler","Comment":[{"name":"ITIN COMMENTS","value":"Testing single ITIN associated remarks -segment"}],"AppliesTo":[{"@type":"AppliesToOfferProductSegment","OfferIdentifier":{"Identifier":{"authority":"Travelport","value":"82b0d649-eee5-44b7-8262-96a4780feb1f"}},"ProductIdentifier":{"Identifier":{"authority":"Travelport","value":"0b62905b-86dc-44c6-b93a-e65bb22d98e8"}},"SegmentSequenceList":[1]}]}]},"key":"itin_associated_remarks_segment_level","summary":"ITIN associated remarks - segment level","id":"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_associated_remarks_segment_level"},"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks":{"value":{"@type":"ReservationCommentListRequest","ReservationComment":[{"@type":"ReservationComment","commentSource":"Agency","shareWith":"Traveler","Comment":[{"name":"ITIN COMMENTS","value":"Testing ITIN Unassociated remarks one"}]}]},"key":"itin_unassociated_remarks","summary":"ITIN unassociated remarks","id":"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/itin_unassociated_remarks"},"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks":{"value":{"@type":"ReservationCommentListRequest","ReservationComment":[{"@type":"ReservationComment","id":"reservationComment_1","commentSource":"Agency","shareWith":"Supplier","shareWithSupplier":["AA"],"Comment":[{"id":"comment_1","name":"Vendor Remarks","language":"EN","value":"Testing with carrier code for GDS OW"}]}]},"key":"vendor_remarks","summary":"Vendor remarks - carrier code","id":"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/vendor_remarks"},"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks":{"value":{"@type":"ReservationCommentListRequest","ReservationComment":[{"@type":"ReservationComment","commentSource":"Agency","shareWith":"Agency","Comment":[{"name":"YT","value":"This is notepad remarks one"},{"name":"UA","value":"This is notepad remarks two"}]}]},"key":"notepad_remarks","summary":"Notepad remarks","id":"paths/~1air~1book~1remarks~1reservationworkbench~1{ReservationResource_Identifier}~1reservationcomments~1list/post/requestBody/content/application~1json/examples/notepad_remarks"},"paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level":{"value":{"@type":"SpecialServiceListRequest","SpecialService":[{"@type":"SpecialService","id":"specialService_1","Identifier":{"authority":"Travelport","value":"7464d6bf-0195-49b7-a17b-9335b26cfc9c"},"AppliesTo":{"@type":"AppliesToOffer","OfferIdentifier":[{"id":"offer_1","offerRef":"offer_1","Identifier":{"authority":"Travelport","value":"82b0d649-eee5-44b7-8262-96a4780feb1f"}}]},"TravelerIdentifier":{"id":"trav_1","TravelerRef":"trav_1","Identifier":{"authority":"Travelport","value":"58d50e59-19fd-4132-bc65-ae09186e57f1"}},"SSRCode":"VGML"}]},"key":"ssr_offer_level","summary":"SSR - offer level","id":"paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_offer_level"},"paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level":{"value":{"@type":"SpecialServiceListRequest","SpecialService":[{"@type":"SpecialService","id":"specialService_1","Identifier":{"authority":"Travelport","value":"7464d6bf-0195-49b7-a17b-9335b26cfc9c"},"AppliesTo":{"@type":"AppliesToOfferProduct","OfferIdentifier":{"id":"offer_1","offerRef":"offer_1","Identifier":{"authority":"Travelport","value":"82b0d649-eee5-44b7-8262-96a4780feb1f"}},"ProductIdentifier":[{"id":"product_1","productRef":"product_1","Identifier":{"authority":"Travelport","value":"0b62905b-86dc-44c6-b93a-e65bb22d98e8"}}]},"TravelerIdentifier":{"id":"trav_1","TravelerRef":"trav_1","Identifier":{"authority":"Travelport","value":"58d50e59-19fd-4132-bc65-ae09186e57f1"}},"SSRCode":"UMNR","FreeText":"SR LANG AY-ENGLISH/Negi/Navneet/M"}]},"key":"ssr_product_level","summary":"SSR - product level","id":"paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_product_level"},"paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level":{"value":{"@type":"SpecialServiceListRequest","SpecialService":[{"@type":"SpecialService","id":"specialService_1","Identifier":{"authority":"Travelport","value":"7464d6bf-0195-49b7-a17b-9335b26cfc9c"},"AppliesTo":{"@type":"AppliesToOfferProductSegment","OfferIdentifier":{"id":"offer_1","offerRef":"offer_1","Identifier":{"authority":"Travelport","value":"82b0d649-eee5-44b7-8262-96a4780feb1f"}},"ProductIdentifier":{"id":"product_1","productRef":"product_1","Identifier":{"authority":"Travelport","value":"0b62905b-86dc-44c6-b93a-e65bb22d98e8"}},"SegmentSequenceList":[1]},"TravelerIdentifier":{"id":"trav_1","TravelerRef":"trav_1","Identifier":{"authority":"Travelport","value":"58d50e59-19fd-4132-bc65-ae09186e57f1"}},"SSRCode":"WCHR","FreeText":"36inX25inX32in"}]},"key":"ssr_segment_level","summary":"SSR - segment level","id":"paths/~1air~1book~1specialservices~1reservationworkbench~1{ReservationResource_Identifier}~1specialservices~1list/post/requestBody/content/application~1json/examples/ssr_segment_level"},"paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM":{"value":{"@type":"PrimaryContact","shareWithSupplier":["YY"],"Email":{"value":"exampledomain@example.com"},"Telephone":{"@type":"Telephone","role":"Mobile","phoneNumber":"12999996"},"TravelerIdentifier":{"Identifier":{"value":"b881f857-52df-4a5b-8cc1-7e0eef62aa6e"}}},"key":"add_primary_contact_remarks_CTCE_CTCM","summary":"Add primary contact remarks CTCE & CTCM","id":"paths/~1air~1book~1primarycontact~1reservationworkbench~1{ReservationResource_Identifier}~1primarycontacts/post/requestBody/content/application~1json/examples/add_primary_contact_remarks_CTCE_CTCM"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash":{"value":{"@type":"FormOfPaymentCash","id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1"},"key":"fop_cash","summary":"FOP cash","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card":{"value":{"@type":"FormOfPaymentPaymentCard","id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1","PaymentCard":{"@type":"PaymentCardDetail","id":"paymentCard_4","expireDate":"1228","CardType":"Credit","CardCode":"VI","CardHolderName":"TESTFIRST TESTLAST","approvalCode":"123456","CardNumber":{"@type":"CardNumber","PlainText":"4929XXXXXXXXX123"},"SeriesCode":{"PlainText":"XXX"}}},"key":"fop_credit_card","summary":"FOP credit card","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_credit_card"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator":{"value":{"@type":"FormOfPaymentCash","id":"formOfPayment_1","FormOfPaymentRef":"a111","agentNonRefundableInd":true,"Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"Travelport"},"FreeText":"Test for Non-Ref"},"key":"fop_cash_with_nonrefundable_indicator","summary":"FOP cash with nonrefundable indicator","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice":{"value":{"@type":"FormOfPaymentInvoice","id":"1","FormOfPaymentRef":"1","Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D6FOP","authority":"Travelport"},"InvoiceNumber":"34324343"},"key":"fop_agent_invoice","summary":"FOP agent invoice","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_agent_invoice"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card":{"value":{"@type":"FormOfPaymentPaymentCard","inhibitPaymentCardAuthorizationInd":true,"id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","PaymentCard":{"@type":"PaymentCardDetail","id":"paymentCard_4","expireDate":"0529","approvalCode":"Z555444","CardType":"Credit","CardCode":"HD","CardHolderName":"JANE DOE","CardNumber":{"PlainText":"4929XXXXXXXXX123"}}},"key":"fop_non_standard_credit_card","summary":"FOP non-standard credit card","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_non_standard_credit_card"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check":{"value":{"@type":"FormOfPaymentCheck","FormOfPaymentRef":"formOfPayment_1","id":"formOfPayment_1","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D7C4E"}},"key":"fop_check","summary":"FOP check","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_check"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay":{"value":{"@type":"FormOfPaymentPaymentCard","id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D6FOP"},"PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0139","CardType":"Credit","CardCode":"EP","CardNumber":{"PlainText":"4929XXXXXXXXX123"}}},"key":"fop_iata_easy_pay","summary":"FOP IATA easy pay","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_iata_easy_pay"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit":{"value":{"@type":"FormOfPaymentForfeit","forfeitInd":true,"id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","Identifier":{"authority":"Travelport","value":"2e88da9b-f4c2-4044-8607-c7b74ba4c657"}},"key":"fop_forfeit","summary":"FOP forfeit","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_forfeit"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver":{"value":{"@type":"FormOfPaymentWaiverCode","id":"formOfPayment_6","FormOfPaymentRef":"formOfPayment_6","Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"Travelport"},"WaiverCode":{"value":"ABC123"}},"key":"fop_for_waiver","summary":"FOP for waiver","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_for_waiver"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass":{"value":{"@type":"FormOfPaymentFlightPass","id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1","Identifier":{"value":"FAF4-456F-B061-0161008D6FOP"},"FlightPass":[{"supplier":"AC","accountNumber":"01XXXXXXX4259"}]},"key":"fop_flight_pass","summary":"FOP for FlightPass","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment/post/requestBody/content/application~1json/examples/fop_flight_pass"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash":{"value":{"@type":"FormOfPaymentCash","id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1"},"key":"fop_cash","summary":"FOP cash","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card":{"value":{"@type":"FormOfPaymentPaymentCard","id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1","PaymentCard":{"@type":"PaymentCardDetail","id":"paymentCard_4","expireDate":"1228","CardType":"Credit","CardCode":"VI","CardHolderName":"TESTFIRST TESTLAST","approvalCode":"123456","CardNumber":{"@type":"CardNumber","PlainText":"4929XXXXXXXXX123"},"SeriesCode":{"PlainText":"XXX"}}},"key":"fop_credit_card","summary":"FOP credit card","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_credit_card"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator":{"value":{"@type":"FormOfPaymentCash","id":"formOfPayment_1","FormOfPaymentRef":"a111","agentNonRefundableInd":true,"Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"Travelport"},"FreeText":"Test for Non-Ref"},"key":"fop_cash_with_nonrefundable_indicator","summary":"FOP cash with nonrefundable indicator","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_cash_with_nonrefundable_indicator"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice":{"value":{"@type":"FormOfPaymentInvoice","id":"1","FormOfPaymentRef":"1","Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D6FOP","authority":"Travelport"},"InvoiceNumber":"34324343"},"key":"fop_agent_invoice","summary":"FOP agent invoice","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_agent_invoice"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card":{"value":{"@type":"FormOfPaymentPaymentCard","inhibitPaymentCardAuthorizationInd":true,"id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","PaymentCard":{"@type":"PaymentCardDetail","id":"paymentCard_4","expireDate":"0529","approvalCode":"Z555444","CardType":"Credit","CardCode":"HD","CardHolderName":"JANE DOE","CardNumber":{"PlainText":"4929XXXXXXXXX123"}}},"key":"fop_non_standard_credit_card","summary":"FOP non-standard credit card","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_non_standard_credit_card"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check":{"value":{"@type":"FormOfPaymentCheck","FormOfPaymentRef":"formOfPayment_1","id":"formOfPayment_1","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D7C4E"}},"key":"fop_check","summary":"FOP check","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_check"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay":{"value":{"@type":"FormOfPaymentPaymentCard","id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D6FOP"},"PaymentCard":{"@type":"PaymentCardDetail","expireDate":"0139","CardType":"Credit","CardCode":"EP","CardNumber":{"PlainText":"4929XXXXXXXXX123"}}},"key":"fop_iata_easy_pay","summary":"FOP IATA easy pay","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_iata_easy_pay"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit":{"value":{"@type":"FormOfPaymentForfeit","forfeitInd":true,"id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","Identifier":{"authority":"Travelport","value":"2e88da9b-f4c2-4044-8607-c7b74ba4c657"}},"key":"fop_forfeit","summary":"FOP forfeit","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_forfeit"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver":{"value":{"@type":"FormOfPaymentWaiverCode","id":"formOfPayment_6","FormOfPaymentRef":"formOfPayment_6","Identifier":{"value":"A0656EFF-FAF4-456F-B061-0161008D7C4E","authority":"Travelport"},"WaiverCode":{"value":"ABC123"}},"key":"fop_for_waiver","summary":"FOP for waiver","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_for_waiver"},"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass":{"value":{"@type":"FormOfPaymentFlightPass","id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1","Identifier":{"value":"FAF4-456F-B061-0161008D6FOP"},"FlightPass":[{"supplier":"AC","accountNumber":"01XXXXXXX4259"}]},"key":"fop_flight_pass","summary":"FOP for FlightPass","id":"paths/~1air~1payment~1reservationworkbench~1{ReservationResource_Identifier}~1formofpayment~1{Identifier}/put/requestBody/content/application~1json/examples/fop_flight_pass"},"paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer":{"value":{"@type":"Payment","id":"payment_1","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D6A5E"},"Amount":{"code":"USD","minorUnit":2,"currencySource":"Charged","value":872.8},"FormOfPaymentIdentifier":{"id":"formOfPayment_1","FormOfPaymentRef":"formOfPayment_1","Identifier":{"authority":"Travelport","value":"7041667d-0717-4e5f-a6ea-9bf6e6e59399"}},"OfferIdentifier":[{"id":"offer_1","offerRef":"offer_1","Identifier":{"authority":"Travelport","value":"a059d2f2-5d98-4e1b-885d-26b4d0896f64"}}]},"key":"air_offer","summary":"For air offer","id":"paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_offer"},"paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer":{"value":{"@type":"Payment","id":"payment_1","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D6A5E"},"Amount":{"code":"AUD","minorUnit":2,"currencySource":"Charged","approximateInd":true,"value":63.1},"FormOfPaymentIdentifier":{"id":"formOfPayment_5","FormOfPaymentRef":"formOfPayment_5","Identifier":{"authority":"Travelport","value":"A0656EFF-FAF4-456F-B061-0161008D6FOP"}},"OfferIdentifier":[{"id":"offer_1","offerRef":"offer_1","Identifier":{"authority":"Travelport","value":"07664bb3-37a0-4c63-a2ef-ed71b5f48d49"}},{"id":"an_o1","Identifier":{"authority":"Travelport","value":"3427d42c-a72d-49ff-b29e-7bb8faa28a47"}}]},"key":"air_and_ancillary_offer","summary":"For air and ancillary offer","id":"paths/~1air~1paymentoffer~1reservationworkbench~1{ReservationResource_Identifier}~1payments/post/requestBody/content/application~1json/examples/air_and_ancillary_offer"},"paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve":{"value":{"@type":"TicketQueryGetByLocator","detailViewInd":true,"Locator":{"value":"7KPPBF","locatorType":"Locator"},"TicketNumber":[{"value":"0572317564374","contentSource":"NDC"}]},"key":"ticket_retrieve","summary":"By locator","id":"paths/~1air~1ticket~1tickets~1getbylocator/post/requestBody/content/application~1json/examples/ticket_retrieve"},"paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void":{"value":{"@type":"TicketQueryUpdateTicket","status":"Complete"},"key":"single_ticket_void","summary":"Ticket void","id":"paths/~1air~1ticket~1tickets~1updatestatus~1{Identifier}/put/requestBody/content/application~1json/examples/single_ticket_void"},"paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void":{"value":{"locator":{"value":"D74QB5"},"documentVoid":[{"documentType":"Ticket","number":["0019905447250"]},{"documentType":"Ticket","number":["0019905447251"]},{"documentType":"Ticket","number":["0019905447252"]}]},"key":"batch_ticket_void","summary":"Batch void","id":"paths/~1documents~1void/post/requestBody/content/application~1json/examples/batch_ticket_void"},"paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code":{"value":{"locator":"BXVCNS"},"key":"document_history_by_locator_code","summary":"By locator code","id":"paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code"},"paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number":{"value":{"locator":"BXVCNS","documentNumbers":[{"number":"7959905312629","documentType":"TKT"}]},"key":"document_history_by_locator_code_and_document_number","summary":"By document number and locator code","id":"paths/~1documents~1history/post/requestBody/content/application~1json/examples/document_history_by_locator_code_and_document_number"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemPersonName","modifyInd":true,"TravelerUpdatableItemID":"6f0ae183-1ffd-4862-89a3-c8df0bd4be42","PersonNameUpdatable":{"Given":"TESTFIRSTABC","Surname":"TESTLAST"}}]},"key":"update_traveler_name","summary":"Traveler name","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_traveler_name"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemCustomerLoyalty","addInd":true,"TravelerUpdatableItemID":"2abe9c17-0f5f-4368-94c7-fa6b36749bf6","CustomerLoyalty":{"id":"customerLoyalty_1","supplier":"QF","cardHolderName":"LOYTEST JORDAN","value":"1295036"}}]},"key":"add_frequent_flyer/FQTV","summary":"Add frequent flyer/FQTV","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/add_frequent_flyer~1FQTV"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemTravelDocument","deleteInd":true,"TravelerUpdatableItemID":"52da40ee-7eda-4844-b7aa-1d57c3667560"}]},"key":"delete_travel_document","summary":"Delete travel document","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/delete_travel_document"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemComments","modifyInd":true,"TravelerUpdatableItemID":"a9736dc1-c6b4-4e71-8c1c-5f04761d60ca","Comments":{"@type":"Comments","Comment":[{"id":"comment_1","value":"Name remarks update"}]}}]},"key":"modify_name_remarks","summary":"Modify name remarks","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/modify_name_remarks"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemEmail","modifyInd":true,"TravelerUpdatableItemID":"a9736dc1-c6b4-4e71-8c1c-5f04761d60ca","Email":{"value":"TravelerOneChange@gmail.com"}}]},"key":"update_email","summary":"Traveler email","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_email"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemTelephone","modifyInd":true,"TravelerUpdatableItemID":"a9736dc1-c6b4-4e71-8c1c-5f04761d60ca","Telephone":{"@type":"TelephoneDetail","countryAccessCode":"1","phoneNumber":"128787867","id":"telephone_1","cityCode":"ORD","role":"Home"}}]},"key":"update_telephone","summary":"Traveler telephone","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_telephone"},"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address":{"value":{"@type":"TravelerQueryUpdate","TravelerUpdatedItem":[{"@type":"TravelerUpdatedItemAddress","modifyInd":true,"TravelerUpdatableItemID":"2abe9c17-0f5f-4368-94c7-fa6b36749bf6","Address":{"role":"Delivery","Number":"1223","Street":"Travers Street change","City":"Burlingame","StateProv":{"name":"California","value":"CA"},"Country":{"value":"US"},"PostalCode":"90210"}}]},"key":"update_address","summary":"Traveler address","id":"paths/~1air~1book~1traveler~1reservationworkbench~1{ReservationResource_Identifier}~1travelers~1updatefromtravelerupdateditems~1{id}/put/requestBody/content/application~1json/examples/update_address"},"paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler":{"value":{"@type":"TravelerUpdatableItemsQueryBuildFromTraveler","TravelerIdentifier":["371c780b-75ba-448a-8656-aa156f6c363c"]},"key":"updatable_items_one_traveler","summary":"One traveler","id":"paths/~1air~1book~1updatableItem~1reservationworkbench~1{ReservationResource_Identifier}~1travelerupdatableitems~1buildfromtraveler/post/requestBody/content/application~1json/examples/updatable_items_one_traveler"},"paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide":{"value":{"@type":"ReservationQueryDivide","ReservationIdentifier":{"Identifier":{"authority":"Travelport","value":"ca362411-093f-460f-8e1f-8d2bf5a1a1ae"}},"TravelerIdentifier":[{"id":"travelerRefId_1","TravelerRef":"travelerRefId_1","Identifier":{"authority":"Travelport","value":"440c20f5-1c7e-40a4-b01c-30f88a9ee794"}}]},"key":"reservation_divide","summary":"Order divide","id":"paths/~1air~1book~1reservation~1reservations~1divide/post/requestBody/content/application~1json/examples/reservation_divide"},"paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search":{"value":{"@type":"CatalogOfferingsQueryAirChange","CatalogOfferingsAirChangeRequest":{"@type":"CatalogOfferingsAirChangeRequestReservation","returnBrandedFaresInd":true,"detailViewInd":true,"SearchCriteriaFlight":[{"@type":"SearchCriteriaFlight","departureDate":"2026-11-24","From":{"value":"DEN"},"To":{"value":"ORD"}}],"PassengerCriteria":[{"@type":"PassengerCriteriaAirChange","number":1,"age":39,"birthDate":"2000-11-11","passengerTypeCode":"ADT","TravelerIdentifierRef":{"id":"travelerRefId_1"}}],"BuildFromReservationWorkbench":{"@type":"BuildFromReservationWorkbench","ReservationIdentifier":{"Identifier":{"authority":"Travelport","value":"b08425e1-test-4972-test-52f4ae9bae16"}},"OfferIdentifier":{"id":"offer_1"},"ProductIdentifier":[{"id":"product_1"}]}}},"key":"exchange_search","summary":"Exchange search - one traveler","id":"paths/~1exchangesearch~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/exchange_search"},"paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer":{"value":{"@type":"OfferQueryBuildFromCatalogOfferings","fareRuleType":"TextLong","lowFareFinderInd":false,"returnBrandedFaresInd":false,"reCheckInventoryInd":false,"BuildFromCatalogOfferingsRequest":{"@type":"BuildFromCatalogOfferingsRequestAir","CatalogOfferingsIdentifier":{"id":"CatalogOfferings_1","Identifier":{"value":"3b2d928b-d936-42f5-a8ce-8e27ef158c0e","authority":"Travelport"}},"CatalogOfferingIdentifier":{"Identifier":{"value":"o0.0","authority":"Travelport"}}}},"key":"exchange_modify_offer","summary":"Add/modify offer","id":"paths/~1air~1book~1offer~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/exchange_modify_offer"},"paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop":{"value":{"@type":"CatalogOfferingsQueryAirChange","CatalogOfferingsAirChangeRequest":{"@type":"CatalogOfferingsAirChangeRequestReservation","returnBrandedFaresInd":true,"offersPerPage":10,"SearchCriteriaFlight":[{"departureDate":"2026-11-28","From":{"value":"SYD"},"To":{"value":"MEL"}}],"PassengerCriteria":[{"@type":"PassengerCriteria","number":1,"passengerTypeCode":"ADT"}],"BuildFromReservationWorkbench":{"@type":"BuildFromReservationWorkbench","ReservationIdentifier":{"Identifier":{"authority":"QF","value":"438efa7d-717b-46b1-a162-e8fac22d556f"}},"OfferIdentifier":{"Identifier":{"authority":"QF","value":"UUYwODFSRkdPQVhBNHxQQUU4MTQ3NzYtOUI3MS00RjZGLTg5QTRwbWkxcmk0YjcybHRmLTEtMXxTdGF0dXM6VVNFRCBOVEFDfE9yZGVyaXRlbUlkOlBBRTgxNDc3Ni05QjcxLTRGNkYtODlBNHBtaTFyaTRiNzJsdGYtMS0xO1BUQzpBRFQ="}},"ProductIdentifier":[{"Identifier":{"authority":"QF","value":"d9dc08a4-d673-4d8e-b2a0-5cddcdcddff5"}}]}}},"key":"ndc_reshop","summary":"NDC reshop","id":"paths/~1air~1change~1catalogofferingsairchange/post/requestBody/content/application~1json/examples/ndc_reshop"},"paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice":{"value":{"@type":"OfferQueryBuildFromCatalogOfferings","BuildFromCatalogOfferingsRequest":{"@type":"BuildFromCatalogOfferingsRequestAir","CatalogOfferingIdentifier":{"Identifier":{"authority":"QF","value":"WDY3OURGN0E0LTIwRTItNEM5QS1BOEZGLTF8WDY3OURGN0E0LTIwRTItNEM5QS1BOEZGfDIwMjYtMDgtMjVUMDk6NDk6MTB8QURUOlg2NzlERjdBNC0yMEUyLTRDOUEtQThGRi0xLTF8UUZ8RkxFWHxDdXJyZW5jeUNvZGU6QVVE"}},"CatalogOfferingsIdentifier":{"Identifier":{"authority":"QF","value":"WDY3OURGN0E0LTIwRTItNEM5QS1BOEZGLTF8WDY3OURGN0E0LTIwRTItNEM5QS1BOEZGfDIwMjYtMDgtMjVUMDk6NDk6MTB8QURUOlg2NzlERjdBNC0yMEUyLTRDOUEtQThGRi0xLTF8UUZ8RkxFWHxDdXJyZW5jeUNvZGU6QVVE"}}}},"key":"ndc_reprice","summary":"NDC reprice","id":"paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice"},"paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin":{"value":{"@type":"OfferQueryBuildFromCatalogOfferings","BuildFromCatalogOfferingsRequest":{"@type":"BuildFromCatalogOfferingsRequestAir","CatalogOfferingIdentifier":{"Identifier":{"authority":"QF","value":"WDY3OURGN0E0LTIwRTItNEM5QeUNvZGU6QVVE"}},"CatalogOfferingsIdentifier":{"Identifier":{"authority":"QF","value":"WDY3OURGN0E0LTIwRTItNEM5QSfgtrdsGU6QVVE"}}},"PaymentCriteria":{"@type":"PaymentCriteria","IssuerIdentificationNumber":"4275887","PaymentCardCode":"CC"}},"key":"ndc_reprice_with_bin","summary":"NDC reprice with BIN request","id":"paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromcatalogofferings/post/requestBody/content/application~1json/examples/ndc_reprice_with_bin"},"paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice":{"value":{"@type":"OfferQueryBuildFromOffer","BuildFromOffer":{"@type":"BuildFromOfferAir","OfferIdentifier":{"Identifier":{"authority":"SQ","value":"NThLOEMzfFNRXzU4SzhDM19BSVItMXxTUXxTUV81OEs4QzN8cHJvZHVjdDFfczEtU0VHMXxBRFQ6UEFYMg=="}}}},"key":"ndc_standalone_reprice","summary":"Standalone reprice","id":"paths/~1air~1reprice~1reservationworkbench~1{ReservationResource_Identifier}~1offers~1buildfromoffer/post/requestBody/content/application~1json/examples/ndc_standalone_reprice"},"paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement":{"value":{"@type":"AgencyQueueSummary","ReservationIdentifier":{"value":"HN0366"},"Queue":[{"value":4}]},"key":"queue_placement","summary":"Queue placement","id":"paths/~1air~1queue~1queue/post/requestBody/content/application~1json/examples/queue_placement"},"paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove":{"value":{"@type":"AgencyQueueSummary","ReservationIdentifier":{"value":"HN0366"},"Queue":[{"value":4,"pccOverride":"1AA1","category":"AR","dateOffset":3}]},"key":"queue_remove","summary":"Queue remove","id":"paths/~1air~1queue~1queue~1remove/post/requestBody/content/application~1json/examples/queue_remove"},"paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list":{"value":{"@type":"AgencyQueueSummary","Queue":[{"value":4}]},"key":"queue_list","summary":"Queue list","id":"paths/~1air~1queue~1queue~1list/post/requestBody/content/application~1json/examples/queue_list"},"paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail":{"value":{"TravelAgencyQueryTravelAgency":{"Address":{"AddressLine":["28 BROAD STREET"],"City":"ENGLEWOOD","StateProv":{"name":"COLORADO"},"Country":{"name":"US"},"PostalCode":"80111","Addressee":"NAME"},"CorporateCode":"TEST01USCWT","Telephone":[{"countryAccessCode":"1","areaCityCode":"303","phoneNumber":"877676732","extension":"123","cityCode":"DEN"},{"countryAccessCode":"1","areaCityCode":"720","phoneNumber":"128787867","extension":"456","cityCode":"DEN"}],"Email":{"value":"TravelerOne@gmail.com"}}},"key":"travel_agency_detail","summary":"Travel agency detail","id":"paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency/post/requestBody/content/application~1json/examples/travel_agency_detail"},"paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add":{"value":{"TravelAgencyQueryTravelAgencyAddress":{"Address":{"@type":"AddressDetail","AddressLine":["28 BROAD STREET"],"City":"ENGLEWOOD","StateProv":{"name":"COLORADO"},"Country":{"name":"US"},"PostalCode":"80111","Addressee":"ONE TEST","role":"Business"}}},"key":"travel_agency_address_add","summary":"Add travel agency address","id":"paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1addaddress/post/requestBody/content/application~1json/examples/travel_agency_address_add"},"paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update":{"value":{"TravelAgencyQueryTravelAgencyAddress":{"Address":{"@type":"AddressDetail","AddressLine":["28 BROAD STREET"],"City":"ENGLEWOOD","StateProv":{"name":"COLORADO"},"Country":{"name":"US"},"PostalCode":"80111","Addressee":"ONE TEST","role":"Business"}}},"key":"travel_agency_address_update","summary":"Update travel agency address","id":"paths/~1air~1ticket~1travelagency~1reservationworkbench~1{ReservationResource_Identifier}~1travelagency~1{id}~1updateaddress/put/requestBody/content/application~1json/examples/travel_agency_address_update"}},"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/flights","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/flights","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/flights/@11.35.2/index.json?download"},{"url":"/_bundle/apis/flights/@11.35.2/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"TripServices Flights","description":"The TripServices Flights API collection supports rapid development of high-performing travel solutions. The Air APIs connect you to comprehensive air content and facilitate multi-channel development across web and mobile platforms. All requests are RESTful and support JSON. 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/flights","routesMapping":{}}