ancillaryOrderDetail - FR24 OpenAPI

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:

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

auxOrderNo

string

FR24 Ancillary order number

required

Match pattern:

^\d*$

partnerAuxOrderNo

string

Ancillary Order number of partner

optional

Example

{
    "authentication" : {
        "sign" : "",
        "timestamp" : ""
    },
    "auxOrderNo" : "",
    "partnerOrderNo" : ""
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://flight-test.flightroutes24.com/api/new/ancillaryOrderDetail.do' \
--header 'Accept-Encoding;' \
--header 'appKey;' \
--header 'content-Type: application/json' \
--data-raw '{
    "authentication" : {
        "sign" : "",
        "timestamp" : ""
    },
    "auxOrderNo" : "",
    "partnerOrderNo" : ""
}'

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 (Ancillary booking response)

All the data returned according to the Request

optional

If code returns failure, data would be empty.

auxOrderNo

string

Ancillary order number is independent of ticket order number

required

independent of ticket order number.

auxOrderStatus

string

Order status

required

partnerAuxOrderNo

string

Ancillary order id of partner

optional

orderNo

string

Related ticket order number

required

createTime

string

Order creating time

optional

currency

string

Currency

required

totalPrice

number

Total price of ancillary order

required

ancillary

object (Ancillary information)

Ancillary information

required

passengers

array [object {2}]

Passengers’ information

required

segments

array [object {16}]

Segments’ information

required

payDeadline

string

Payment deadline

required

YYYY-MM-DDThh:mm. (GMT+8)The order has to be paid before the time, otherwise the order will be canceled.

Example

{
    "traceId": "",
    "code": "",
    "message": "",
    "processingTime": "",
    "data": {
        "auxOrderNo": "",
        "orderStatus": "",
        "partnerOrderNo": "",
        "orderNo": "",
        "createTime": "",
        "currency": "",
        "totalPrice": 810,
        "ancillary": {
            "baggage": [
                {
                    "paxId": 1,
                    "segmentIds": [
                        ""
                    ],
                    "auxId": "",
                    "totalPrice": 810,
                    "baseFare": 800,
                    "serviceFee": 10,
                    "size": " ",
                    "piece": 1,
                    "weight": 23,
                    "quantity": 1
                }
            ]
        },
        "passengers": [
            {
                "paxId": "",
                "name": ""
            }
        ],
        "segments": [
            {
                "segmentId": "1bd336d0305b04f9d59e9a2d1895034c",
                "duration": 1234,
                "carrier": "BA",
                "flightNo": "1234",
                "codeShare": false,
                "operatingtCarrier": "",
                "operatingFlightNo": "",
                "aircraftCode": "",
                "depAirport": "",
                "depTerminal": "",
                "depTime": "",
                "arrAirport": "",
                "arrTerminal": "",
                "arrTime": "",
                "stopAirport": [
                    "",
                    ""
                ],
                "stopDuration": [
                    1256,
                    5678
                ]
            }
        ],
        "payDeadline": ""
    }
}