OrderChangeInforming

1 Description

The API is used by FR24 to inform flight change or order change. Compared to calling OrderDetail API periodically, partners could get flight change or order change information more immediately.

Note: It requires partner to provide an URL for FR24 to call OrderChangeInforming API, informing module should be developed by partner.

2 The parameter of Request

OrderChangeInforming request

authentication

object

User authentication

required

sign

string

Signature

required

The encrypted string of appkey, appSecret and timestamp.Refer to Appendix I

timestamp

string

Unix timestamp

required

measuring in Second

traceId

string

Traceablity code

required

type

string

Informing type

required

orderStatusticketNo scheduleChange ancillaryOrderStatusticketNoUpdaterefundchangevoid

orderNo

string

FR24’s order number

required

partnerOrderNo

string

Partner’s order number

required

orderStatus

integer

Order status

required

The parameter is required if informing type is orderStatus.
11, Successfully Booking.
12, Ticketing.
13, Ticketing Completed.
14, Awaiting Confirmation.
15, Booking Canceled.
67, Payment successful.

Reissue/Change
47, Reissue Applied.
48, Pending for Payment.
49, Reissue Processing.
50, Reissue Failed.
51, Reissue Rejected.
52, Refund Pending.
53, Refund Processing.
54, Refund Completed.
61, Reissued.

Refund
72, Quotation Refund.
73, Quotation Completed.
25, Refund Applied.
26, Temporarily Nonrefundable.
27, Refund Processing.
29, Refunding.
30, Refund Completed.

Void
36, Pending.
37, Rejected.
38, Completed.

Ancillary (Baggage or Seat)
101, Order created, payment pending.
102, Payment made, purchase pending.
103, Purchase completed.
104, Order canceled.

tktgAcctInfos

array [object {5}]

Account and password information

optional

used to log in to the airline's official website. This field is optional. (If there is only one account and password, the flight segments and passengers with the same account and password are placed in the same list)

paxIds

array[string]

Passenger ID collection

required

segmentIds

array[string]

Segment ID collection

required

tktgAccount

string

Ticketing account used to log in to the airline's official website

required

encrypted using AES

tktgPassword

string

Ticketing password for logging into the airline's official website

required

encrypted using AES

billingEmail

string

The original ticketing account number used to log in to the airline's official website

optional

encrypted using AES

info

object

Order information

required

including ticket information, original order information, latest order information, segments’ information, passengers’ information and post-sale information.

ticketInfo

array [object {5}]

Ticket information

optional

It is required if the informing type is ticketNo.

originInfo

array [object {2}]

Original segment information

optional

It is required if the informing type is scheduleChange.

newInfo

array [object {3}]

New segment information

optional

It is required if the informing type is scheduleChange.

segments

array[object (Flight information) {16}]

Segments information

optional

It is required if the informing type is ticketNo.

Passengers

array [object {3}]

Passenger’s information

optional

It is required if the informing type is ticketNo.

feeInfo

object

After-sales fee information

optional

It is required if the informing type is Refund/Change/Void.

Ancillary

array[object (Ancillary information) {2}]

Ancillary information

optional

this field is mandatory when type is ancillaryOrderStatus.

Parameter	Type	Required	Description
authentication	object	Yes	User authentication
traceId	string	Yes	Traceablity code
type	string	Yes	Informing type orderStatusticketNo scheduleChange ancillaryOrderStatusticketNoUpdaterefundchangevoid
orderNo	string	Yes	FR24’s order number
partnerOrderNo	string	No	Partner’s order number
orderStatus	int	Yes	The parameter is required if informing type is orderStatus. 11, Successfully Booking. 12, Ticketing. 13, Ticketing Completed. 14, Awaiting Confirmation. 15, Booking Canceled. 67, Payment successful. Reissue/Change 47, Reissue Applied. 48, Pending for Payment. 49, Reissue Processing. 50, Reissue Failed. 51, Reissue Rejected. 52, Refund Pending. 53, Refund Processing. 54, Refund Completed. 61, Reissued. Refund 72, Quotation Refund. 73, Quotation Completed. 25, Refund Applied. 26, Temporarily Nonrefundable. 27, Refund Processing. 29, Refunding. 30, Refund Completed. Void 36, Pending. 37, Rejected. 38, Completed. Ancillary (Baggage or Seat) 101, Order created, payment pending. 102, Payment made, purchase pending. 103, Purchase completed. 104, Order canceled.
tktgAcctInfos	array	No	Account and password information, used to log in to the airline's official website. This field is optional. (If there is only one account and password, the flight segments and passengers with the same account and password are placed in the same list)
info	object	Yes	Order information, including ticket information, original order information, latest order information, segments’ information, passengers’ information and post-sale information.

tktgAcctInfos

Parameter	Type	Required	Description
paxIds	array	Yes	Passenger ID collection
segmentIds	array	Yes	Segment ID collection
tktgAccount	string	Yes	Ticketing account used to log in to the airline's official website, encrypted using AES
tktgPassword	string	Yes	The ticketing password used to log in to the airline's official website is encrypted using AES
billingEmail	string	No	The original ticketing account number used to log in to the airline's official website is encrypted using AES

info

Parameter	Type	Required	Description
ticketInfo	array	No	Ticket information. It is required if the informing type is ticketNo.
originInfo	array	No	Original segment information. It is required if the informing type is scheduleChange.
newInfo	array	No	New segment information. It is required if the informing type is scheduleChange.
segments	array	No	Segments information. It is required if the informing type is ticketNo.
Passengers	array	No	Passenger’s information. It is required if the informing type is ticketNo.
feeInfo	Object	No	After-sales fee information. It is required if the informing type is Refund/Change/Void.
Ancillary	Array	No	Ancillary information, this field is mandatory when type is ancillaryOrderStatus.

ticketInfo

Parameter	Type	Required	Description
paxId	string	Yes	Passenger id
airlinePnr	array	Yes	Airline PNR. Each airline PNR should match the correlated segment. One segment can only correspond to one airline PNR.
gdsPnr	array	No	GDS PNR, only returns when the source is GDS.
ticketNo	array	Yes	Electronic Ticket Number
segmentIds	string	Yes	Segment id

originInfo

Parameter	Type	Required	Description
segmentId	array	Yes	Original segment id which has schedule change.
segments	array	Yes	Details of the segments

newInfo

Parameter	Type	Required	Description
segmentIds	string	Yes	Segment id which has changed to new schedule.
segmentStatus	string	Yes	Schedule change type: CancelChangeRecover
segments	Array	Yes	Details of the segments

segments

Parameter	Type	Required	Description
segmentId	string	Yes	Segment unique identifier
duration	long	Yes	Total duration of the flight segment, measuring in minutes.
carrier	string	Yes	Selling airline code by IATA
flightNo	string	Yes	Flight number, used with carrier BA1234, carrier is BA, flightNo is 1234
codeShare	boolean	Yes	Flight sharing identifier true- code-sharing false- non-code share
operatingCarrier	string	No	Operating airline code by IATA
operatingFlightNo	string	No	Operating flight number
aircraftCode	string	No	Aircraft code by IATA
depAirport	string	Yes	Departure airport code by IATA
depTerminal	string	No	Departure terminal
depTime	string	Yes	Departure time: YYYY-MM-DDThh:mm Departure Airport local time
arrAirport	string	Yes	Arrival airport code by IATA
arrTerminal	string	No	Arrival terminal
arrTime	string	Yes	Arrival time: YYYY-MM-DDThh:mm Arrival airport local time
stopAirport	array	No	Stop airport. Airport code by IATA. If there is no stop, it would be null.
stopDuration	array	No	Duration of stop. If there is no stop, it would be null.

passengers

Parameter	Type	Required	Description
paxId	string	Yes	Passenger’s id
name	string	Yes	Passenger’s name. Last name/First name
birthday	string	Yes	Passenger’s birth date. YYYY-MM-DD

feeInfo

Parameter	Type	Required	Description
currency	string	Yes	currency
totalAmount	decimal	Yes	Actual non-refundable amount. ADTNUMADT(totalFare+totalTax+ serviceFee)+CHDNUM CHD(...)+INFNUM * INF(...)
refundAmount	decimal	No	refundable amount.
refundFee	array	No	Refund amount information. returns when the type is refund.
expiryTime	string	Yes
changeFee	array	No	Reschedule amount information, returns when the type is change.
voidFee	array	No	Void ticket amount information (returned when the type is "void"

refundFee

Parameter	Type	Required	Description
paxType	string	Yes	ADT- Adult CHD- Child INF- Infant
totalFare	decimal	Yes	Total deduction amount. Equals to No-show fee + reissue fee
deductFee	array	No	Breakdown of Deduction Amount
totalTax	decimal	Yes	Total Taxes and Fees
taxBreakdown	array	No	Tax Breakdown
serviceFee	decimal	Yes	Service Fee

deductFee

Parameter	Type	Required	Description
fareType	string	Yes	Type of deduction noshow- No-show Penalty changeFee- reissue fee
fareAmount	decimal	Yes	deduction fee

taxBreakdown

Parameter	Type	Required	Description
taxType	string	Yes	Type of tax and fee Administration fee, foreign government tax, non-refundable tax
taxAmount	decimal	Yes	Taxes and Fees amount

changeFee

Parameter	Type	Required	Description
paxType	string	Yes	ADT- Adult CHD- Child INF- Infant
totalFare	decimal	Yes	Total amount paid. Equals to base fare+ No-Show fee + Reissue fee
changeFare	array	Yes	Payment Amount Breakdown
totalTax	decimal	Yes	Total Taxes and Fees
taxBreakdown	array	Yes	Tax Breakdown
serviceFee	decimal	Yes	Service Fee

changeFare

Parameter	Type	Required	Description
fareType	string	Yes	Type of deduction baseFareDiff – The difference in the face value noshow- No-show Penalty changeFee- reissue fee
fareAmount	decimal	Yes	deduction fee

taxBreakdown

Parameter	Type	Required	Description
taxType	string	Yes	Type of tax and fee Administrative fee/other government tax/non-refundable tax
taxAmount	decimal	Yes	Taxes and Fees

ancillary

Parameter	Type	Required	Description
baggage	array	Yes	ancillary baggage information
seatinfo	array	Yes	ancillary seat information

baggage

Parameter	Type	Required	Description
paxId	int	Yes	Passenger id
segmentId	array	Yes	Segment combination
auxId	string	Yes	Ancillary id
baseFare	decimal	Yes	Base fare
serviceFee	decimal	Yes	Service fee
size	string	No	Size, measuring in CM
weight	int	Yes	Weight, measuring in KG
piece	int	No	Ancillary pieces in this offer, measuring in PC.
quantity	int	Yes	Purchase quantity

seatInfos

Parameter	Type	Required	Description
paxId	int	Yes	Passenger ID
segmentId	Int	Yes	Combination of segment ID
rowNo	string	Yes	List of seat numbers
colNo	string	Yes	Selected seat number, e.g., 10E. If selecting a seat, this field is mandatory.
selectedSeatNo	string	Yes	Selected seat number, e.g., 10E. If selecting a seat, this field is mandatory.
seatprice	decimal	Yes	Seat price. If selecting a seat, this field is mandatory
serviceFee	decimal	Yes	Seat selection handling price. If selecting a seat, this field is mandatory

3 The parameter of Response

OrderChangeInforming response

authentication

object

User authentication

required

sign

string

Signature

required

The encrypted string of appkey, appSecret and timestamp.Refer to Appendix I

timestamp

string

Unix timestamp

required

measuring in Second

traceId

string

Traceability code

required

traceId can help locate problems when problems occur between partners and FR24.

code

string

Status code

required

000000 means success, others mean failure.

message

string

Error code message

required

processingTime

number

Processing time

required

measuring in ms

>= 0

Parameter	Type	Required	Description
authentication	object	Yes	User authentication
traceId	string	Yes	Traceablity code
code	string	Yes	Error code. 000000 means success, 222222 means this type is not supported.
message	string	Yes	error code message
processingTime	long	Yes	Processing time, measuring in ms.

4 RQ

4.1 ticketNo/ticketNoUpdate

{

    "authentication" : {

        "sign" : "",

        "timeStamp" : ""

    },

    "traceId" : "",

    "type" : "ticketNo/ticketNoUpdate",

    "orderNo" : "",

    "partnerOrderNo" : "",

    "tktgAcctInfos" : [
        {
            "paxIds": [  "1","2","3"],
            "segmentIds": [ "1bd336d0305b04f9d59e9a2d1895034c^fa065c2163cad50864545390110db6dc"],
            "tktgAccount": "gPfsfRe4nblhspmnjIqPqfFYhLbQ9ZcwJB2I+WeEqI9=",
            "tktgPassword": "d+jAvoQDto/DRk2rzVCO/g=="
        },
        {
            "paxIds": [  "1","2","3"],
            "segmentIds": [ "fd9a04f5f1615f03b1131bd617a5091c"],
            "tktgAccount": "sakdjhshdasadsadssadsakjhdksjhja5485sads-=sds",
            "tktgPassword": "hsabdw98sd2n+----=xsdssf"
        }
    ],

    "info" : {

        "ticketInfo" : [

            {

                "paxId" : "1",

                "airlinePnr" : ["ASDDSA","ASDDSA"],

                "gdsPnr" : ["WWEWEW", "UIUIYD"],

                "ticketNo" : ["GTREDS","ASWSAS^ASWSAS^SSWSWS^EWEWER"],

                "segmentIds" : ["1ajshbbgxisnwwqw","2poppojkjnbjasdj^3uiutgbchdbwjuiu"]

            },

            {

                "paxId" : "2",

                "airlinePnr" : ["ASDSDS","AJHKGH"],    

                "gdsPnr" : ["RERERE","RERERE"],

                "ticketNo" : ["ASWERT","QUIOPO"],

                "segmentIds" : ["1ajshbbgxisnwwqw","2poppojkjnbjasdj^3uiutgbchdbwjuiu"]

            }

        ],

        "segments" : [

            {

                "segmentId": "1ajshbbgxisnwwqw",

                "duration": 182,

                "carrier": "LH",

                "flightNo": "7965",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "SHA",

                "depTerminal": null,

                "depTime": "2023-04-20T17:10",

                "arrAirport": "HKG",

                "arrTerminal": null,

                "arrTime": "2023-04-20T20:12",

                "stopAirport": null,

                "stopDuration": null

            },

            {

                "segmentId": "2poppojkjnbjasdj",

                "duration": 243,

                "carrier": "ZH",

                "flightNo": "4668",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "PVG",

                "depTerminal": null,

                "depTime": "2023-04-20T10:10",

                "arrAirport": "HKG",

                "arrTerminal": null,

                "arrTime": "2023-04-20T14:13",

                "stopAirport": null,

                "stopDuration": null

            },

            {

                "segmentId": "3uiutgbchdbwjuiu",

                "duration": 288,

                "carrier": "ZH",

                "flightNo": "4668",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "PVG",

                "depTerminal": null,

                "depTime": "2023-04-20T10:10",

                "arrAirport": "HKG",

                "arrTerminal": null,

                "arrTime": "2023-04-20T14:13",

                "stopAirport": null,

                "stopDuration": null

            }

        ],

        "passengers" : [

            {

                "paxId" : "1",

                "name" : "ZHANG/SAN",

                "birthday" : "1989-11-12"

            },

            {

                "paxId" : "2",

                "name" : "LI/SI",

                "birthday" : "1994-05-06"

            }

        ]

    }

}

4.2 scheduleChange

{

    "authentication" : {

        "sign" : "",

        "timeStamp" : ""

    },

    "traceId" : "",

    "type" : "scheduleChange",

    "orderNo" : "",

    "partnerOrderNo" : "",

    "info" : {

        "originInfo" : [

           {

                "segmentId" : "1ujhujhuijhuiknb",

                "duration": 140,

                "carrier": "LH",

                "flightNo": "2046",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "SHA",

                "depTerminal": null,

                "depTime": "2023-04-25T06:35",

                "arrAirport": "HKG",

                "arrTerminal": null,

                "arrTime": "2023-04-25T08:55",

                "stopAirport": null,

                "stopDuration": null

            },

            {

                "segmentId" : "2poiujhjklmnjk8o",

                "duration": 247,

                "carrier": "LH",

                "flightNo": "8725",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "HKG",

                "depTerminal": null,

                 "depTime": "2023-04-28T05:50",

                "arrAirport": "SHA",

                "arrTerminal": null,

                "arrTime": "2023-04-28T09:57",

                "stopAirport": null,

                "stopDuration": null

            },

            {

                "segmentId" : "3yuiokjhnmlppupo",

                "duration": 192,

                "carrier": "ZH",

                "flightNo": "9050",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "HKG",

                "depTerminal": null,

                "depTime": "2023-04-26T07:35",

                "arrAirport": "SIN",

                "arrTerminal": null,

                "arrTime": "2023-04-26T10:47",

                "stopAirport": null,

                "stopDuration": null

            },

            {

                "segmentId" : "4uiyhjuiknbgtfgy",

                "duration": 249,

                "carrier": "LH",

                "flightNo": "7504",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "XSP",

                "depTerminal": null,

                "depTime": "2023-04-27T00:20",

                "arrAirport": "HKG",

                "arrTerminal": null,

                "arrTime": "2023-04-27T04:29",

                "stopAirport": null,

                "stopDuration": null

            },

            {

                "segmentId" : "5bfghsbhjungbgdd",

                "duration": 154,

                "carrier": "LH",

                "flightNo": "756",

                "codeShare": false,

                "operatingCarrier": null,

                "operatingFlightNo": null,

                "aircraftCode": "333",

                "depAirport": "HKG",

                "depTerminal": null,

                "depTime": "2023-04-28T08:40",

                "arrAirport": "SIN",

                "arrTerminal": null,

                "arrTime": "2023-04-28T11:14",

                "stopAirport": null,

                "stopDuration": null

            }

        ],

        "newInfo" : [

            {

                "segmentIds" : "1ujhujhuijhuiknb",

                "segmentStatus" : "change",

                "segments" : [

                    {

                        "segmentId" : "5ujhujhuijhuiknb",

                        "duration": 140,

                        "carrier": "LH",

                        "flightNo": "2048",

                        "codeShare": false,

                        "operatingCarrier": null,

                        "operatingFlightNo": null,

                        "aircraftCode": "333",

                        "depAirport": "SHA",

                        "depTerminal": null,

                        "depTime": "2023-04-25T07:35",

                        "arrAirport": "WHU",

                        "arrTerminal": null,

                        "arrTime": "2023-04-25T09:55",

                        "stopAirport": null,

                        "stopDuration": null

                    },

                    {

                        "segmentId" : "6poiujhjklmnjk8o",

                        "duration": 127,

                        "carrier": "LH",

                        "flightNo": "8725",

                        "codeShare": false,

                        "operatingCarrier": null,

                        "operatingFlightNo": null,

                        "aircraftCode": "333",

                        "depAirport": "WHU",

                        "depTerminal": null,

                         "depTime": "2023-04-25T10:50",

                        "arrAirport": "HKG",

                        "arrTerminal": null,

                        "arrTime": "2023-04-25T12:57",

                        "stopAirport": null,

                        "stopDuration": null

                    }

                ]        

            },

            {

                "segmentIds" : "2poiujhjklmnjk8o^3yuiokjhnmlppupo",

                "segmentStatus" : "change",

                "segments" : [

                    {

                        "segmentId" : "7hghdch7hfj4hovf",

                        "duration": 247,

                        "carrier": "LH",

                        "flightNo": "8725",

                        "codeShare": false,

                        "operatingCarrier": null,

                        "operatingFlightNo": null,

                        "aircraftCode": "333",

                        "depAirport": "HKG",

                        "depTerminal": null,

                         "depTime": "2023-04-28T06:50",

                        "arrAirport": "SHA",

                        "arrTerminal": null,

                        "arrTime": "2023-04-28T10:57",

                        "stopAirport": null,

                        "stopDuration": null

                    }

                ]        

            },

            {

                "segmentIds" : "4thgjlkjhyupoikj",

                "changeType" : "cancel",

                "segments" : [

                    {

                        "segmentId" : "4thgjlkjhyupoikj",

                        "duration": 249,

                        "carrier": "LH",

                        "flightNo": "7504",

                        "codeShare": false,

                        "operatingCarrier": null,

                        "operatingFlightNo": null,

                        "aircraftCode": "333",

                        "depAirport": "XSP",

                        "depTerminal": null,

                        "depTime": "2023-04-27T00:20",

                        "arrAirport": "HKG",

                        "arrTerminal": null,

                        "arrTime": "2023-04-27T04:29",

                        "stopAirport": null,

                        "stopDuration": null

                    }

                ]

            },

            {

                "segmentIds" : "5bfghsbhjungbgdd",

                "segmentStatus" : "recover",

                "segments" : [

                    {

                        "segmentId" : "5bfghsbhjungbgdd",

                        "duration": 154,

                        "carrier": "LH",

                        "flightNo": "756",

                        "codeShare": false,

                        "operatingCarrier": null,

                        "operatingFlightNo": null,

                        "aircraftCode": "333",

                        "depAirport": "HKG",

                        "depTerminal": null,

                        "depTime": "2023-04-28T08:40",

                        "arrAirport": "SIN",

                        "arrTerminal": null,

                        "arrTime": "2023-04-28T11:14",

                        "stopAirport": null,

                        "stopDuration": null

                    }

                ]

            }

        ]

    }

}

4.3 orderStatus

{

"authentication" : {
        "sign" : "",

        "timestamp" : ""

 },

    "traceId" : "",

    "type" : "orderStatus",

    "orderNo" : "",

    "partnerOrderNo" : "",

    "orderStatus" : 12

}

4.4 Quotation Completed

{

    "authentication" : {

        "sign" : "",

        "timeStamp" : ""

    },

    "traceId" : "",

    "type" : "change/refund/void",

    "orderNo" : "",

    "partnerOrderNo" : "",

    "orderStatus" : "",

    "info" : {

        "feeInfo" : {

            "currency" : "",

            "totalAmount" : "ADTNUM*ADT(totalFare + totalTax + serviceFee)+CHDNUM* CHD(...)+INFNUM * INF(...)",

            "refundAmount" : 111.20,

            "changeFee" : [

                {

                    "paxType" : "",

                    "totalFare" : "Fare difference + no-show fee + rescheduling fee",

                    "deductFare" : [

                        {

                            "faretype" : "Fare difference/no-show fee/rescheduling fee",

                            "fareAmount" : 12.30

                        }

                    ],

                    "totalTax" : 12.00,

                    "taxBreakdown" : [

                        {

                            "taxType" : "",

                            "taxAmount" : 12.00

                        }

                    ],

                    "serviceFee" : 10.00

                }

            ]

        } 

    }

}

5 RS

{
    "authentication" : {
        "sign" : "",
        "timestamp" : ""
    },
    "traceId" : "",
    "code": "000000",
    "message" : "success",
    "processingTime" : 160
}

1 Description#

2 The parameter of Request#

3 The parameter of Response#

4 RQ#

4.1 ticketNo/ticketNoUpdate#

4.2 scheduleChange#

4.3 orderStatus#

4.4 Quotation Completed#

5 RS#

1 Description

2 The parameter of Request

3 The parameter of Response

4 RQ

4.1 ticketNo/ticketNoUpdate

4.2 scheduleChange

4.3 orderStatus

4.4 Quotation Completed

5 RS