ServiceList
Modified on: 2025-11-06 13:56
TABLE OF CONTENTS
ServiceList
| Version | Date | Description of Edit |
|---|---|---|
| v1.0 | 2025/10/22 | Initial Commit |
| Request Details | |
|---|---|
| Path | /api/flight/connectivity/search/serviceList |
Request Payload Example
Request Payload Example
{
"offer": {
"offerId": "bb2e32186bdb4048a9a8b02c9902fc29"
}
}Request Payload Structure
| Key | Parent | Type | Mandatory/Optional | Description |
|---|---|---|---|---|
| offer | root | Object | O | |
| offerId | offer | String | M | Use this parameter when adding services during the initial booking process. offerId should return from AirShopping endpoint. |
| order | root | Object | O | |
| supplierOrderId | orderId | String | M | Use this parameter when adding services after a ticket has been issued (post-booking). It references the existing, confirmed order |
| gdnOrderId | orderId | String | O | |
| tripsInfo | root | Object | O | |
| tripKey | tripsInfo | String | M | |
| onwardTrip | tripsInfo | Object | M | |
| segmentInfos | onwardTrip | Array | M | segment information list |
| segmentSequence | segmentInfos | String | M | |
| flightDesignator | segmentInfos | Object | M | |
| marketingCarrier | flightDesignator | Object | M | |
| marketingCarrierCode | marketingCarrier | String | M | |
| marketingFlightNumber | marketingCarrier | String | M | |
| departureInfo | segmentInfos | Object | M | |
| departureDate | departureInfo | String | M | YYYY-MM-DD |
| departureTime | departureInfo | String | M | HH:MM |
| airportCode | departureInfo | String | M | |
| arrivalInfo | segmentInfos | Object | M | |
| arrivalDate | arrivalInfo | String | M | YYYY-MM-DD |
| arrivalTime | arrivalInfo | String | M | HH:MM |
| airportCode | arrivalInfo | String | M | |
| returnTrip | tripsInfo | Object | O | |
| promotionCriteria | root | Object | O | A Promotion and discount code criteria to be passed to the retailer airline that could influence returned offers |
| promotionCode | promotionCriteria | String | O | Promotion 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
| Key | Parent | Type | Mandatory/Optional | Description |
|---|---|---|---|---|
| serviceResult | root | Object | O | |
| flightOfferRefId | seatResult | String | O | |
| flightOrderRef | seatResult | Object | O | |
| supplierOrderId | flightOrderRef | String | M | |
| gdnOrderId | flightOrderRef | String | O | |
| serviceOffers | serviceResult | Array | M | |
| serviceOfferId | serviceOffers | String | M | A unique identifier for this specific service offering. This ID must be provided in subsequent flow |
| service | serviceOffers | Object | M | |
| serviceName | service | String | M | The commercial name of the service as displayed to passengers |
| serviceType | service | String | M | The category of the ancillary service:
|
| availability | service | String | O | Indicates current available numbers of the service |
| limitedPerPsg | service | String | O | Indicates any purchase limitations per passenger |
| baggageAssociations | service | Object | O | This node is ONLY present when serviceType = 'BAGGAGE'. Contains baggage-specific details |
| baggageId | baggageAssociations | String | M | |
| typeCode | baggageAssociations | String | M | Type of baggage
|
| descTex | baggageAssociations | String | O | |
| maximumDimensionAllowance | baggageAssociations | Object | O | |
| heightMeasure | maximumDimensionAllowance | String | O | Maximum allowed height of the baggage |
| lengthMeasure | maximumDimensionAllowance | String | O | Maximum allowed length of the baggage. |
| linearMeasure | maximumDimensionAllowance | String | O | Maximum allowed linear dimensions (sum of dimensions) |
| widthMeasure | maximumDimensionAllowance | String | O | Maximum allowed width of the baggage |
| unitOfMeasurement | maximumDimensionAllowance | String | O | Unit of measurement for dimensions (e.g., CM, IN) |
| pieceAllowance | baggageAssociations | Object | O | |
| totalQty | pieceAllowance | String | M | Total number of baggage pieces allowed |
| weightAllowance | baggageAssociations | String | M | |
| maximumWeightMeasure | weightAllowance | String | M | Maximum allowed weight per baggage piece |
| weightUnitOfMeasurement | weightAllowance | String | M | Unit of measurement for weight (e.g., KG, LB) |
| servicePsgFare | serviceOffers | Array | M | |
| paxType | servicePsgFare | String | M | |
| unitPrice | servicePsgFare | Object | M | |
| totalAmount | unitPrice | String | M | |
| currency | unitPrice | String | M | |
| eligibleTrips | serviceOffers | Object | M | Indicates which specific trip segments this service applies to. Multiple serviceOffers are returned when a service is available for different trips. |
| onwardTrip | eligibleTrips | Object | O | |
| segmentSequence | onwardTrip | Array | O | Segment sequence numbers in the onward trip that this service applies to |
| returnTrip | eligibleTrips | Object | O | |
| segmentSequence | onwardTrip | Array | O | Segment sequence numbers in the return trip that this service applies to |
| eligibleLeg | serviceOffers | Object | O | For multi-leg segments (flights with stopovers), specifies which specific leg within a segment the service applies to. Empty for non-stop flights. |
| legSequence | eligibleLeg | String | M | |
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.