Custom Auxiliary Segments API Reference
|
POST |
book/airoffer/reservationworkbench/{workbenchID}/customauxiliarysegments For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response. Base path: Pre-production https://api.pp.travelport.net/11/air/ Production https://api.travelport.net/11/air/ |
Related Content: Air Booking Guide
GDS only, not supported for NDC.
Auxiliary segments can be added to a new or an existing booking. To delete auxiliary segments, use Cancel Workbench Items. Adding and deleting auxiliary segments must happen within a workbench session. Refer to the Auxiliary Segments section of the Air Booking Guide for more information about auxiliary segments.
-
When creating a new booking with only an auxiliary segment, initiate the workbench, add the auxiliary segment, add traveler, and commit workbench.
-
When adding an auxiliary segment to an existing booking, initiate the workbench, add the auxiliary segment, and commit workbench.
-
When creating a new booking with both air and an auxiliary segment, add the auxiliary segment after initiating the workbench.
Request
As part of the request requirements, also see Authentication and Common Flights API Headers.
Query Parameters
None.
Request Body
|
Object |
Description |
Required/Optional |
|---|---|---|
|
CustomAuxiliarySegment |
Wrapper object for request. Send with @type value CustomAuxiliarySegment. |
Required |
|
id |
Short system-generated id for this segment. |
Optional |
|
SegmentType |
Either TUR for tour or SUR for surface. |
Required |
|
SupplierCode |
Two-character provider/vendor code. ZZ can be used as a generic vendor code for a service provider in the Travelport system. If not sent, ZZ is default. |
Optional |
|
StatusCode |
Status code for booking. |
Required |
|
Quantity |
Number of passengers. |
Required |
|
Location |
Pickup location code. |
Required |
|
Date |
Start date of segment. |
Required |
|
CustomTextQualifier |
Free form text |
Optional |
|
CustomText |
Free text that can include details about the segment. |
Optional |
Response
|
Object |
Description |
|---|---|
|
CustomAuxiliarySegmentResponse |
Top-level object for response. Includes the CustomAuxiliarySegments object. |
|
CustomAuxiliarySegments |
Object that includes Identifier. |
|
Identifier |
Returns the system-generated identifier in value. |
Example Request
{
"CustomAuxiliarySegment": [
{
"@type": "CustomAuxiliarySegment",
"SegmentType": "TUR",
"SupplierCode": "ZZ",
"StatusCode": "BK",
"Quantity": "1",
"Location": "RNO",
"Date": "2026-08-26",
"CustomTextQualifier": "CF",
"CustomText": "08291647"
},
{
"@type": "CustomAuxiliarySegment",
"SegmentType": "SUR",
"SupplierCode": "AA",
"StatusCode": "AK",
"Quantity": "1",
"Location": "QRO",
"Date": "2026-09-01",
"CustomTextQualifier": "LS",
"CustomText": "LEISURE"
}
]
}
Example Response
{
"CustomAuxiliarySegmentResponse": {
"CustomAuxiliarySegments": [
{
"@type": "CustomAuxiliarySegment",
"Identifier": {
"value": "3e1a9345-afdc-424a-9a64-be45d6ef1900"
}
}
]
}
}