DerbySoft GDN Seller API

TABLE OF CONTENTS

Request Payload Example

Request Payload Structure
Response
- ResponsePayload Example

Version	Date	Description of Edit
V1.0	2025/10/22	Initial Commit
V1.1	2025/11.23	Added bundleOfferId parameter to support bundle-integrated service selection
V1.2	2026/07/02	Added detailed price breakdown fields under servicePsgFares Added totalWeightMeasure under baggage weightAllowance.
V2.0	2026/08/15	Added bundleCode Supported returning ssrCode for bundle included services Added taxCode in unit price tax details

Request Details
Path	V1.0	/api/flight/connectivity/search/serviceList (for freshbooking) /api/flight/connectivity/order/serviceList (for postbooking)
Path	V1.2	/api/flight/connectivity/search/V1.2/serviceList (for freshbooking) /api/flight/connectivity/order/V1.2/serviceList (for postbooking)
Path	V2.0	/api/flight/connectivity/search/V2.0/serviceList (for freshbooking) /api/flight/connectivity/order/V2.0/serviceList (for postbooking)

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 seats during the initial booking process. offerId should return from AirShopping endpoint.
bundleOffers	offer	Array	O
bundleOfferId	bundleOffers	String	O	The bundleOfferId parameter is required when querying seat availability specifically for seats included in a bundle purchase. Include this field only when: The service selection is part of a bundle identified in the bundleAvailability response The bundle service has "needSelection": true for bundle services
order	root	Object	O
supplierOrderId	order	String	M	Use this parameter when adding seats after a ticket has been issued (post-booking). It references the existing, confirmed order
gdnOrderId	order	String	O
upgradeSSR	order	Object	O	[Since v2.0] Required ONLY when searching for a baggage/SSR upgrade.
targetSupplierBookingId	upgradeSSR	String	M	[Since v2.0] The unique instance identifier of the specific booked service (e.g., the existing 30kg baggage
targetgdnBookingId	upgradeSSR	String	M	[Since v2.0]
serviceName	upgradeSSR	String	O	[Since v2.0] Bundle includes service upgrade, the bookingId shall be bundle, and service name shall be baggage name. It’s mandatory for bundle included services upgrade
ssrCode	upgradeSSR	String	O	[Since v2.0] Bundle includes service upgrade, the bookingId shall be bundle, and ssr code baggage code.
reshopOffer	order	Object	O	[Since v2.0] It’s used to query available ancillary services (meals, etc.) for the newly selected flight segments during the rebooking flow. To streamline the user experience, services that can be automatically transferred/carried forward (such as baggage) will NOT be returned. Standalone Service Selection: Returns only the standalone SSRs that were purchased in the original booking but CANNOT be automatically carried forward, allowing passengers to re-select them. (e.g., For AirAsia, standalone meal choices will only be returned if the original flight contained a purchased meal that was dropped during rebooking). Bundle Meal Selection: If the original booking contained a Bundle, this API returns available meal choices to allow passengers to re-select their bundled meals (since custom bundle meals reset to default SSRs after rebooking).
reshopOfferId	reshopOffer	String	M	[Since v2.0] The unique identifier of the flight exchange offer, which is generated and returned by the preceding orderReshop API response.
reshopTransInfo	reshopOffer	String	M	[Since v2.0] The unique identifier of the flight exchange offer, which is generated and returned by the preceding orderReshop API response.
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

ResponsePayload 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
           }
       ]
   }
}

Key	Parent	Type	Mandatory/Optional	Description
serviceResult	root	Object	O
flightOfferRefId	searchResult	String	O
flightOrderRef	searchResult	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
ssrCode	service	String	O	[Since v2.0]
serviceName	service	String	M	The commercial name of the service as displayed to passengers
serviceType	service	String	M	The category of the ancillary service： Baggage Meal Priority Boarding Special Assistance Seat Selection Sport Equipment Carbon Offset
availability	service	Int	O	Indicates current available numbers of the service
limitedPerPsg	service	String	O	Indicates any purchase limitations per passenger
baggageAssociation	service	Object	O	This node is ONLY present when serviceType = 'BAGGAGE'. Contains baggage-specific details
baggageId	baggageAssociation	String	M
typeCode	baggageAssociation	String	M	Type of baggage CheckedIn CarryOn
descText	baggageAssociation	String	O
maximumDimensionAllowance	baggageAssociation	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	baggageAssociation	Object	O
totalQty	pieceAllowance	String	M	Total number of baggage pieces allowed
weightAllowance	baggageAssociation	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)
totalWeightMeasure	weightAllowance	String	O	Total maximum weight allowed for the baggage allowance. Used when the allowance is based on total weight across pieces.
ssrUpgrade	service	Object	O	[Since v2.0] Will only return is node when it’s ssr upgrade search
isUpgradeOption	ssrUpgrade	String	O	[Since v2.0] Evaluates to true if this service alternative is an upgrade path for an existing product. If empty/false, treat it as a standard new ancillary purchase.
targetSupplierBookingId	ssrUpgrade	String	M	[Since v2.0] Conditional. The unique bookingId of the old booked ancillary that this new option is meant to replace/upgrade. Matches the targetBookingId sent in the request.
targetgdnBookingId	ssrUpgrade	String	M	[Since v2.0] Conditional. The unique bookingId of the old booked ancillary that this new option is meant to replace/upgrade. Matches the targetBookingId sent in the request.
servicePsgFares	serviceOffers	Array	M
paxType	servicePsgFares	String	M
unitPrice	servicePsgFares	Object	M
totalAmount	unitPrice	String	M
currency	unitPrice	String	M
totalBaseAmount	unitPrice	String	M
totalTaxFeeAmount	unitPrice	String	M
totalServiceFeeAmount	unitPrice	String	M
taxFeeDetails	unitPrice	Array	O
code	taxFeeDetails	String	O	The tax name
taxCode	taxFeeDetails	String	O	[Since v2.0] The tax code
amount	taxFeeDetails	String	O
type	taxFeeDetails	String	O
serviceFeeDetails	unitPrice	Array	O
code	serviceFeeDetails	String	O
amount	serviceFeeDetails	String	O
type	serviceFeeDetails	String	O
includedInTotal	serviceFeeDetails	String	O	true - Already included intotalAmount; false - Not included in totalAmount.
currencyConversions	unitPrice	Array	O
fromCurrency	currencyConversions	String	O
toCurrency	currencyConversions	String	O
rate	currencyConversions	String	O
appliedTo	currencyConversions	String	O
referenceCode	currencyConversions	String	O
originalAmount	currencyConversions	String	O
convertedAmount	currencyConversions	String	O
settlementPrices	unitPrice	Array	O	[Since v2.0] For multi-currency, this node will return all eligible settlement currency quotations.
totalBaseAmount	settlementPrices	String	M	[Since v2.0]
totalTaxFeeAmount	settlementPrices	String	M	[Since v2.0]
taxFeeDetails	settlementPrices	Array	O	[Since v2.0]
code	taxFeeDetails	String	O	[Since v2.0] The tax name
taxCode	taxFeeDetails	String	O	[Since v2.0] The tax code
amount	taxFeeDetails	String	O	[Since v2.0]
type	taxFeeDetails	String	O	[Since v2.0] Enum values: AirlineTax - Standard airline taxes VAT - Value added tax Other - Other tax types
totalServiceFeeAmount	settlementPrices	String	O	[Since v2.0]
serviceFeeDetails	settlementPrices	Array	O	[Since v2.0]
code	serviceFeeDetails	String	O	[Since v2.0] All service fees related to flight booking - including those charged by non-airline suppliers, DerbySoft.
amount	serviceFeeDetails	String	O	[Since v2.0]
type	serviceFeeDetails	String	O	[Since v2.0] Enum values: Supplier - Supplier service fee DS - DerbySoft service fee
currency	settlementPrices	String	O	[Since v2.0]
source	settlementPrices	String	O	[Since v2.0]
exchangeRate	settlementPrices	String	O	[Since v2.0]
upgradePriceDetails	unitPrice	Object	O	[Since v2.0] Container for differential financial metrics. Present ONLY if IsUpgradeOption = true.
balanceDue	upgradePriceDetails	String	M	[Since v2.0] The actual net amount to be collected from the user out-of-pocket. Formula: DueAmount = TotalAmount - OriginalTotalAmount
originalServiceCredit	upgradePriceDetails	String	M	[Since v2.0] The financial credit value recovered and deducted from the old booked service (e.g., the original value of the 30kg bag).
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
segmentSequences	onwardTrip	Array	O	Segment sequence numbers in the onward trip that this service applies to
returnTrip	eligibleTrips	Object	O
segmentSequences	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
error	root	Object	O

ServiceList

Request Payload Example

Request Payload Structure

Response

ResponsePayload Example