---
title: "Unpriced Segment"
method: POST
path: "/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments"
tags: ["Booking"]
---

# Unpriced Segment

`POST /air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments`

## Request

- Base URL: `https://api.pp.travelport.net/11`
- URL: `https://api.pp.travelport.net/11/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments`
- Auth: HTTP bearer

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.

## Path parameters

- `ReservationResource_Identifier` string, required

## Headers

- `travelportPlusSessionIdentifier` string
- `TraceId` string
- `XAUTH_TRAVELPORT_ACCESSGROUP` string
- `TVP-PCC-Core` string

## Request body

- UnpricedSegments: Top level object for request. Top level container object for response.
  - `@type` string, required: Discriminator. No child classes.
  - `UnpricedFlightSegment` UnpricedFlightSegment[], required
    - `@type` string, required
    - `id` string: Local identifier within a given message for this FlightSegment
    - `sequence` integer, required: Sequence of the leg of the segment.
    - `connectionDuration` string: The actual duration of the connecting FlightSegment
    - `passengerQuantity` integer: Number of passengers on this segment.
    - `cabin` 'PremiumFirst' | 'First' | 'Business' | 'PremiumEconomy' | 'Economy': Specifies the cabin type. If sent for Flight Specific Search, this field is ignored. Many 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. Some carriers do not support lowFareFinderInd with Premium First cabin class.
    - `classOfService` string: Class of service of the segment.
    - `amenityRefs` string[]: List of amenity references for this flight
    - `universalProductAttributeRefs` string[]: List of universal product attributes for this flight.
    - `passiveSegmentStatus` string: 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.
    - `IntermediateStopAmenities` IntermediateStopAmenities[]
      - `@type` string, required: Discriminator. No child classes.
      - `departureLocation` string, required: The departure location.
      - `arrivalLocation` string, required: The arrival location.
      - `amenityRefs` string[]: List of amenity references for this portion of the flight.
      - `universalProductAttributeRefs` string[]: List of UPA references for this portion of the flight.
    - `OperationalStatus` OperationalStatusENUM: The operational status of the flight
      - `value` 'FlightBoarding' | 'FlightCancelled' | 'FlightDeparted' | 'FlightPastScheduledDeparture' | 'NotAvailableUseSearch': List of operational flight status
    - `Flight` FlightID, required: Flight common schema. Used across Air workflow. One 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.
      - `@type` string, required: Discriminator. Child classes Flight and FlightDetail.
      - `id` string: Local id within a given message to support referencing this object - an internal flight identifier.
      - `FlightRef` string: Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight.
      - `Identifier` Identifier: 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).
        - `value` string: Unique offer identifier that can be sent in subsequent payload requests to reference this offer. 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. 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'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - 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. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. 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'. 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. 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.
        - `authority` string: Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For 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. For 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.
    - `Co2Actual` Measurement: Used for dimensional units (width, height, depth) or weight
      - `value` number, float
      - `measurementType` 'Width' | 'Height' | 'Depth' | 'Weight' | 'OverallDimension': The type of measurement such as width, height, weight
      - `unit` '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': The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).
    - `boundFlightInd` boolean: If present and true, the Segments in this Connection are married.

## Response `200`

OK - Successful Response - 200

- UnpricedSegmentsResponseWrapper: Wrapper schema to expose the root element in the JSON example
  - `UnpricedSegmentsResponse` UnpricedSegmentsResponse: Base response is part of all TripServices responses and includes common items which are relevant across all APIs
    - `UnpricedSegments` UnpricedSegments: Top level object for request. Top level container object for response.
      - `@type` string, required: Discriminator. No child classes.
      - `UnpricedFlightSegment` UnpricedFlightSegment[], required
        - `@type` string, required
        - `id` string: Local identifier within a given message for this FlightSegment
        - `sequence` integer, required: Sequence of the leg of the segment.
        - `connectionDuration` string: The actual duration of the connecting FlightSegment
        - `passengerQuantity` integer: Number of passengers on this segment.
        - `cabin` 'PremiumFirst' | 'First' | 'Business' | 'PremiumEconomy' | 'Economy': Specifies the cabin type. If sent for Flight Specific Search, this field is ignored. Many 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. Some carriers do not support lowFareFinderInd with Premium First cabin class.
        - `classOfService` string: Class of service of the segment.
        - `amenityRefs` string[]: List of amenity references for this flight
        - `universalProductAttributeRefs` string[]: List of universal product attributes for this flight.
        - `passiveSegmentStatus` string: 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.
        - `IntermediateStopAmenities` IntermediateStopAmenities[]
          - `@type` string, required: Discriminator. No child classes.
          - `departureLocation` string, required: The departure location.
          - `arrivalLocation` string, required: The arrival location.
          - `amenityRefs` string[]: List of amenity references for this portion of the flight.
          - `universalProductAttributeRefs` string[]: List of UPA references for this portion of the flight.
        - `OperationalStatus` OperationalStatusENUM: The operational status of the flight
          - `value` 'FlightBoarding' | 'FlightCancelled' | 'FlightDeparted' | 'FlightPastScheduledDeparture' | 'NotAvailableUseSearch': List of operational flight status
        - `Flight` FlightID, required: Flight common schema. Used across Air workflow. One 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.
          - `@type` string, required: Discriminator. Child classes Flight and FlightDetail.
          - `id` string: Local id within a given message to support referencing this object - an internal flight identifier.
          - `FlightRef` string: Reference id that corresponds to the flight 'id' in ReferenceListFlight.Flight.
          - `Identifier` Identifier: 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).
            - `value` string: Unique offer identifier that can be sent in subsequent payload requests to reference this offer. 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. 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'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - 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. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. 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'. 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. 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.
            - `authority` string: Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For 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. For 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.
        - `Co2Actual` Measurement: Used for dimensional units (width, height, depth) or weight
          - `value` number, float
          - `measurementType` 'Width' | 'Height' | 'Depth' | 'Weight' | 'OverallDimension': The type of measurement such as width, height, weight
          - `unit` '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': The unit of measure in a code format. Refer to OpenTravel Code List Unit of Measure Code (UOM).
        - `boundFlightInd` boolean: If present and true, the Segments in this Connection are married.
    - `@type` string
    - `transactionId` string: 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. Also known as E2ETrackingId. Not returned in all Hotel API responses.
    - `traceId` string: Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header.
    - `correlationId` string, uuid: Identifier used to correlate hotel API invocations across a multi-call business flows.
    - `reservationStatus` 'Success' | 'Fail' | 'Partial' | 'Pending' | 'OnHold' | 'Retry' | 'Other': Status of reservation or offer completion.
    - `Result` Result: Returns the error and/or warning message information, if applicable.
      - `@type` string: Discriminator class Result only
      - `status` 'Not processed' | 'Incomplete' | 'Complete' | 'Unknown': The status of an error or warning
      - `Error` Error[]: A list of error information returned at the provider level for a response.
        - `@type` string, required: Discriminator classes Error or ErrorDetail
        - `StatusCode` integer: Http standard response code
        - `Message` string: The Travelport standardized error or warning message
        - `NameValuePair` NameValuePair[]
          - `value` string: 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).
          - `id` string: Optional internally referenced id
          - `name` string, required: Key, categorizing the type of remark or error.
      - `Warning` Warning[]: A list of warning information returned at the provider level for a response.
        - `@type` string, required: Discriminator classes Warning or WarningDetail
        - `StatusCode` integer: Http standard response code
        - `Message` string: The Travelport standardized error or warning message
        - `NameValuePair` NameValuePair[]
          - `value` string: 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).
          - `id` string: Optional internally referenced id
          - `name` string, required: Key, categorizing the type of remark or error.
    - `Identifier` Identifier: 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).
      - `value` string: Unique offer identifier that can be sent in subsequent payload requests to reference this offer. 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. 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'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - 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. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. 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'. 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. 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.
      - `authority` string: Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For 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. For 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.
    - `NextSteps` NextSteps: Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response.
      - `baseURI` string, required: The base portion of the URI in order to shorten the uris in the individual steps
      - `id` string: Optional internally referenced id
      - `NextStep` NextStep[], required
        - `value` string
        - `id` string: Identifier for the Next Step
        - `action` string, required: The action this next step is intended to achieve
        - `method` 'GET' | 'DELETE' | 'PUT' | 'POST', required: Describes the set of potential methods that can be taken after an operation.
        - `description` string: Additional clarification for the next step
    - `ReferenceList` ReferenceList[]
      - `@type` string, required: Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler.
      - `id` string: Uniquely identifies for the Reference List
    - `CurrencyRateConversion` CurrencyRateConversion[]
      - `@type` string
      - `SourceCurrency` CurrencyCode, required: Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For 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.
        - `value` string: An ISO 4217 currency code.
        - `codeAuthority` string: Currency code authority
        - `decimalPlace` integer: Number of decimal places for the currency.
        - `decimalAuthority` string: Currency code decimal authority
      - `TargetCurrency` CurrencyCode, required: Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For 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.
        - `value` string: An ISO 4217 currency code.
        - `codeAuthority` string: Currency code authority
        - `decimalPlace` integer: Number of decimal places for the currency.
        - `decimalAuthority` string: Currency code decimal authority
      - `ConversionRate` ConversionRate, required: 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.
        - `value` number, float
        - `rateAuthority` string: Contextual rate authority
        - `rateAsOf` string, date-time: Rate as of
    - `Pagination` Pagination: Pagination object used when result sets span across a number of pages.
      - `@type` string, required
      - `page` integer, required: The current page number of the full result set
      - `pageSize` integer, required: The total number of items on this page
      - `totalPages` integer, required: The total number of pages in this result set
      - `totalItems` integer, required: The total number of pages in this result set

## Other responses

- `400`: Bad Request - 400
- `401`: Unauthorized - 401
- `402`: Payment Required - 402
- `403`: Forbidden - 403
- `404`: Not Found - 404
- `500`: Internal Server Error - 500
- `503`: Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.

## Changes

- **2026-08-19** `90abcc916990`: 20 info
  - removed request discriminator
  - removed discriminator from `UnpricedFlightSegment/items/` request property
  - removed discriminator from `UnpricedFlightSegment/items/IntermediateStopAmenities/items/` request property
  - removed discriminator from `ErrorResponse/allOf[#/components/schemas/BaseResponse]/Pagination` response property for the response status `400`
  - …16 more

[Operation history](https://skmtc.dev/travelport/apis/tripservices-flights/changes/air/book/airoffer/reservationworkbench/:ReservationResource_Identifier/unpricedsegments/post.md)

---

[API](https://skmtc.dev/travelport/apis/tripservices-flights.md) - [All operations](https://skmtc.dev/travelport/apis/tripservices-flights/llms.txt) - [OpenAPI document](https://skmtc.dev/travelport/apis/tripservices-flights/revisions/9e8fc967631f?raw)
