TABLE OF CONTENTS

ServiceList


Version
DateDescription of Edit
v1.02025/10/22Initial Commit



Request Details
Path/api/flight/connectivity/search/serviceList


Request Payload Example

Request Payload Example
{
   "offer": {
       "offerId": "bb2e32186bdb4048a9a8b02c9902fc29"
   }
}


Request Payload Structure

KeyParentTypeMandatory/OptionalDescription
offerrootObjectO
offerIdofferStringMUse this parameter when adding services during the initial booking process. offerId should return from AirShopping endpoint. 
orderrootObjectO
supplierOrderIdorderIdStringMUse this parameter when adding services after a ticket has been issued (post-booking). It references the existing, confirmed order
gdnOrderIdorderIdStringO
tripsInforootObjectO
tripKeytripsInfoStringM
onwardTriptripsInfoObjectM
segmentInfosonwardTripArrayMsegment information list
segmentSequencesegmentInfosStringM
flightDesignatorsegmentInfosObjectM
marketingCarrierflightDesignatorObjectM
marketingCarrierCodemarketingCarrierStringM
marketingFlightNumbermarketingCarrierStringM
departureInfosegmentInfosObjectM
departureDatedepartureInfoStringMYYYY-MM-DD
departureTimedepartureInfoStringMHH:MM
airportCodedepartureInfoStringM
arrivalInfosegmentInfosObjectM
arrivalDatearrivalInfoStringMYYYY-MM-DD
arrivalTimearrivalInfoStringMHH:MM
airportCodearrivalInfoStringM
returnTriptripsInfoObjectO
promotionCriteriarootObjectOA Promotion and discount code criteria to be passed to the retailer airline that could influence returned offers
promotionCodepromotionCriteriaStringOPromotion code ID or number.



Response Example

Response Example
{
   "error": null,
   "serviceResult": {
       "flightOfferRefId": "bb2e32186bdb4048a9a8b02c9902fc29",
       "flightOrderRef": null,
       "serviceOffers": [
           {
               "serviceOfferId": "ab621fb4-2380-4fec-9e5f-f65f67b6eba1",
               "service": {
                   "serviceName": "Coconut Water",
                   "serviceType": "Meal",
                   "availability": 1500,
                   "limitedPerPsg": "2",
                   "baggageAssociation": null
               },
               "servicePsgFares": [
                   {
                       "paxType": "ADT",
                       "unitPrice": {
                           "totalAmount": "2.120",
                           "currency": "USD",
                           "settlementPrices": null
                       }
                   },
                   {
                       "paxType": "CHD",
                       "unitPrice": {
                           "totalAmount": "2.120",
                           "currency": "USD",
                           "settlementPrices": null
                       }
                   }
               ],
               "eligibleTrips": {
                   "onwardTrip": {
                       "segmentSequences": [
                           1
                       ]
                   },
                   "returnTrip": null
               },
               "eligibleLeg": null
           }
       ]
   }
}


Response Schema

KeyParentTypeMandatory/OptionalDescription
serviceResultrootObjectO
flightOfferRefIdseatResultStringO
flightOrderRefseatResultObjectO
supplierOrderIdflightOrderRefStringM
gdnOrderIdflightOrderRefStringO
serviceOffersserviceResultArrayM
serviceOfferIdserviceOffersStringMA unique identifier for this specific service offering. This ID must be provided in subsequent flow
serviceserviceOffersObjectM
serviceNameserviceStringMThe commercial name of the service as displayed to passengers
serviceTypeserviceStringMThe category of the ancillary service:
  • Baggage
  • Meal
  • PriorityBoarding
  • SpecialAssitance
  • SeatSelection
  • SportEquipment
availabilityserviceStringOIndicates current available numbers of the service
limitedPerPsgserviceStringOIndicates any purchase limitations per passenger
baggageAssociationsserviceObjectOThis node is ONLY present when serviceType = 'BAGGAGE'. Contains baggage-specific details
baggageIdbaggageAssociationsStringM
typeCodebaggageAssociationsStringMType of baggage
  • CheckedIn
  • CarryOn
descTexbaggageAssociationsStringO
maximumDimensionAllowancebaggageAssociationsObjectO
heightMeasuremaximumDimensionAllowanceStringOMaximum allowed height of the baggage
lengthMeasuremaximumDimensionAllowanceStringOMaximum allowed length of the baggage.
linearMeasuremaximumDimensionAllowanceStringOMaximum allowed linear dimensions (sum of dimensions)
widthMeasuremaximumDimensionAllowanceStringOMaximum allowed width of the baggage
unitOfMeasurementmaximumDimensionAllowanceStringOUnit of measurement for dimensions (e.g., CM, IN)
pieceAllowancebaggageAssociationsObjectO
totalQtypieceAllowanceStringMTotal number of baggage pieces allowed
weightAllowancebaggageAssociationsStringM
maximumWeightMeasureweightAllowanceStringMMaximum allowed weight per baggage piece
weightUnitOfMeasurementweightAllowanceStringMUnit of measurement for weight (e.g., KG, LB)
servicePsgFareserviceOffersArrayM
paxTypeservicePsgFareStringM
unitPriceservicePsgFareObjectM
totalAmountunitPriceString
M
currency
unitPriceStringM
eligibleTripsserviceOffersObjectMIndicates which specific trip segments this service applies to. Multiple serviceOffers are returned when a service is available for different trips.
onwardTripeligibleTripsObjectO
segmentSequenceonwardTripArrayOSegment sequence numbers in the onward trip that this service applies to
returnTripeligibleTripsObjectO
segmentSequenceonwardTripArrayOSegment sequence numbers in the return trip that this service applies to
eligibleLegserviceOffersObjectOFor multi-leg segments (flights with stopovers), specifies which specific leg within a segment the service applies to. Empty for non-stop flights.
legSequenceeligibleLegStringM
errorrootObjectO