1. callback notification
STTS OPEN API
English
  • English
  • 中文
  • Flight
    • Search and Pricing
      • Search Flights
      • Price Specified Segments
      • Get All-Cabin Prices
      • Verify a Solution
      • Get Fare and Baggage Rules
    • Orders
      • Create an Original Flight Order
      • List Flight Orders
      • Get Flight Order Details
      • Cancel a Flight Order
      • Get a Flight Order by External Order Number
      • Pay for a Flight Order
    • Refunds and Changes
      • Check Refund and Change Availability
      • Search and Price Flight Changes
      • Create a Flight Change Order
      • Query Refundable Flight Amounts
      • Create a Flight Refund Order
      • Confirm a Flight Refund Order
      • Confirm a Zero-Amount Flight Change Order
    • Services and Status
      • Query Through-Checked and Transit Baggage
      • Query Flight Ticket Status
      • Download an Electronic Ticket Itinerary
    • Account
      • Query Flight Account Balance
    • callback notification
      • Order callback notification
        GET
      • Schedule Change Callback
        GET
  • Train
    • Search and Booking
      • Search Trains
      • Check Seat Availability and Price
      • Get Booking Requirements
      • Create Train Order
    • Orders
      • Get Train Order
      • Get Order Refund and Change Conditions
      • Confirm Pre-sale Order
      • Pay Order
      • Cancel Order
    • Trains and Stations
      • Get Stop Stations by Order
      • Get Stop Stations by Train Number
      • Search Cities and Stations
      • Get Cities and Stations in Bulk
      • Get Exchange Rates
    • Refunds and Changes
      • Estimate Change Fees
      • Estimate Refund Fees
      • Request a Change
      • Request a Refund
      • Confirm Change
      • Confirm Refund
    • 12306
      • Get 12306 Contacts
      • Get 12306 Payment Form
      • Log in to 12306
      • Send 12306 SMS Code
      • Verify 12306 SMS Code
      • Edit 12306 Passenger
      • Perform 12306 Face Verification
      • Submit Foreign Passport Verification
      • Get Foreign Passport Verification Status
    • Partner Sync
      • Incrementally Sync Cities
      • Incrementally Sync Stations
    • Tickets
      • Download PDF Ticket
      • Get HTML Ticket
      • Get Tickets by Type
  • Schemas
    • request
      • request.FlightShoppingRequest
      • request.PayFlightOrderRequest
      • request.ChangeFlightOrderRequests
      • request.CreateFlightOriginOrderRequest
      • request.FlightChangeSearchRequest
      • request.RefundFlightOrderRequest
    • consts
      • consts.FlightOrderStatus
      • consts.FlightOrderType
      • consts.FlightProductType
      • consts.FlightInvoiceType
      • consts.FlightTaxType
      • consts.PassengerEligibility
    • model
      • model.FlightJourneyCore
      • model.PassengerCountRequest
      • model.ChangeSegment
      • model.PassengerFlightOrder
      • model.ChangeShoppingResult
      • model.ChangeShoppingSegment
      • model.FlightSegmentInfo
      • model.FlightCoreSegmentCache
      • model.OrderDetail
      • model.FlightPassengerTickets
      • model.PriceDetail
      • model.PriceInFlightOriginOrder
      • model.PriceInFlightChangeOrder
      • model.PriceInFlightRefundOrder
      • model.PriceInFlightVoidOrder
      • model.FlightSolutionResp
      • model.FlightJourneyResp
      • model.FlightPriceDetail
      • model.FlightPrice
      • model.FlightTax
      • model.FlightSolutionLimitation
      • model.FlightLimitAgePair
    • Schemas
      • response.RequestFlightOrderStatus
      • model.FlightChangeNotify
      • consts.CabinClass
      • consts.CommonStatus
      • response.ApiResponse-response_FlightOrderDetail-response_PriceInFlightChangeOrder
      • response.FlightOrderDetailResp
      • response.Response-string
      • consts.RefundReason
      • consts.CoreDataVerifiesStatus
      • response.FlightOrderDetail-response_PriceInFlightChangeOrder
      • consts.PassengerType
      • internal.AddCMSUserRequest
      • model.FlightChangeInfo
      • consts.Gender
      • internal.AgenciesResp
      • consts.TrainIssueWay
      • consts.TravelDocumentType
      • internal.AgencyRechargeReq
      • consts.TrainOrderStatus
      • internal.CNTrainStationResponse
      • consts.TrainOrderTicketStatus
      • internal.CNTrainStationsResponse
      • consts.TrainPassengerStatus
      • consts.FlightTicketStatus
      • model.BaggageRule
      • internal.CitiesResponse
      • consts.TrainRefundStatus
      • model.BaggageRuleDetail
      • internal.CountriesResponseItem
      • dto.PaginationList-array_resp_TrainOrderResp
      • internal.CountryResponse
      • resp.TrainOrderResp
      • model.StopOver
      • internal.CreateAgenciesRequest
      • resp.TrainOriginTicketDetail
      • internal.CreateCNTrainStationsRequest
      • req.TrainOrderListReq
      • consts.FlightChangeType
      • model.FareRule
      • internal.CreateCityRequest
      • response.Response-dto_PaginationList-array_resp_TrainOrderResp
      • model.FlightPassenger
      • model.FlightJourney
      • internal.CreateCountryRequest
      • model.CreateTrainOriginOrderReq
      • model.FlightSegmentWithCoreSegment
      • internal.CreateOrganizationsRequest
      • response.Response-resp_TrainOrderResp
      • util.Gender
      • model.CoreSegmentDetail
      • internal.ForgetPasswordRequest
      • resp.TrainChangeDetail
      • util.PassengerType
      • model.FlightScheduleChange
      • internal.GetAgencyBalanceChangesItem
      • resp.TrainChangeTicketDetail
      • util.TravelDocumentType
      • internal.GetAgencyCreditHistoriesItem
      • resp.StationDetail
      • model.FlightTicket
      • internal.GetAgencyMembersItem
      • model.ShoppingCNTrainStationsResp
      • model.OrderExtraInfo
      • req.TrainShoppingReq
      • internal.GetAgencyTransactionsItem
      • response.Response-array_model_ShoppingCNTrainStationsResp
      • resp.Seats
      • internal.GetOrganizationDetailResponse
      • util.FlightOrderStatus
      • resp.StationInfo
      • internal.GetOrganizationsByUserIDResponse
      • util.FlightOrderType
      • response.Response-array_resp_TrainShoppingResp
      • internal.GetUserInfoByEmailResponse
      • response.PriceDetailInFlightOrder-response_PriceInFlightChangeOrder
      • resp.TrainShoppingResp
      • internal.GetUserResponse
      • util.FlightProductType
      • internal.GetUsersByOrganizationIDRequest
      • response.PriceInFlightChangeOrder
      • internal.InviteUserRequest
      • response.ApiResponse-response_FlightOrderDetail-response_PriceInFlightOriginOrder
      • internal.LoginRequest
      • response.FlightOrderDetail-response_PriceInFlightOriginOrder
      • internal.LoginResponse
      • response.PriceDetailInFlightOrder-response_PriceInFlightOriginOrder
      • internal.Org4GetUserResponse
      • response.PriceInFlightOriginOrder
      • internal.Org4LoginResponse
      • response.ApiResponse-response_FlightOrderDetail-response_PriceInFlightRefundOrder
      • internal.OrganizationInviteRequest
      • response.FlightOrderDetail-response_PriceInFlightRefundOrder
      • internal.OrganizationResponse
      • response.PriceDetailInFlightOrder-response_PriceInFlightRefundOrder
      • internal.OwnerDataOfOrganization
      • response.PriceInFlightRefundOrder
      • internal.PaginationResp-internal_AgenciesResp
      • response.ApiResponse-response_FlightOrderDetail-response_PriceInFlightVoidOrder
      • internal.PaginationResp-internal_CNTrainStationsResponse
      • response.FlightOrderDetail-response_PriceInFlightVoidOrder
      • internal.PaginationResp-internal_CitiesResponse
      • response.PriceDetailInFlightOrder-response_PriceInFlightVoidOrder
      • internal.PaginationResp-internal_CountriesResponseItem
      • response.PriceInFlightVoidOrder
      • internal.PaginationResp-internal_GetAgencyBalanceChangesItem
      • internal.PaginationResp-internal_GetAgencyCreditHistoriesItem
      • internal.PaginationResp-internal_GetAgencyMembersItem
      • internal.PaginationResp-internal_GetAgencyTransactionsItem
      • internal.PaginationResp-internal_OrganizationResponse
      • internal.PaginationResp-internal_User4GetAgencyUsersResponse
      • internal.PaginationResp-internal_User4GetUsersResponse
      • internal.PaginationResp-internal_UsersByOrganizationIDResponse
      • internal.ResetPasswordRequest
      • internal.RoleForOrganization
      • internal.RoleForUser
      • internal.TransactionType
      • internal.UpdateACLRequest
      • internal.UpdateAgencyCreditReq
      • internal.UpdateAgencyUserRequest
      • internal.UpdateCNTrainStationsRequest
      • internal.UpdateCityRequest
      • internal.UpdateCountryRequest
      • internal.UpdateOrganizationsRequest
      • internal.UpdatePasswordRequest
      • internal.UpdateUserRequest
      • internal.User4GetAgencyUsersResponse
      • internal.User4GetUsersResponse
      • internal.UserDataOfAgency
      • internal.UsersByOrganizationIDResponse
      • model.BillPeriodUnit
      • model.OrganizationUserStatus
      • model.TransactionChannel
      • response.Response-any
      • response.Response-array_internal_GetOrganizationsByUserIDResponse
      • response.Response-internal_CNTrainStationResponse
      • response.Response-internal_CitiesResponse
      • response.Response-internal_CountryResponse
      • response.Response-internal_GetOrganizationDetailResponse
      • response.Response-internal_GetUserInfoByEmailResponse
      • response.Response-internal_GetUserResponse
      • response.Response-internal_LoginResponse
      • response.Response-internal_PaginationResp-internal_AgenciesResp
      • response.Response-internal_PaginationResp-internal_CNTrainStationsResponse
      • response.Response-internal_PaginationResp-internal_CitiesResponse
      • response.Response-internal_PaginationResp-internal_CountriesResponseItem
      • response.Response-internal_PaginationResp-internal_GetAgencyBalanceChangesItem
      • response.Response-internal_PaginationResp-internal_GetAgencyCreditHistoriesItem
      • response.Response-internal_PaginationResp-internal_GetAgencyMembersItem
      • response.Response-internal_PaginationResp-internal_GetAgencyTransactionsItem
      • response.Response-internal_PaginationResp-internal_OrganizationResponse
      • response.Response-internal_PaginationResp-internal_User4GetAgencyUsersResponse
      • response.Response-internal_PaginationResp-internal_User4GetUsersResponse
      • response.Response-internal_PaginationResp-internal_UsersByOrganizationIDResponse
      • sql.NullTime
    • ApiEnvelopeBase
    • ApiResponseBase
    • PayFlightOrderRequest
    • ErrorResponse
    • ItineraryRequest
    • EmptyObject
    • PaymentResponse
    • CabinClass
    • FlightOrderListResponse
    • PassengerType
    • FlightOrderPagination
    • Gender
    • FlightOrderListItem
    • TravelDocument
    • FlightOrderListSolution
    • AllianceCode
    • OrderAgencyInfo
    • TransportType
    • OrderAgencyDetail
    • RefundReason
    • JourneyInFlightOrderList
    • ChangeReason
    • SegmentInFlightOrderList
    • FlightOrderType
    • PassengerInFlightOrderList
    • FlightOrderStatus
    • AirwallexPaymentData
    • PaymentChannel
    • BalancePaymentOrderDetail
    • ConfirmationType
    • ConfirmationIata
    • PassengerInfo
    • FlightJourney
    • PassengerCount
    • AccountCode
    • ShoppingRequirements
    • ShoppingVirtualInterlineConfig
    • ShoppingConfigs
    • OpenAPIFlightShoppingReq
    • PricingReqSegment
    • FlightPricingReq
    • AllCabinPriceReq
    • SolutionValidateReq
    • FareRulesReq
    • CreateFlightOriginOrderRequest
    • PassengerForCreateOriginOrder
    • PayFlightOrderReq
    • RefundChangeAvailabilityReq
    • ChangeSearchReq
    • ChangeSearchPassenger
    • ChangeSearchJourney
    • CreateChangeOrderReq
    • ChangeSegmentItem
    • ConfirmChangeOrderReq
    • ChangeNewSegment
    • RefundMoneySearchReq
    • CreateFlightRefundOrderOpenAPIRequest
    • BaggageTransitReq
    • BaggageTransitLeg
    • BaggageTransitSegment
    • BaggageTransitStopInfo
    • TicketStatusReq
    • TicketStatusPassenger
    • DownloadAirTicketItineraryRequest
    • ConfirmationSheetPrice
    • OpenAPIShoppingResp
    • OpenAPICoreSegment
    • StopOver
    • OpenAPISolutionResp
    • OpenAPIPriceDetail
    • OpenAPILimitInfo
    • FlightLimitAgePair
    • FlightSolutionGroupInfo
    • OpenAPIPrice
    • OpenAPITax
    • OpenAPIJourneyResp
    • OpenAPISegmentInfo
    • OpenAPIBaggageRule
    • BaggageRuleDetail
    • OpenAPIBaggageRules
    • OpenAPIFareRules
    • OpenAPIFareRule
    • OpenAPIPricingResp
    • OpenAPIPricingSolutionResp
    • OpenAPIPricingPriceDetail
    • OpenAPIPricingPrice
    • OpenAPIPricingJourneyResp
    • OpenAPIPricingSegmentInfo
    • OpenAPIVerificationResp
    • OpenAPIFareRulesResp
    • OpenAPIOrderResp
    • OpenAPIOrderJourney
    • OpenAPIOrderSegment
    • OpenAPIOrderCoreSegment
    • OpenAPIOrderPassenger
    • OpenAPIOrderTicket
    • OpenAPIOrderPriceDetail
    • OpenAPIOrderPrice
    • OpenAPIOriginOrderPrice
    • OpenAPIChangeOrderPrice
    • OpenAPIRefundOrderPrice
    • OpenAPIOrderListResp
    • OpenAPIRefundChangeAvailabilityResp
    • OpenAPIRefundChangeAvailabilityPassenger
    • OpenAPIAskChangeDetail
    • OpenAPIAskRefundDetail
    • OpenAPIChangeSearchResp
    • OpenAPIChangeSolutionResp
    • OpenAPIChangePriceDetail
    • OpenAPIChangePrice
    • OpenAPIRefundMoneySearchResp
    • OpenAPIBaggageTransitLeg
    • OpenAPIBaggageTransitSegmentInfo
    • TicketStatusResp
    • TicketStatusItem
    • TicketCouponStatus
    • BalanceResp
    • TrainApiResponseBase
    • TrainErrorResponse
    • TrainConnectionRegion
    • TrainPriceBasis
    • TrainOrderStatus
    • TrainTicketStatus
    • TrainTicketType
    • TrainPassengerAttribute
    • LocalizedName
    • TrainShoppingLocation
    • TrainShoppingRequest
    • TrainStationWithDateTime
    • TrainCarrier
    • TrainShoppingFeature
    • TrainPassengerTypeInfo
    • TrainSeatInfo
    • TrainShoppingSegment
    • TrainShoppingJourney
    • TrainShoppingData
    • TrainPrice
    • TrainAvailabilityRequest
    • TrainAvailabilityData
    • TrainBookingRequirementsData
    • TrainSeatPreference
    • TrainOrderContactRequest
    • TrainOrderContact
    • TrainPassengerRequest
    • Train12306Account
    • TrainCreateOrderRequest
    • TrainCreateChangeRequest
    • TrainCreateRefundRequest
    • TrainChangeEstimateRequest
    • TrainRefundEstimateRequest
    • TrainPassenger
    • TrainOrderSegment
    • TrainOrderTicket
    • TrainOrderJourney
    • TrainOrder
    • TrainConditionFee
    • TrainCondition
    • TrainOrderConditions
    • TrainRefundEstimateItem
    • TrainRefundEstimateData
    • TrainChangeEstimateItem
    • TrainChangeEstimateData
    • TrainStopStation
    • Train12306AccountRequest
    • Train12306Contact
    • Train12306PayFormRequest
    • Train12306PayFormData
    • Train12306LoginRequest
    • Train12306PassengerInfo
    • Train12306LoginData
    • Train12306SendSmsRequest
    • Train12306SmsVerifyRequest
    • Train12306SmsSendData
    • Train12306OperationData
    • Train12306PassengerDto
    • Train12306EditPassengerRequest
    • Train12306FaceImage
    • Train12306FaceVideo
    • Train12306FaceVerifyRequest
    • Train12306ForeignPassportRequest
    • Train12306PassportProcessRequest
    • Train12306PassportCheckData
    • TrainStationInfo
    • TrainCityInfo
    • TrainStationSearchCity
    • TrainStationSearchData
    • TrainCitiesStationsData
    • TrainOrderTicketFile
    • TrainSyncRequest
    • TrainSyncCity
    • TrainSyncStation
    • TrainSyncCitiesData
    • TrainSyncStationsData
    • TrainShoppingApiResponse
    • TrainAvailabilityApiResponse
    • TrainBookingRequirementsApiResponse
    • TrainOrderApiResponse
    • TrainStopStationsApiResponse
    • TrainConditionsApiResponse
    • TrainChangeEstimateApiResponse
    • TrainRefundEstimateApiResponse
    • TrainEmptyApiResponse
    • Train12306ContactsApiResponse
    • Train12306PayFormApiResponse
    • Train12306LoginApiResponse
    • Train12306SmsSendApiResponse
    • Train12306SmsVerifyApiResponse
    • Train12306OperationApiResponse
    • Train12306PassportCheckApiResponse
    • TrainSyncCitiesApiResponse
    • TrainSyncStationsApiResponse
    • TrainTicketsApiResponse
    • TrainStationSearchApiResponse
    • TrainCitiesStationsApiResponse
    • TrainExchangeRatesApiResponse
    • ShoppingApiResponse
    • PricingApiResponse
    • VerificationApiResponse
    • FareRulesApiResponse
    • OrderApiResponse
    • OrderListApiResponse
    • RefundChangeAvailabilityApiResponse
    • ChangeSearchApiResponse
    • RefundMoneySearchApiResponse
    • BaggageTransitApiResponse
    • TicketStatusApiResponse
    • BalanceApiResponse
  1. callback notification

Order callback notification

GET
https://apiv1.simplifly.tech

Request

Authorization
API Key
Add parameter in header
code
Example:
code: ********************
API Key
Add parameter in header
timestamp
Example:
timestamp: ********************
API Key
Add parameter in header
signature
Example:
signature: ********************
or
Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://apiv1.simplifly.tech?code=undefined&signature=undefined&timestamp=undefined' \
--header 'code: <api-key>' \
--header 'timestamp: <api-key>' \
--header 'signature: <api-key>'

Responses

🟢200Success
application/json
Bodyapplication/json

Example
{
  "title": "Order Status Callback",
  "description": "Callback payload for order status changes",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "code",
    "msg",
    "data"
  ],
  "properties": {
    "code": {
      "type": "integer",
      "description": "Callback status code. Normal notification uses 200",
      "examples": [200]
    },
    "msg": {
      "type": "string",
      "description": "Order status message",
      "examples": ["Issued"]
    },
    "data": {
      "oneOf": [
        {
          "$ref": "#/definitions/order"
        },
        {
          "type": "null"
        }
      ],
      "description": "Full order details. Normally an order object; may be null in exceptional cases"
    }
  },
  "definitions": {
    "order": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "id",
        "orderType",
        "status",
        "currency",
        "externalOrderId",
        "journeys",
        "passengers",
        "priceDetail"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Simplifly order ID",
          "examples": ["FOL929GXXZ"]
        },
        "orderType": {
          "type": "string",
          "description": "Order type",
          "enum": [
            "origin",
            "change",
            "refund",
            "void"
          ]
        },
        "status": {
          "type": "string",
          "description": "Current order status",
          "enum": [
            "reviewing",
            "to_be_paid",
            "reserved",
            "proceeding",
            "issued",
            "failed",
            "failed_reimbursing",
            "failed_reimbursed",
            "chg_reviewing",
            "chg_rejected",
            "chg_to_be_paid",
            "chg_to_be_confirm",
            "chg_proceeding",
            "changed",
            "rfd_reviewing",
            "rfd_rejected",
            "rfd_to_be_confirm",
            "rfd_to_be_paid",
            "rfd_proceeding",
            "refunded_reimbursing",
            "refunded_reimbursed",
            "void_proceeding",
            "void_rejected",
            "voided_reimbursing",
            "voided_reimbursed",
            "closed",
            "canceled"
          ]
        },
        "source": {
          "type": "string",
          "description": "Order source"
        },
        "solutionId": {
          "type": "string",
          "description": "Shopping solution ID"
        },
        "currency": {
          "type": "string",
          "description": "Order currency",
          "examples": ["CNY"]
        },
        "validatingCarrier": {
          "type": "string",
          "description": "Validating or ticketing carrier"
        },
        "originOrderId": {
          "type": "string",
          "description": "Original order ID"
        },
        "parentOrderId": {
          "type": "string",
          "description": "Parent order ID"
        },
        "externalOrderId": {
          "type": "string",
          "description": "Distributor's external order ID"
        },
        "contactName": {
          "type": "string",
          "description": "Contact name"
        },
        "contactEmail": {
          "type": "string",
          "description": "Contact email"
        },
        "contactRegion": {
          "type": "string",
          "description": "Phone country or region code"
        },
        "contactPhone": {
          "type": "string",
          "description": "Contact phone number"
        },
        "rejectReason": {
          "type": "string",
          "description": "Failure or rejection reason"
        },
        "isHolding": {
          "type": "boolean",
          "description": "Whether the order is being held or processed"
        },
        "incomeId": {
          "type": "integer",
          "description": "Transaction or income record ID"
        },
        "lastActionTime": {
          "type": "string",
          "description": "Last action time"
        },
        "lastTicketingTime": {
          "type": "string",
          "description": "Latest ticketing deadline"
        },
        "isVoidPermitted": {
          "type": "boolean",
          "description": "Whether voiding is permitted"
        },
        "lastVoidTime": {
          "type": "string",
          "description": "Latest voiding deadline"
        },
        "createdAt": {
          "type": "string",
          "description": "Order creation time"
        },
        "updatedAt": {
          "type": "string",
          "description": "Order update time"
        },
        "completedAt": {
          "type": "string",
          "description": "Order completion time"
        },
        "journeys": {
          "type": "array",
          "description": "Order journeys",
          "items": {
            "$ref": "#/definitions/journey"
          }
        },
        "passengers": {
          "type": "array",
          "description": "Order passengers",
          "items": {
            "$ref": "#/definitions/passenger"
          }
        },
        "priceDetail": {
          "$ref": "#/definitions/priceDetail",
          "description": "Order price details"
        },
        "priceExchangeRates": {
          "type": "array",
          "description": "Price exchange rates",
          "items": {
            "$ref": "#/definitions/priceExchangeRate"
          }
        },
        "fareRules": {
          "type": ["object", "null"],
          "description": "Fare rules"
        }
      }
    },
    "journey": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Journey database ID"
        },
        "orderId": {
          "type": "string",
          "description": "Order ID"
        },
        "origin": {
          "type": "string",
          "description": "Journey origin airport code"
        },
        "destination": {
          "type": "string",
          "description": "Journey destination airport code"
        },
        "departureDate": {
          "type": "string",
          "description": "Departure date"
        },
        "departureTime": {
          "type": "string",
          "description": "Departure time"
        },
        "departureTimeZo": {
          "type": "string",
          "description": "Departure timezone information"
        },
        "arrivalDate": {
          "type": "string",
          "description": "Arrival date"
        },
        "arrivalTime": {
          "type": "string",
          "description": "Arrival time"
        },
        "duration": {
          "type": "string",
          "description": "Total journey duration"
        },
        "transferNum": {
          "type": "integer",
          "description": "Number of transfers"
        },
        "segments": {
          "type": "array",
          "description": "Journey segments",
          "items": {
            "$ref": "#/definitions/segment"
          }
        }
      }
    },
    "segment": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Segment database ID"
        },
        "orderId": {
          "type": "string",
          "description": "Order ID"
        },
        "coreSegmentId": {
          "type": "string",
          "description": "Core segment ID"
        },
        "journeyIndex": {
          "type": "integer",
          "description": "Journey index"
        },
        "index": {
          "type": "integer",
          "description": "Segment index"
        },
        "cabinClass": {
          "type": "string",
          "description": "Cabin class"
        },
        "cabinCode": {
          "type": "string",
          "description": "Cabin code"
        },
        "subCabinCode": {
          "type": "string",
          "description": "Sub-cabin code"
        },
        "fareBasisCode": {
          "type": "string",
          "description": "Fare basis code"
        },
        "stayTime": {
          "type": "string",
          "description": "Transfer stay time"
        },
        "pnr": {
          "type": "string",
          "description": "PNR"
        },
        "airlinePnr": {
          "type": "string",
          "description": "Airline PNR"
        },
        "baggageRules": {
          "type": "array",
          "description": "Baggage rules",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "coreSegment": {
          "$ref": "#/definitions/coreSegment",
          "description": "Core segment information"
        }
      }
    },
    "coreSegment": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "type": "string",
          "description": "Core segment ID"
        },
        "airline": {
          "type": "string",
          "description": "Marketing airline"
        },
        "flightNo": {
          "type": "string",
          "description": "Flight number"
        },
        "isCodeShare": {
          "type": "boolean",
          "description": "Whether this is a codeshare flight"
        },
        "opAirline": {
          "type": "string",
          "description": "Operating airline"
        },
        "opFlightNo": {
          "type": "string",
          "description": "Operating flight number"
        },
        "equipment": {
          "type": "string",
          "description": "Aircraft equipment"
        },
        "departure": {
          "type": "string",
          "description": "Departure airport code"
        },
        "departureDate": {
          "type": "string",
          "description": "Departure date"
        },
        "departureTime": {
          "type": "string",
          "description": "Departure time"
        },
        "departureTerminal": {
          "type": "string",
          "description": "Departure terminal"
        },
        "arrival": {
          "type": "string",
          "description": "Arrival airport code"
        },
        "arrivalDate": {
          "type": "string",
          "description": "Arrival date"
        },
        "arrivalTime": {
          "type": "string",
          "description": "Arrival time"
        },
        "arrivalTerminal": {
          "type": "string",
          "description": "Arrival terminal"
        },
        "distance": {
          "type": "number",
          "description": "Segment distance"
        },
        "flightTime": {
          "type": "string",
          "description": "Flight duration"
        },
        "stopovers": {
          "type": "array",
          "description": "Stopover information",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "passenger": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Passenger ID"
        },
        "parentPassengerId": {
          "type": "integer",
          "description": "Parent passenger ID"
        },
        "orderId": {
          "type": "string",
          "description": "Order ID"
        },
        "type": {
          "type": "string",
          "description": "Passenger type",
          "enum": ["adult", "child", "infant"]
        },
        "index": {
          "type": "integer",
          "description": "Passenger index"
        },
        "associatedIndex": {
          "type": "integer",
          "description": "Associated passenger index"
        },
        "surname": {
          "type": "string",
          "description": "Passenger surname"
        },
        "givenNames": {
          "type": "string",
          "description": "Passenger given names"
        },
        "gender": {
          "type": "string",
          "description": "Passenger gender"
        },
        "birthday": {
          "type": "string",
          "description": "Date of birth"
        },
        "nationality": {
          "type": "string",
          "description": "Nationality"
        },
        "travelDocument": {
          "type": "string",
          "description": "Travel document type"
        },
        "travelDocumentExpireDate": {
          "type": "string",
          "description": "Travel document expiry date"
        },
        "travelDocumentNumber": {
          "type": "string",
          "description": "Travel document number"
        },
        "email": {
          "type": "string",
          "description": "Passenger email"
        },
        "region": {
          "type": "string",
          "description": "Phone region code"
        },
        "phone": {
          "type": "string",
          "description": "Passenger phone number"
        },
        "airline": {
          "type": "string",
          "description": "Airline membership information"
        },
        "cardNo": {
          "type": "string",
          "description": "Membership card number"
        },
        "tickets": {
          "type": "array",
          "description": "Passenger tickets",
          "items": {
            "$ref": "#/definitions/ticket"
          }
        }
      }
    },
    "ticket": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Ticket record ID"
        },
        "parentTicketId": {
          "type": "integer",
          "description": "Parent ticket ID"
        },
        "passengerId": {
          "type": "integer",
          "description": "Passenger ID"
        },
        "segmentId": {
          "type": "integer",
          "description": "Segment ID"
        },
        "ticketNo": {
          "type": "string",
          "description": "Ticket number"
        },
        "pnr": {
          "type": "string",
          "description": "PNR"
        },
        "issueDate": {
          "type": "string",
          "description": "Issue date"
        },
        "expireDate": {
          "type": "string",
          "description": "Ticket expiry date"
        },
        "status": {
          "type": "string",
          "description": "Ticket status"
        },
        "remark": {
          "type": "string",
          "description": "Ticket remark"
        },
        "voidOrderId": {
          "type": "string",
          "description": "Void order ID"
        },
        "refundOrderId": {
          "type": "string",
          "description": "Refund order ID"
        },
        "changeOrderId": {
          "type": "string",
          "description": "Change order ID"
        }
      }
    },
    "priceDetail": {
      "type": "object",
      "additionalProperties": true,
      "properties": {
        "productType": {
          "type": "string",
          "description": "Product type"
        },
        "product": {
          "type": "object",
          "description": "Product attributes",
          "additionalProperties": true
        },
        "priceList": {
          "type": "array",
          "description": "Price breakdown. The structure depends on orderType",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "priceTotal": {
          "type": "number",
          "description": "Total order price"
        },
        "transactionFee": {
          "type": "number",
          "description": "Transaction fee"
        },
        "ancillaries": {
          "type": "array",
          "description": "Ancillary services such as baggage or seat selection",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "priceExchangeRate": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Exchange rate type",
          "enum": ["sale", "cost"]
        },
        "currency": {
          "type": "string",
          "description": "Original currency"
        },
        "standardCurrency": {
          "type": "string",
          "description": "Standard currency"
        },
        "exchangeRate": {
          "type": "number",
          "description": "Exchange rate"
        }
      }
    }
  }
}
Previous
Query Flight Account Balance
Next
Schedule Change Callback
Built with