TABLE OF CONTENTS

OrderRetrieve

This endpoint provides the ability to retrieve an existing Order. Itinerary details, passenger details are all returned in the OrderViewRS.


VersionDateDescription of Edit
Beta2025/09/16Initial Commit
v1.02025/10/22OrderRetrieveRQ:
  • Add gdnOrderId
v1.12025/11/23Added display for freshbooking with bundle in orderRetrieve response
v1.22026/04/23

OrderView:

  • Return GST related field in contactInfos node.
  • Response with richer modification history.


Request Details
Pathv1.0/api/flight/connectivity/order/orderRetrieve
Pathv1.1/api/flight/connectivity/order/V1.1/orderRetrieve
Pathv1.2/api/flight/connectivity/order/V1.2/orderRetrieve


Request Payload Example

Request Payload Example
{
   "retrieveOrder": {
       "order": {
           "supplierOrderId": "917609440975591701"
       }
   }
}

Request Payload Schema 

KeyParentTypeMandatory/OptionalDescription
retrieveOrderrootObjectM
orderretrieveOrderObjectMorderId returned from OrderView response
supplierOrderIdorderStringMUse this parameter when adding seats after a ticket has been issued (post-booking). It references the existing, confirmed order
gdnOrderIdorderStringO
orderStatusretrieveOrderStringO


Response

orderRetrieve return the same OrderView structure that is produced by orderCreate; no new fields are introduced, so the payload layout documented for the response applies unchanged to this endpoints