v1

latestOpenAPI 3.0.02026-08-061029011.1 MB

Booking

Unpriced Segment

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.

post/air/book/airoffer/reservationworkbench/{ReservationResource_Identifier}/unpricedsegments

Path parameters

ReservationResource_Identifierstring required

Example:382c74c3-721d-4f34-80e5-57657b6cbc27

The reservation workbench identifier to add unpriced segments to.

Headers

travelportPlusSessionIdentifierstring

Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

travelportPlusSessionIdentifier used to maintain an established agency session

TraceIdstring

Example:TraceID_123456789

Identifier used to correlate Air API invocations across a multi-call business flows.

XAUTH_TRAVELPORT_ACCESSGROUPstring

Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

TVP-PCC-Corestring

Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Request body

@typestring required

Discriminator. No child classes.

Example request

{
  "@type": "UnpricedSegments",
  "UnpricedFlightSegment": [
    {
      "@type": "UnpricedFlightsegment",
      "id": "unpricedSegment_1",
      "sequence": 1,
      "connectionDuration": "PT2H30M",
      "passengerQuantity": 2,
      "cabin": "Economy",
      "classOfService": "Y",
      "amenityRefs": [
        "amenity_1"
      ],
      "passiveSegmentStatus": "AK",
      "IntermediateStopAmenities": [
        {
          "@type": "IntermediateStopAmenities",
          "departureLocation": "NYC",
          "arrivalLocation": "DEN",
          "amenityRefs": [
            "amenity_1"
          ],
          "universalProductAttributeRefs": [
            "upa_1"
          ]
        }
      ],
      "OperationalStatus": {
        "value": "FlightBoarding"
      },
      "Flight": {
        "@type": "FlightDetail",
        "id": "126",
        "FlightRef": "s1",
        "Identifier": {
          "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
          "authority": "TVPT"
        }
      },
      "Co2Actual": {
        "value": 2.22,
        "unit": "Kilograms"
      }
    }
  ]
}

Response

OK - Successful Response - 200

Example response

{
  "UnpricedSegmentsResponse": {
    "UnpricedSegments": {
      "@type": "UnpricedSegments",
      "UnpricedFlightSegment": [
        {
          "@type": "UnpricedFlightsegment",
          "id": "unpricedSegment_1",
          "sequence": 1,
          "connectionDuration": "PT2H30M",
          "passengerQuantity": 2,
          "cabin": "Economy",
          "classOfService": "Y",
          "amenityRefs": [
            "amenity_1"
          ],
          "passiveSegmentStatus": "AK",
          "IntermediateStopAmenities": [
            {
              "@type": "IntermediateStopAmenities",
              "departureLocation": "NYC",
              "arrivalLocation": "DEN",
              "amenityRefs": [
                "amenity_1"
              ],
              "universalProductAttributeRefs": [
                "upa_1"
              ]
            }
          ],
          "OperationalStatus": {
            "value": "FlightBoarding"
          },
          "Flight": {
            "@type": "FlightDetail",
            "id": "126",
            "FlightRef": "s1",
            "Identifier": {
              "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
              "authority": "TVPT"
            }
          },
          "Co2Actual": {
            "value": 2.22,
            "unit": "Kilograms"
          }
        }
      ]
    },
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}