DerbySoft GDN Seller API

TABLE OF CONTENTS

OrderCreate

OrderCreate

This endpoint enables sellers to pay and issue an order for the selected flight offers and optional ancillary products-such as seat selection, extra baggage, priority boarding, etc. Alternatively, it can create a hold booking without immediate payment.

Version	Date	Description of Edit
Beta	2025/09/16	Initial Commit
v1.0	2025/10/22	OrderView: Add gdnOrderId/gdnBookingId Modified Price object Add technicalCapabilities object Add payment object Add modificationHistory

Request Details
Path	/api/flight/connectivity/order/orderCreate

Request Payload Example

Request Payload Example

{
   "createOrder": {
       "sellerOrderNumber": "",
       "serviceOrders": [
           {
               "serviceType": "Baggage",
               "paxIndex": 1,
               "serviceOfferId": "48be7e8d-fc89-461f-9523-b310ed485cf5"
           },
           {
               "serviceType": "Seat",
               "paxIndex": 2,
               "serviceOfferId": "48be7e8d-fc89-461f-9523-b310ed485cf5"
           }
       ],
       "pricedOffer": {
           "offerId": "bb2e32186bdb4048a9a8b02c9902fc29"
       }
   },
   "paxList": [
       {
           "paxType": "ADT",
           "individual": {
               "genderCode": "M",
               "titleName": "Mr",
               "surname": "Rivera",
               "givenName": "Deborah",
               "middleName": "Rebecca",
               "birthDate": "1930-06-04",
               "citizenshipCountryCode": "US"
           },
           "paxIndex": 1
       },
       {
           "paxType": "ADT",
           "individual": {
               "genderCode": "M",
               "titleName": "Mr",
               "surname": "Martinez",
               "givenName": "Jeffrey",
               "middleName": "Frank",
               "birthDate": "1968-03-30",
               "citizenshipCountryCode": "CN",
               "age": 57
           },
           "paxIndex": 2
       }
   ],
   "contactInfos": [
       {
           "emailAddress": "xxxxx@gmail.com",
           "individual": {
               "genderCode": "M",
               "titleName": "Mr",
               "surname": "Lewis",
               "givenName": "Jose",
               "middleName": "",
               "birthDate": "1978-11-27",
               "citizenshipCountryCode": "US"
           },
           "phone": {
               "phoneNumber": "15544525411",
               "contactTypeText": "M"
           }
       }
   ],
   "payment": {
       "amount": "1961.67",
       "paymentCurrency": "USD"
   }
}

Request Payload Structure

Key	Parent	Type	Mandatory/Optional	Description
createOrder	root	Object	M
tripsInfo	createOrder	Object	O
tripKey	tripsInfo	String	M
onwardTrip	tripsInfo	Object	M
segmentInfo	onwardTrip	Array	M
segmentSequence	segmentInfo	Int	M
flightDesignator	segmentInfo	Object	M
marketingCarrier	flightDesignator	Object	M
marketingCarrierDesigCode	marketingCarrier	String	M
marketingFlightNumber	marketingCarrier	String	M
departureInfo	segmentInfo	Object	M
departureDate	departureInfo	String	M
departureTime	departureInfo	String	M
airportCode	departureInfo	String	M
arrivalInfo	segmentInfo	Object	M
arrivalDate	arrivalInfo	String	M
arrivalTime	arrivalInfo	String	M
airportCode	departureInfo	String	M
returnTrip	tripsInfo	Object	O
pricedOffer	createOrder	Object	M
offerId	pricedOffer	String	M	offerId that used in offerPrice
cabinClass	pricedOffer	String	O
totalPrice	pricedOffer	Object	O	Total flight price
totalAmount	totalPrice	String	O
totalBaseAmount	totalPrice	String	O
totalTaxFeeAmount	totalPrice	String	O
totalTktFeeAmount	totalPrice	String	O	All service fees related to flight booking - including those charged by non-airline suppliers, DerbySoft.
taxFeeDetail	totalPrice	Array	O
currency	totalPrice	String	M
passengerFares	pricedOffer	Array	O
paxType	passengerFares	String	O
price	passengerFares	Object	O
fareComponent	passengerFares	Array	O
onwardTrip	fareComponent	Object	O
segmentInfo	onwardTrip	Array	O
segmentSequence	segmentInfo	Int	M
bookingCode	segmentInfo	String	M
returnTrip	fareComponent	Object	O
promotionCriteria	createOrder	Objec	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.
sellerOrderNumber	createOrder	String	O	Seller order number that generated in external seller system
serviceOrders	createOrder	Array	O
serviceOfferId	serviceOrder	String	M	The unique identifier of the service offer obtained from the serviceList or seatAvailability response
serviceType	serviceOrder	String	M	The category type of the ancillary service being ordered： Baggage Meal PriorityBoarding SpecialAssitance SeatSelection SportEquipment
totalAmount	serviceOrder	String	O
currency	serviceOrder	String	O
sellerOrderNumber	serviceOrder	String	O	Seller order number that generated in external seller system
paxIndex	serviceOrder	String	M	The index number of the passenger (from the paxList array) to whom this service applies.
serviceTrip	serviceOrder	Object	O
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
serviceLeg	serviceOrder	Object	O
legSequence	eligibleLeg	String	O
data	serviceOrder	Object	O
baggageAssociations	data	Object	O	This node is ONLY present when serviceType = 'BAGGAGE'. Contains baggage-specific details
baggageId	baggageAssociations	String	O
typeCode	baggageAssociations	String	O	Type of baggage CheckedIn CarryOn
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	O	Total number of baggage pieces allowed
weightAllowance	baggageAssociations	String	O
maximumWeightMeasure	weightAllowance	String	O	Maximum allowed weight per baggage piece
weightUnitOfMeasurement	weightAllowance	String	O	Unit of measurement for weight (e.g., KG, LB)
seat	data	Object	O
seatId	seat	String	O
designator	seat	String	O	Referred to as airline code
deck	seat	String	O	Indicates the level or deck of the aircraft where the seat is located. Main: for the primary cabin deck Upper: for the upper deck
rowNo	seat	String	O	Specifies the row number of the seat
colNo	seat	String	O	Specifies the column position or seat letter within the row
seatType	seat	Array	O	The characteristics and features of the seat. This field uses standardized codes: WINDOW AISLE EXIT MIDDLE EXTRA_LEG_ROOM HANDICAP_ACCESSIBLE: wheelchair accessible seat
paxList	root	Array	M
paxType	paxList	String	M	Passenger Type Code: ADT TEEN CHD INF *Note: Different airlines may have varying pax type classifications and age definitions for each type. DerbySoft will provide a reference library of airline-specific passenger age criteria for Sellers. If a pax type requested by the Seller (e.g., TEEN) is not supported by the Supplier, DerbySoft will map the Seller’s requested type to a corresponding type supported by the Supplier.
paxIndex	paxList	Int	M	Assign a passenger index starting from 1(i.e., 1, 2, 3, and so on)
associatedPaxIndex	paxList	Int	O	This node is used to assign the adult to whom the child is linked when the passenger type is “INF” If empty, the infant will by default be linked to the first ADT in the itinerary.
individual	paxList	Object	M
age	individual	String	O
birthdate	individual	String	M
genderCode	individual	String	M	F=female M=male X=others
givenName	individual	String	M
surName	individual	String	M	Family/Lastname of the Pax
middleName	individual	String	O
titleName	individual	String	M	A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status
citenzenshipCountryCode	individual	String	M
loyaltyProgramAccount	paxList	Object	O
accountNumber	loyaltyProgramAccount	String	O
carrier	loyaltyProgramAccount	String	O
programName	loyaltyProgramAccount	String	O
programCode	loyaltyProgramAccount	String	O
identityDoc	paxList	Object	O	Use the passengerIdentifyDocumentsRequired flag returned by the offerPrice endpoint to determine whether the order can be created without passenger documents; if the flag is false, the passenger information in this node is mandatory.
identityDocTypeCode	identityDoc	String	M	Travel Document Types P: Passport
identityDocId	identityDoc	String	M
expiryDate	identityDoc	String	O
issuingCountryCode	identityDoc	String	O
issueDate	identityDoc	String	O
birthdate	identityDoc	String	O
genderCode	identityDoc	String	O
ktn	paxList	String	O	The expedited screening program in the United States
redress	paxList	String	O	The Rapid Screening Program Auxiliary identification number in the United States
contactInfos	root	Array	M	Can support multiple contact information
individual	contactInfos	Object	M
age	individual	String	O
birthdate	individual	String	O
genderCode	individual	String	O	F=female M=male X=others
givenName	individual	String	M
surName	individual	String	M	Family/Lastname of the Pax
middleName	individual	String	O
titleName	individual	String	O	A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status
citenzenshipCountryCode	individual	String	O
emailAddress	contactInfos	String	M
contactTypeText	phone	String	O	Recommended for indicating the contact type, such as below value: Passenger OTA
phone	contactInfos	Object	O
phoneNumber	phone	String	O	Format: country code followed by a space and the phone number, e.g. +86 18700000000
payment	root	Object	O	The payment must match one of the supplier accepted payment methods
amount	payment	String	M	Amount to be charged to this payment method
paymentCurrency	payment	String	M
paymentGateway	payment	String	O	Enumeration: Direct: pay directly to airline/suppliers DSPAY: 3rd party payment service
paymentMethod	payment	Object	O
paymentCard	paymentMethod	Object	O	When the payment method is cash, this node does not need to be completed
cardBrandCode	paymentCard	String	M	For example: Visa Master
cardNumber	paymentCard	String	M	Credit card number
cardSecurityCode	paymentCard	String	M	Card CVC/CVV number
cardType	paymentCard	String	M	For example: Visa Visa-debit Visa-connect-debit Mastercard Mastercard-debit
cardHolderName	paymentCard	String	M	Name of cardholder, as it appears on the card
expirationDate	paymentCard	String	M	Card expiration time YYYY-MM-DD
payer	payment	Object	O	When the payment method is card, this node is mandatory
payerName	payer	Object	O
givenName	payerName	String	M
surName	payerName	String	M	Family/Lastname of the Pax
middleName	payerName	String	O
titleName	payerName	String	O
phone	payer	Object	O
contactTypeText	phone	String	O	Recommended for indicating the payer type, such as below value: Passenger OTA
phoneNumber	phone	String	O

Response Schema - OrderViewRS

Key	Parent	Type	Mandatory/Optional	Description
orderView	root	Object	O
order	orderView	Object	M
orderId	order	Object	M
supplierOrderId	orderId	String	M	Use this parameter when adding seats after a ticket has been issued (post-booking). It references the existing, confirmed order
gdnOrderId	orderId	String	O
info	order	Object	M
orderStatus	info	String	M	please refer to order status enumeration table
createdDate	info	String	M	yyyy-mm-dd hh:mm:ss, UTC time
modifiedDate	info	String	M	yyyy-mm-dd hh:mm:ss, UTC time
paymentStatus	info	String	M	unpaid processing paid cancelled failed
totalPrice	order	Object	O	Order total price
totalAmount	totalPrice	String	M
currency	totalPrice	String	M
supplier	order	Object	O
supplierName	supplier	String	O
airlineCode	supplier	String	O
agencyCode	supplier	String	O
technicalCapabilities	supplier	Array	O	node provides critical information about the technical execution methods and support channels available for post-booking operations with this specific supplier. This allows you to understand how different modification requests (e.g., refunds, changes) are handled behind the scenes and set the correct user expectations
operationType	technicalCapabilities	String	M	The type of post-booking operation. This field identifies which specific operation the technical details apply to (e.g., refunding a ticket, changing a flight). It scopes the context for the subsequent technical fields. DIRECT_REFUND ESTIMATED_REFUND CHANGE_FLIGHT_TIME UPDATE_PASSENGER_NAME ADD_ANCILLARY
method	technicalCapabilities	String	M	How the operation is technically executed. Key values: NATIVE_API: The supplier provides a direct, automated API. DS_AI_AGENT: Automation is enabled via an AI agent (e.g., RPA, robotic process).Note: This automated service may involve additional fees charged to the seller. MANUAL: The operation cannot be processed automatically. The seller must handle it offline by contacting the supplier or airline directly through their own channels
automationLevel	technicalCapabilities	String	M	The degree of automation. This field provides a high-level, intuitive summary of the method FULL PARTIAL NONE
apiAvailability	technicalCapabilities	String	M	This provides granular technical detail for integrators when the method is NATIVE_API REALTIME: A synchronous API that provides immediate results ASYNC: An asynchronous API; a request is submitted, and the result must be polled for later.
paxList	orderView	Array	M
paxType	paxList	String	M	ADT TEEN CHD INF
paxIndex	paxList	Int	M	passenger index starting from 1(i.e., 1, 2, 3, and so on)
ticketNumber	paxList	Object	O	Passenger ticket number information
onwardTrips	ticketNumber	Array	M
segmentSequence	onwardTrips	String	M
ticketNumber	onwardTrips	String	M
returnTrips	ticketNumber	Array	O
airlinePnr	paxList	Object	O	Passenger airline pnr information
onwardTrips	airlinePnr	Array	M
segmentSequence	onwardTrips	String	M
airlinePnr	onwardTrips	String	M
returnTrips	airlinePnr	Array	O
individual	paxList	Object	O
flightInfo	orderView	Array	O
bookingId	flightInfo	Object	M	Booking id for flight order, for most suppliers, it’s same with orderId
supplierBookingId	bookingId	String	M
gdnBookingId	bookingId	String	O
info	flightInfo	Object	M
orderStatus	info	String	M	Flight order status, please refer to order status enumeration table
createdDate	info	String	M	yyyy-mm-dd hh:mm:ss, UTC time
modifiedDate	info	String	M	yyyy-mm-dd hh:mm:ss, UTC time
paymentStatus	info	String	M	unpaid processing paid cancelled failed
offer	flightInfo	Object	M	Same offer object as returned by the offerPrice endpoint
tripsInfo	flightInfo	Object	M	Same tripsInfo object as returned by the offerPrice endpoint
paxIndex	flightInfo	Array	O	An array containing the indices of passengers from the paxList who are associated with this specific flight itinerary. Note: this field is only returned when passengers within the same order have different flight itineraries(e.g., partially change flight time). If all passengers in the order share the identical itinerary, this field will not return.
serviceInfo	orderView	Array	O	Same serviceInfo object in the orderCreate request
contactInfos	orderView	Array	O	Same contactInfos object in the orderCreate request
payments	orderView	Array	O
createdDate	payments	String	M	The timestamp when the payment record was initially created
modifiedDate	payments	String	M	The timestamp when the payment record was last updated
paymentKey	payments	String	M	A unique identifier for this specific payment transaction
paymentTypeCode	payments	String	O	Cash Card
paymentStatus	payments	String	M	unpaid processing paid cancelled failed
totalPrice	payments	Object	M
totalAmount	totalPrice	String	M
currency	totalPrice	String	M
modificationHistory	orderView	Array	O	The modificationHistory node provides a complete audit trail of all post-booking changes and refund requests made to an order. It allows you to track the status, scope
modificationId	modificationHistory	String	M	A unique identifier for this specific modification request.
modificationType	modificationHistory	String	M	The category of the modification CHANGE_FLIGHT_TIME UPDATE_PASSENGER_NAME ADD_ANCILLARY PARTIAL_REFUND REFUND
requestedDateTime	modificationHistory	String	M	The timestamp when the request was initially submitted
initiatedBy	modificationHistory	String	M	USER SYSTEM
modificationStatus	modificationHistory	String	M	REQUEST_RECEIVED PROCESSING REJECTED COMPLETED CANCELLED
scope	modificationHistory	Object	O	Defines the exact parts of the order affected by this request
affectedPassengers	scope	Array	O
affectedTrips	scope	Array	O
modificationDetails	modificationHistory	Object	O
updatePassengerName	modificationDetails	Object	O	Same updatePassengerName object as requested by the orderChange endpoint
flightTimeChange	modificationDetails	Object	O	Same flightTimeChange object as requested by the orderChange endpoint
refundDetails	modificationDetails	Object	O	Present for REFUND or PARTIAL_REFUND types. Contains requested and approved amounts, fees, and a detailed breakdown of what was refunded.
refundAmount	refundDetails	String	O
refundBreakDown	refundDetails	Array	O
currency	refundDetails	String	O
refundTo	refundDetails	String	O
lastUpdated	modificationHistory	String	O
error	root	Object	O