Add/Modify Offer Reference Payload API Reference

POST

book/offer In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. An offer includes 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./reservationworkbench/{workbenchID}/offers/buildfromcatalogofferings

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: Exchange, Refund, and Void Guide

Send the Add/Modify Offer request as part of the GDS Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport. ticket exchange Cancel or modify a ticketed itinerary and issue a new ticket. See the Cancel, Exchange, and Refund Options Guide. process. The Add/Modify Offer reference payload In the JSON APIs, an API call that sends identifers referring to a previous response for the itinerary to be shopped, priced, added, etc. instead of full itinerary details. sends identifiers from an offer returned in a preceding Exchange Search response to use that offer to modify the offer on the current itinerary The entire trip on a booking, including all flights on all legs. Also called a journey.. The system compares the existing itinerary with the new itinerary, deletes any flight segments no longer needed, and adds the new flight segments. Any unmodified segments remain as they are.

Send Add/Modify after using Exchange Search to search for a new itinerary. After Add/Modify Offer, send Workbench Commit either hold or ticket the modified itinerary.

The Add/Modify Offer reference payload request supports the automated exchange workflow, in which updates are made and new ticket/s issued using the JSON APIs, Manual exchanges, which ticket a modified itinerary after making updates outside the JSON APIs, are not supported.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Show Add/Modify Offer Request Body Table (reference payload)

Object	Description	Required/Optional
OfferQueryBuildFromCatalogOfferings	Top level object.	Required
BuildFromCatalogOfferingsRequest	Top level object.	Required
CatalogOfferingsIdentifier	Top level object for transaction identifier from the Exchange Search response. Key value pair: id: The id value from the Exchange Search response.	Required
CatalogOfferingsIdentifier/Identifier	Transaction identifier from the Exchange Search response.	Required
value	Send value from CatalogOfferings/Identifier/value	Required
authority	Send value from CatalogOfferings/Identifier/authority	Required
CatalogOfferingIdentifier	Top level object for offer identifier from the Exchange Search response for the offer you want to exchange for.	Required
CatalogOfferingIdentifier/Identifier	Offer identifier from the Exchange Search response.	Required
value	Send value from CatalogOffering/Identifier/value	Required
authority	Send value from CatalogOffering/Identifier/authority	Required

Response

The response returns a confirmation identifier.

Show Add/Modify Response Body Table (reference payload)

Object	Description
OfferListResponse	Top level object. Includes OfferID object.
OfferID	Top level object. Includes Identifier object.
Identifier	Internal identifier for the response. Key value pairs: authority: Source of information. value: Unique system-generated identifier In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..

Object

Description

OfferListResponse

Top level object. Includes OfferID object.

OfferID

Top level object. Includes Identifier object.

Identifier

Internal identifier for the response.

Key value pairs:

authority: Source of information.

value: Unique system-generated identifier In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..

Example Request

For additional examples and scenarios, download the developer toolkits and see Using Postman and Developer Toolkits.

The response returns a confirmation identifier per below.

Show Example

{
 "OfferQueryBuildFromCatalogOfferings": {
  "BuildFromCatalogOfferingsRequest": {
   "@type": "BuildFromCatalogOfferingsRequestAir",
   "CatalogOfferingsIdentifier": {
    "id": "CatalogOfferings_1",
    "Identifier": {
     "value": "04373e5e-b6b8-4cae-93eb-b630bcf6afdc",
     "authority": "Travelport"
    }
   },
   "CatalogOfferingIdentifier": {
    "Identifier": {
     "value": "o0.0",
     "authority": "Travelport"
    }
   }
  }
 }
}

Example Response

For additional examples and scenarios, download the developer toolkits and see Using Postman and Developer Toolkits.

The response returns a confirmation identifier per below.

Show Example Add/Modify Offer response

{
 "OfferListResponse": {
  "OfferID": [
   {
    "@type": "OfferIdentifier",
    "Identifier": {
     "authority": "Travelport",
     "value": "0995bea0-602d-4572-b1ef-bbe1c6e44807"
    }
   }
  ]
 }
}