FR24 OpenAPI
  1. API Reference
FR24 OpenAPI
  • FR24_API_V2.0
    • Guides
      • API Work Flow
      • Introduction
      • Appendix
      • Error Code
    • API Reference
      • OrderChangeInforming
      • shopping
        POST
      • pricing
        POST
      • booking
        POST
      • ticketing
        POST
      • orderDetail
        POST
      • presaleAncillaryShopping
        POST
      • postsaleAncillaryShopping
        POST
      • seatMap
        POST
      • ancillaryBooking
        POST
      • ancillaryPurchase
        POST
      • ancillaryOrderDetail
        POST
      • changeReshop
        POST
      • reissueRequest
        POST
      • refundRequest
        POST
      • refundConfirming
        POST
      • voidRequest
        POST
      • fileUpload
        POST
      • selectBalance
        POST
    • About us
      • API capability
      • Business Cooperation
      • Portal
  1. API Reference

shopping

POST
/api/new/shopping.do
Searching available flight information through the Shopping API, supports one-way, round trip, notch route.

Request

Header Params
Accept-Encoding
string 
required
Use gzip compression format
Default:
gzip, deflate, br
content-Type
string 
required
Response format
Default:
application/json
appKey
string 
required
User account
Default:
{{appKey}}
Body Params application/json
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
searchLegs
array[object (Searching for segment information) {5}] 
Searching for segment information
required
which maximum is 6-segments
>= 1 items<= 6 items
origin
string 
Departure city
required
code by IATA
>= 3 characters<= 3 characters
typeO
enum<string> 
The origin type restrictions
optional
Allowed values:
airportcodeairportgroup
destination
string 
Arrival city
required
code by IATA
>= 3 characters<= 3 characters
typeD
enum<string> 
The destination type restrictions
optional
Allowed values:
airportcodeairportgroup
depDate
string <date>
Departure date
required
格式：YYYY-MM-DD
>= 10 characters<= 10 characters
Match pattern:
^\d{4}-\d{2}-\d{2}$
adultNum
integer 
The total number of adult passengers
required
The sum of adults, children and infants cannot be greater than 9.
>= 1<= 9
Default:
0
childNum
integer 
The total number of children passenger
optional
One adult can only take two children or infants in total.
>= 0<= 9
Default:
0
infantNum
integer 
The total number of infant passengers
optional
One adult can only take two children or infants in total.
>= 0<= 9
Default:
0
preferences
object 
Search preference
required
You can set up preferences to get filtered results.
preferredCarrier
array[string]
Airline preference filter entry, required airline IATA 2-character code
optional
Supports multi-carrier filtering
prohibitedCarrier
array[string]
Airline preference filter entry, not required Airline IATA 2-character code
optional
Supports multi-carrier filtering
stops
integer 
Maximum number of transfers for a single leg
optional
0- direct flights only, 1- up to 1 transfer, 2- up to 2 transfers, and so on
>= 0
cabin
enum<string> 
Cabin preference
optional
If you choose not to set up, your acquiescence is Economy.
>= 0 characters<= 1 characters
Allowed values:
FCPY
Default:
Y
seriesTraceId
string 
The traceId returned by the last service request interface
optional
This field is a developer option. FR24 uses this traceId to track and analyze the last call interface of the partner, so that both parties can quickly track the entire link when problems occur.
seriesRsTime
number 
The last service request interface, the time from requesting the interface to obtaining the result, in ms
optional
This field is a developer option. FR24 uses this time to analyze the partner's network delay to improve the data quality of both parties.
Example
{
    "authentication": {
        "sign": "{{sign}}",
        "timestamp": "{{timestamp}}"
    },
    "searchLegs": [
        {
            "typeO": "airportgroup",
            "origin": "SIN",
            "typeD": "airportcode",
            "destination": "HKG",
            "depDate": "2025-11-15"
        }
    ],
    "adultNum": 2,
    "childNum": 0,
    "infantNum": 0,
    "preferences": {
        "cabin": "Y",
        "preferredCarrier": [
            "AB"
        ],
        "prohibitedCarrier": [
            "CD"
        ],
        "stops": 0
    }
}

Request 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 --request POST 'https://flight-test.flightroutes24.com/api/new/shopping.do' \
--header 'Accept-Encoding;' \
--header 'appKey;' \
--header 'content-Type: application/json' \
--data-raw '{
    "authentication": {
        "sign": "",
        "timestamp": ""
    },
    "searchLegs": [
        {
            "typeO": "airportgroup",
            "origin": "SIN",
            "typeD": "airportcode",
            "destination": "HKG",
            "depDate": "2025-11-15"
        }
    ],
    "adultNum": 2,
    "childNum": 0,
    "infantNum": 0,
    "preferences": {
        "cabin": "Y",
        "preferredCarrier": [
            "AB"
        ],
        "prohibitedCarrier": [
            "CD"
        ],
        "stops": 0
    }
}'

Responses

🟢200OK
application/json
Body
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
data
object 
All the data returned according to the Request
required
All the data returned according to the Request.
If code returns failure, data would be empty.
offers
array [object {16}] 
Price information
required
returns combination of direct flight and transit.
legs
array[object (Itinerary information) {2}] 
Itinerary information
required
returns all flight combinations
segments
array [object {16}] 
Flight information
required
returns all non-duplicated segments.
Example
{
    "traceId": "queryFlight_NEWAPI230911165800484095",
    "code": "000000",
    "message": "success",
    "processingTime": 676,
    "data": {
        "offers": [
            {
                "offerId": "15803089789194240",
                "legId": "55623c5bf92ccd6d3cf30b543c0bd5ad",
                "currency": "CNY",
                "platingCarrier": "IJ",
                "pricePerPax": [
                    {
                        "paxType": "ADT",
                        "baseFare": 2356,
                        "totalTax": 2050,
                        "taxBreakdown": [],
                        "serviceFee": null
                    }
                ],
                "cabin": [
                    "Y"
                ],
                "fareBasis": [
                    null
                ],
                "availability": [
                    "9"
                ],
                "extraInfo": {
                    "freeBaggageAllowance": [
                        {
                            "segmentId": "d50b31d910612e8edb45b9466649a3a3",
                            "cabinBagPc": "e-e-e",
                            "cabinBagSize": "e-e-e",
                            "cabinBagWeight": "e-e-e",
                            "checkedBagPc": "e-e-e",
                            "checkedBagSize": "e-e-e",
                            "checkedBagWeight": "20-e-e"
                        }
                    ]
                },
                "eligibilityFlag": false,
                "eligibilityDetail": null,
                "rules": {
                    "refund": [
                        {
                            "paxType": "ADT",
                            "couponStatus": 0,
                            "refundPolicy": "airlinePolicyApplied",
                            "applicableTime": null,
                            "fullRefundAP": null,
                            "refundFee": null
                        }
                    ],
                    "change": [
                        {
                            "paxType": "ADT",
                            "couponStatus": 0,
                            "changePolicy": "airlinePolicyApplied",
                            "applicableTime": null,
                            "changeFee": null
                        }
                    ]
                },
                "productType": "AAA",
                "productTag": {
                    "ticketPromise": 0,
                    "refuseDeadline": 0,
                    "ticketingTime": 60,
                    "reschedulePendingTime": 240,
                    "voluntaryRefundTime": 21600,
                    "involuntaryRefundTime": 21600,
                    "refundCondition": 0,
                    "reissueCondition": 0,
                    "voidingCondition": false,
                    "voluntaryServiceStandard": 2,
                    "involuntaryServiceStandard": 1,
                    "RBDChangedRisk": false,
                    "fareBrand": [
                        "basic economy^full flex",
                        "basic economy",
                        ""
                    ],
                    "posArea": [
                        "US",
                        "CN"
                    ]
                },
                "productSource": "OTH",
                "RBD": [
                    "K"
                ]
            },
            {
                "offerId": "15803089789194241",
                "legId": "6569cc7f11c26f09901f5af0063aff8c",
                "currency": "CNY",
                "platingCarrier": "IJ",
                "pricePerPax": [
                    {
                        "paxType": "ADT",
                        "baseFare": 2573,
                        "totalTax": 2239,
                        "taxBreakdown": [],
                        "serviceFee": null
                    }
                ],
                "cabin": [
                    "Y"
                ],
                "fareBasis": [
                    null
                ],
                "availability": [
                    "9"
                ],
                "extraInfo": {
                    "freeBaggageAllowance": [
                        {
                            "segmentId": "3dfc73915f991967df377cc232a4eeef",
                            "cabinBagPc": "e-e-e",
                            "cabinBagSize": "e-e-e",
                            "cabinBagWeight": "e-e-e",
                            "checkedBagPc": "e-e-e",
                            "checkedBagSize": "e-e-e",
                            "checkedBagWeight": "20-e-e"
                        }
                    ]
                },
                "eligibilityFlag": false,
                "eligibilityDetail": null,
                "rules": {
                    "refund": [
                        {
                            "paxType": "ADT",
                            "couponStatus": 0,
                            "refundPolicy": "airlinePolicyApplied",
                            "applicableTime": null,
                            "fullRefundAP": null,
                            "refundFee": null
                        }
                    ],
                    "change": [
                        {
                            "paxType": "ADT",
                            "couponStatus": 0,
                            "changePolicy": "airlinePolicyApplied",
                            "applicableTime": null,
                            "changeFee": null
                        }
                    ]
                },
                "productType": "AAA",
                "productTag": {
                    "ticketPromise": 0,
                    "refuseDeadline": 0,
                    "ticketingTime": 60,
                    "reschedulePendingTime": 240,
                    "voluntaryRefundTime": 21600,
                    "involuntaryRefundTime": 21600,
                    "refundCondition": 0,
                    "reissueCondition": 0,
                    "voidingCondition": false,
                    "voluntaryServiceStandard": 2,
                    "involuntaryServiceStandard": 1,
                    "RBDChangedRisk": false,
                    "fareBrand": [
                        "basic economy^full flex",
                        "basic economy",
                        ""
                    ],
                    "posArea": [
                        "US",
                        "CN"
                    ]
                },
                "productSource": "OTH",
                "RBD": [
                    "S"
                ]
            },
            {
                "offerId": "15803089789194242",
                "legId": "e3504f0918ff9594ec8537663b02f925",
                "currency": "CNY",
                "platingCarrier": "IJ",
                "pricePerPax": [
                    {
                        "paxType": "ADT",
                        "baseFare": 3327,
                        "totalTax": 2896,
                        "taxBreakdown": [],
                        "serviceFee": null
                    }
                ],
                "cabin": [
                    "Y"
                ],
                "fareBasis": [
                    null
                ],
                "availability": [
                    "9"
                ],
                "extraInfo": {
                    "freeBaggageAllowance": [
                        {
                            "segmentId": "b628821e9ac613fb74d9fc49d8391883",
                            "cabinBagPc": "e-e-e",
                            "cabinBagSize": "e-e-e",
                            "cabinBagWeight": "e-e-e",
                            "checkedBagPc": "e-e-e",
                            "checkedBagSize": "e-e-e",
                            "checkedBagWeight": "20-e-e"
                        }
                    ]
                },
                "eligibilityFlag": false,
                "eligibilityDetail": null,
                "rules": {
                    "refund": [
                        {
                            "paxType": "ADT",
                            "couponStatus": 0,
                            "refundPolicy": "airlinePolicyApplied",
                            "applicableTime": null,
                            "fullRefundAP": null,
                            "refundFee": null
                        }
                    ],
                    "change": [
                        {
                            "paxType": "ADT",
                            "couponStatus": 0,
                            "changePolicy": "airlinePolicyApplied",
                            "applicableTime": null,
                            "changeFee": null
                        }
                    ]
                },
                "productType": "AAA",
                "productTag": {
                    "ticketPromise": 0,
                    "refuseDeadline": 0,
                    "ticketingTime": 60,
                    "reschedulePendingTime": 240,
                    "voluntaryRefundTime": 21600,
                    "involuntaryRefundTime": 21600,
                    "refundCondition": 0,
                    "reissueCondition": 0,
                    "voidingCondition": false,
                    "voluntaryServiceStandard": 2,
                    "involuntaryServiceStandard": 1,
                    "RBDChangedRisk": false,
                    "fareBrand": [
                        "basic economy^full flex",
                        "basic economy",
                        ""
                    ],
                    "posArea": [
                        "US",
                        "CN"
                    ]
                },
                "productSource": "OTH",
                "RBD": [
                    "U"
                ]
            }
        ],
        "legs": [
            {
                "legId": "55623c5bf92ccd6d3cf30b543c0bd5ad",
                "segmentIds": [
                    "d50b31d910612e8edb45b9466649a3a3"
                ]
            },
            {
                "legId": "6569cc7f11c26f09901f5af0063aff8c",
                "segmentIds": [
                    "3dfc73915f991967df377cc232a4eeef"
                ]
            },
            {
                "legId": "e3504f0918ff9594ec8537663b02f925",
                "segmentIds": [
                    "b628821e9ac613fb74d9fc49d8391883"
                ]
            }
        ],
        "segments": [
            {
                "segmentId": "d50b31d910612e8edb45b9466649a3a3",
                "duration": 142,
                "carrier": "IJ",
                "flightNo": "5817",
                "codeShare": false,
                "operatingCarrier": null,
                "operatingFlightNo": null,
                "aircraftCode": "333",
                "depAirport": "SIN",
                "depTerminal": null,
                "depTime": "2025-11-15T00:25",
                "arrAirport": "HKG",
                "arrTerminal": null,
                "arrTime": "2025-11-15T02:47",
                "stopAirport": null,
                "stopDuration": null
            },
            {
                "segmentId": "3dfc73915f991967df377cc232a4eeef",
                "duration": 197,
                "carrier": "IJ",
                "flightNo": "1811",
                "codeShare": false,
                "operatingCarrier": null,
                "operatingFlightNo": null,
                "aircraftCode": "333",
                "depAirport": "SIN",
                "depTerminal": null,
                "depTime": "2025-11-15T12:05",
                "arrAirport": "HKG",
                "arrTerminal": null,
                "arrTime": "2025-11-15T15:22",
                "stopAirport": null,
                "stopDuration": null
            },
            {
                "segmentId": "b628821e9ac613fb74d9fc49d8391883",
                "duration": 147,
                "carrier": "IJ",
                "flightNo": "8199",
                "codeShare": false,
                "operatingCarrier": null,
                "operatingFlightNo": null,
                "aircraftCode": "333",
                "depAirport": "QPG",
                "depTerminal": null,
                "depTime": "2025-11-15T12:40",
                "arrAirport": "HKG",
                "arrTerminal": null,
                "arrTime": "2025-11-15T15:07",
                "stopAirport": null,
                "stopDuration": null
            }
        ]
    }
}
Modified at 2025-06-12 09:39:26
Previous
OrderChangeInforming
Next
pricing
Built with