Add Offer Full Payload API Reference

POST

book/airoffer/reservationworkbench/{workbenchID}/offers/buildfromproducts

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: Booking Guide, Booking Session Workflow

Use the Add Offer full payloadClosed In the JSON APIs, an API call that sends all details of the flight/s to be shopped, priced, added to the workbench, etc. instead of sending a reference to an offer in a previous API response. request to add an offerClosed 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. to the reservation workbench as part of the bookingClosed A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. workflow. The full payload request sends full itineraryClosed The entire trip on a booking, including all flights on all legs. Also called a journey. details instead of identifiers from the Search response as in the reference payload request.

Full payload is not supported for NDCClosed New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide.; use the reference payloadClosed 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. instead. For GDSClosed 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., you can send either a reference payload or a full payload.
Add Multiple Offers (GDS)
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 PCCClosed Pseudo city code. A travel provider's identification code for the JSON APIs, provisioned from Travelport. Used to determine access and other settings in the JSON APIs for your company. must be provisioned for multi-offers; contact your Travelport representative if necessary. GDS only; not supported for NDC.
Add offer to expired booking (GDS only)

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. GDS only; not supported for NDC.

Pricing modifiers and brand information

The full payload request supports optional pricing modifiers and/or brandClosed An upgrade from the base fare that includes certain features in the price, such as wifi or seat selection. Features included in a brand are specified in the brand attributes (BrandAttributes object). information. You must send these modifiers during the initial booking workbench session - you cannot add them later.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Basic Add Offer Request - Full Payload

Object

Description

Required/Optional

OfferQueryBuildFromProducts

 

Top level object.

Contains BuildFromProductsRequest.

Required

BuildFromProductsRequest

Top level object. Contains PassengerCriteria, ProductCriteriaAir, and PricingModifiersAir (optional).

Required

PassengerCriteria

Defines the type of passenger. Send one PassengerCriteria object for each passenger type code (PTCClosed Passenger Type Code, used to categorize travelers. The most common PTCs are adult (ADT), child (CNN), and infant (INF). You can request a maximum of 9 passengers in one Search request.).

For a full list of PTCs, see the Tools page for the SOAP/XML API Reference Data file.

May include TravelerGeographicLocation.

Required

passengerTypeCode

The PTC of the passenger type.

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.

Required

number

The number of passengers in that PTC for this request. Default is 1.

Required

age

The age of the passenger.

Notes on PTC and age
  • Travelport recommends that age be sent only with PTCs that require age for pricing.
  • Travelport recommends sending the PTC CNN for a child instead of CHD, in which NN is the child's age; e.g., C08, C10. Many fares cannot be quoted for code CHD.
  • 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.
  • The age for INF must be either 0 or 1.
  • In the Search and Price requests, when sending specifiedPassengerTypeCodeOnlyInd as true for a child, also send the PTC CNN along with the age of the child. (This indicator is used to return offers for only the specified PTC.)
  • During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate).

Optional

TravelerGeographicLocation

Optional object for requesting local citizen/local resident fares for Spain and associated islands.

You must also send a PTC relevant to the local resident fares; e.g., ADR for adult resident, CHR for child resident.
GDS only; not supported for NDC.

Optional

value

String. IATAClosed International Air Transportation Association, an organization that standardizes rules, regulations and fare construction principles for the international travel industry. code specifying the location relevant to the local citizen//local resident fare.

Optional

travelerGeographicLocationType

String. The type of location. Supported values are 

  • Country
  • City
  • State/Province

Optional

ProductCriteriaAir

Array. Each instance is one legClosed The flight or connecting flights between one origin and destination pair. For example, on a round-trip flight, LAX > MSP could be the first leg (aka outbound leg) and MSP > DEN > LAX could be the second leg (aka inbound leg). The JSON APIs use the term product (see below) to represent one leg of the itinerary. of the itinerary.

Includes one or more SpecificFlightCriteria objects.

Required

SpecificFlightCriteria

Array. Each instance is one flight on that leg.

Required

carrierClosed An airline.

String. IATA code of airline carrier for flight.

Required

flightNumber

String. Flight number assigned by airline.

Required

departureDate

String. Departure date of flight in YYYY-MM-DD format (e.g., departureDate="2024-12-06")

Required

departureTime

String. Departure time of flight. HH:MM:SS (24-hour) format (e.g., departureTime="18:00").

Required

arrivalDate

String. Arrival date of flight in YYYY-MM-DD format.

Required

arrivalTime

String. Arrival time of flight in HH:MM:SS (24-hour) format.

Required

from

String. IATA airport code of departure.

Required

to

String. IATA airport code of arrival.

Required

cabin

String. Cabin class to book.

Required

classOfService

String. Class of service to book.

Required

segmentSequence

Order of this segment in this leg, starting with 1 for the first segment on the leg. A segment is one flight with the same flight number.

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.

Required

AvailabilitySourceCode

Recommended to send in the full payload request.

Supported values and definitions for AvailabilitySourceCode are as follows:

  • 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

Optional but recommended

boundFlightsInd

This indicator is not sent by the user but instead is sent if included in the information stored in the price by the carrier.

The bound flights indicator boundFlightsInd is a Boolean variable indicating segments are married/bound. 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. For example, if an O&DClosed Origin and destination (O&D) pair, or one leg of an itinerary. In the JSON APIs, product is the term for the flight/s on one leg. pair has 3 flight segments, boundFlightsInd is returned for the first two segments on that leg. If the segments are not bound, boundFlightsInd is false and not returned. Not returned for NDC.

n/a

brandTier

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 below.

Optional

passiveSegmentStatus

AirReservation 25.11.58 and later. GDS only; not supported for NDC.

Send only to add a passive segment to the booking. (A passive segment is a segment booked outside of the JSON APIs.) Adds support for booking and ticketing an air segment booked in another system. Supported in the Add Offer full payload request by sending two new objects added to ProductCriteriaAir: SpecificFlightCriteria/passiveSegmentStatus and SupplierLocator. Supported only on ODM version 11.22 and higher. Supported only for AK and BK segment statuses. There is a known Issue in the Add Offer Full Payload that is causing YK segments to fail at commitClosed API call that ends a workbench session, finalizing all changes and requests in that session. Depending on the workbench transactions, the commit workbench request may create a reservation, issue a ticket or EMD, exchange tickets, or modify a reservation.. Recommended to also send SupplierLocator per below.

Optional

SupplierLocator

Send only to add a locator code for a passive segment. Optional to send with SpecificFlightCriteria /passiveSegmentStatus per above; however, must be added prior to ticketing.

Optional

value

String. Supplier/airline locator code for the passive segment.

Required if SupplierLocator is sent

supplierCode

String. Two-letter IATA carrier code for the airline the passive segment is booked on.

Required if SupplierLocator is sent

PricingModifiersAir

 

Any optional pricing modifiers. See PricingModifiersAir table below.

Optional

OrganizationInformation

Use to send optional India GST SSR Remarks in GSTRegistrationNumber.

Optional

GSTRegistrationNumber

Key value pairs:

country: String. Should be IND

address: String. Address of company owing GST.

companyName. String. Name of company owing GST.

email: String: Email of company owing GST.

telephone: String: Phone number of company owing GST.

value: String: GST number of company owing GST.

All values are required if sent

 

OrganizationInformation

Any optional account codes.

Optional

GSTRegistrationNumber

Send to add India GST (Goods and Services Tax) SSRs. If sent, all of the following are required; these are details for the business purchasing the goods and services in the GST:

country: String. IATA country code, should be IND.

address: String. Business address.

companyName: String. Business name.

email: String. Business email address.

telephone: String. Business telephone number.

value: String. GST registered number for the business.

See India GST SSRs in the Remarks & Service Requests Guide for important details.

All values are required if sent

PricingModifiersAir (optional pricing modifiers)

Optionally, you can 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:

  • Modifiers sent in the Add Offer request (supported for both full and reference payload)

  • If no modifiers are sent in Add Offer, any pricing modifiers sent in AirPrice are applied

  • If no modifiers were sent in AirPrice, any pricing modifiers sent in Search are applied

GDS only; not supported for NDC.

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.

Object

Description

Required/Optional

PricingModifiersAir

 

Any optional pricing modifiers.

Required only when sending fare modifiers.

Includes FareSelection.

Optional

currencyCode

The currency code for overriding the default currency associated with your PCC provisioned by Travelport.

Optional

TicketingPCC
GDS only, not supported for NDC.

String, 2-10 characters supported. Overrides the ticketing PCC associated with your account to specify an alternate PCC and return pricing based on that PCC. (PCC is the pseudo city code; a travel provider's identification code for the JSON APIs, provisioned from Travelport.)

Optional

PricingPCC
GDS only, not supported for NDC.

String, 2-10 characters supported. 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. The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly (see immediately below) return results as follows:

  • PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and private faresClosed Special air fares negotiated by agencies. Private fares may use account names, account codes, contract codes, or corporate IDs. (if available) are returned for the requesting and providing PCC.

  • PricingPCC sent and PrivateFaresOnly not requested: If no selective access or group agreement exists, only public fares are returned.

  • PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, private fares (if available) are returned for the requesting and providing PCC.

  • PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists but does not allow private fares access, or if no agreement exists, an error is returned.

Optional

ManualFareAdjustment

AirReservation 24.11.50 and later. GDS only, not supported for NDC.

Number up to 2 decimal places. Send to manually adjust the base fare amount on all fares. You can adjust 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.

Send with @type value ManualFareAdjustmentDiscount to decrease the base fare. Send with @type value ManualFareAdjustmentIncrease to increase the fare.

For an example see the Add Offer Reference Payload API Reference.

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.

If the PCC currency and the country of origin currency are different, then the amount or percentage is applied to the filed amount base fare that is converted into the PCC currency.

Optional

passengerTypeCodes

Send the PTC or PTCs to be increased or decreased. This increases or decreases the fare for all passengers with the PTC/s. If not sent, ManualFareAdjustment applies to all PTCs.

Optional

AmountPercentPercent

Send to adjust the base fare by a percentage as follows:

Percent: Send percentage of the base fare to be decreased or increased, up to two decimal places. For example, the value 20.5 would either increase (when sent in @type ManualFareAdjustmentIncrease) or decrease (when sent in @type ManualFareAdjustmentDiscount) the base fare by 20.5%.

Either AmountPercentPercent or AmountPercentAmount is required if ManualFareAdjustment is sent

AmountPercentAmount

Send to adjust the base fare by an amount as follows:

Amount: Send the 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 either increase (when sent in @type ManualFareAdjustmentIncrease) or decrease (when sent in @type ManualFareAdjustmentDiscount) the base fare by $14.75.

Either AmountPercentPercent or AmountPercentAmount is required if ManualFareAdjustment is sent

TaxExemption

Sends specific tax codes to mark as tax exempt.

TaxExemption supports up to nine values for countries, or nine values for taxCodes, or up to nine values in countries and taxCodes combined.

Key value pairs; send either or both countries and taxCodes or allTaxesExemptInd:

  • countries: Array. One or more countries in which the taxCodes sent are tax exempt.
  • taxCodes: Array. One or more tax codes to mark as exempt.
  • allTaxesExemptInd: Indicator. Send with value true to mark all taxes on the itinerary as tax exempt.

Optional

FareSelection

Additional optional fare modifiers.

Stores 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).

Optional

fareType

Allows you to store either a private fare or a public fareClosed A published fare available to all consumers without an account or corporate code., or the lowest of either private or public fares. These can be combined.

Supported values are:

  • PublicFaresOnly: Only public fares for specified itinerary.
  • PrivateFaresOnly: Only private fares for the itinerary.
  • Private&PublicFares: Lowest of all public and private fares.
  • NetFaresOnly: Only net fares.

Optional

refundableOnlyInd

true stores only refundable fares, false stores only non-refundable fares.

Optional

prohibitMinStayFaresInd

true stores only fares that do not require a minimum stay; false allows minimum stay fares.

Optional

prohibitMaxStayFaresInd

true stores only fares that do not require a maximum stay; false allows maximum stay fares.

Optional

prohibitAdvancePurchaseFaresInd

true stores only fares that do not require advance purchase; false allows fares with advance purchase restrictions.

Optional

validatingCarrier

Allows you to specify the carrier to override the default validating carrier (the airline designator that the ticket is issued against). String to send the IATA code for a carrier to override the default validating carrier.

If the validating carrier code is not supported for an itinerary, the response returns the error Ticketing Agreement does not exist.

If an invalid validating carrier code is sent in the request, the response returns the error Unknown Carrier.

Optional

FareModifiers

Top level object for account codes. Required only when sending account code.

Optional

Account

Sends account codes for negotiated fares.

Optional

code

The account code to price.

Optional

Brand

Send in PricingModifiersAir only if requesting to store a fare with brand details at the offer level.

Optional

tier

The brand tier.

Optional

Response

The response returns the system-generated offer identifier. This identifier must be sent in several subsequent transactions, such as payment and ticketing.

Object

Description

OfferListResponse

Top level object.

OfferID

Top level object.

Identifier

Returns the system-generated offer identifier in the following key value pairs; in this case authority is Travelport:

authority: Source of information.

value: Unique system-generated identifierClosed 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

The following example full payload request adds an offer for a one-wayClosed An itinerary with a single destination; e.g., LHR > CDG. itinerary. 

{
    "OfferQueryBuildFromProducts": {
        "BuildFromProductsRequest": {
            "@type": "BuildFromProductsRequestAir",
            "PassengerCriteria": [
                {
                    "number": 1,
                    "passengerTypeCode": "ADT"
                }
            ],
            "ProductCriteriaAir": [
                {
                    "SpecificFlightCriteria": [
                        {
                            "flightNumber": "1177",
                            "carrier": "UA",
                            "departureDate": "2022-01-09",
                            "departureTime": "10:15:00",
                            "arrivalDate": "2022-01-09",
                            "arrivalTime": "15:09:00",
                            "from": "DEN",
                            "to": "ATL",
                            "classOfService": "P",
                            "cabin": "First",
                            "segmentSequence": 1,
                            "brandTier": "9"
                        }
                    ]
                }
            ]
        }
    }
}
{
    "OfferQueryBuildFromProducts": {
        "BuildFromProductsRequest": {
            "@type": "BuildFromProductsRequestAir",
            "PassengerCriteria": [
                {
                    "number": 1,
                    "age": 25,
                    "passengerTypeCode": "ADT"
                }
            ],
            "ProductCriteriaAir": [
                {
                    "SpecificFlightCriteria": [
                        {
                            "flightNumber": "733",
                            "carrier": "QF",
                            "departureDate": "2022-01-09",
                            "departureTime": "08:35:00",
                            "arrivalDate": "2022-01-09",
                            "arrivalTime": "10:10:00",
                            "from": "SYD",
                            "to": "ADL",
                            "classOfService": "Q",
                            "cabin": "Economy",
                            "segmentSequence": 1,
                            "brandTier": "1"
                        },
                        {
                            "flightNumber": "680",
                            "carrier": "QF",
                            "departureDate": "2022-01-09",
                            "departureTime": "12:05:00",
                            "arrivalDate": "2022-01-09",
                            "arrivalTime": "13:50:00",
                            "from": "ADL",
                            "to": "MEL",
                            "classOfService": "Q",
                            "cabin": "Economy",
                            "segmentSequence": 2,
                            "brandTier": "1"
                        }
                    ]
                },
                {
                    "SpecificFlightCriteria": [
                        {
                            "flightNumber": "402",
                            "carrier": "QF",
                            "departureDate": "2022-01-16",
                            "departureTime": "06:00:00",
                            "arrivalDate": "2022-01-16",
                            "arrivalTime": "07:25:00",
                            "from": "MEL",
                            "to": "SYD",
                            "classOfService": "Q",
                            "cabin": "Economy",
                            "segmentSequence": 1,
                            "brandTier": "1"
                        }
                    ]
                }
            ]
        }
    }
}
{
        "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": [
                    {
                        "sequence": 0,
                        "SpecificFlightCriteria": [
                            {
                                "flightNumber": "1814",
                                "carrier": "KL",
                                "departureDate": "2025-04-26",
                                "departureTime": "07:00:00",
                                "arrivalDate": "2025-04-26",
                                "arrivalTime": "08:05:00",
                                "from": "FRA",
                                "to": "AMS",
                                "classOfService": "T",
                                "cabin": "Economy",
                                "segmentSequence": 1,
                                "passiveSegmentStatus": "AK"
                            }
                        ],
                        "SupplierLocator": {
                            "value": "WTR84G",
                            "supplierCode": "KL"
                        }
                    }
                ]
            }
        }
    },

Example Response

The response returns the system-generated offer identifier. This identifier must be sent in several subsequent transactions, such as payment and ticketing.

{
    "OfferListResponse": {
        "OfferID": [
            {
                "@type": "OfferIdentifier",
                "Identifier": {
                    "authority": "Travelport",
                    "value": "ec33332f-bdde-4bca-bebf-e81568f0d205"
                }
            }
        ]
    }
}