AncillaryBooking - FlightRoutes24 API(Purchaser)

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

orderNo

string

Order number that need to be added ancillary.

required

The order number should be exist in FR24.

Match pattern:

^\d*$

partnerOrderNo

string

Partner’s Order number

required

ancillary

array[object (The content of ancillary pre-sales) {7}]

Ancillary booking details

required

paxId

string

Passenger ID

required

segmentIds

array[string]

Combination of segment IDs

required

auxId

string

Ancillary ID

required

quantity

number

purchased pieces

required

auxType

integer

required

Types of Ancillary Sales 1. Baggage 2. Seat Selection 3. Meals 4. Check-in

baggage

array [object {4}]

Ancillary baggage information

optional

Mandatory when auxType is 1.

seatInfos

array [object {6}]

Ancillary seat selection information

optional

Mandatory when auxType is 2.

passengers

array [object {2}]

Passenger’s information

required

paxId

string

Passenger id

required

name

string

Passenger name

required

segments

array [object {16}]

Segment information

required

segmentId

string

Segment unique identifier

required

duration

integer

Total duration of the flight segment

required

measuring in Minute.

carrier

string

Selling carrier

required

Airline code by IATA

flightNo

string

Flight number

required

used with carrier.E.g. BA1234, carrier is BA, flightNo is 1234.

codeShare

boolean

Flight sharing identifier

required

true - code-sharing
false - non-code share

operatingCarrier

string

Operating carrier

optional

Airline code by IATA

operatingFlightNo

string

Operating flight number

optional

aircraftCode

string

Aircraft

optional

code by IATA.

depAirport

string

Departure airport

required

code by IATA

depTerminal

string

Departure terminal

optional

Example:

T1

depTime

string <date-time>

Departure time

required

YYYY-MM-DDThh:mmDeparture airport local timeE.g., 2022-10-21T21:23

arrAirport

string

Arrival airport

required

code by IATA

arrTerminal

string

Arrival terminal

optional

Example:

T2

arrTime

string <date-time>

Arrival time

required

YYYY-MM-DDThh:mmArrival airport local time.

stopAirport

array[string]

Stop airport

optional

code by IATA.If there is no stop, it would be empty.

stopDuration

array[integer]

Duration of stop

optional

If there is no stop, it would be empty.

Example

{
  "authentication": {
    "sign": "{{sign}}",
    "timestamp": "{{timestamp}}"
  },
  "orderNo": "17981635587543040",
  "partnerOrderNo": "",
  "ancillary": [
    {
      "paxId": 1,
      "segmentIds": [
        "cdabc75289fb9dcf917526324de0e878"
      ],
      "auxId": "ba956d7f02354134a442294275f232b0",
      "quantity": 1
    }
  ],
  "passengers": [
    {
      "paxId": "1",
      "name": "YGVU/ZTMII"
    }
  ],
  "segments": [
    {
      "segmentId": "cdabc75289fb9dcf917526324de0e878",
      "duration": 1492,
      "carrier": "FD",
      "flightNo": "8750",
      "codeShare": false,
      "operatingCarrier": "FD",
      "operatingFlightNo": "FD8750",
      "aircraftCode": "空客A300",
      "depAirport": "DMK",
      "depTerminal": "T1",
      "depTime": "2024-10-24T03:18",
      "arrAirport": "SIN",
      "arrTerminal": "T2",
      "arrTime": "2024-10-25T05:10",
      "stopAirport": null,
      "stopDuration": null
    }
  ]
}

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/ancillaryBooking.do' \
--header 'Accept-Encoding;' \
--header 'appKey;' \
--header 'content-Type: application/json' \
--data-raw '{
    "authentication": {
        "sign": "",
        "timestamp": ""
    },
    "orderNo": "17981635587543040",
    "partnerOrderNo": "",
    "ancillary": [
        {
            "paxId": 1,
            "segmentIds": [
                "cdabc75289fb9dcf917526324de0e878"
            ],
            "auxId": "ba956d7f02354134a442294275f232b0",
            "quantity": 1
        }
    ],
    "passengers": [
        {
            "paxId": "1",
            "name": "YGVU/ZTMII"
        }
    ],
    "segments": [
        {
            "segmentId": "cdabc75289fb9dcf917526324de0e878",
            "duration": 1492,
            "carrier": "FD",
            "flightNo": "8750",
            "codeShare": false,
            "operatingCarrier": "FD",
            "operatingFlightNo": "FD8750",
            "aircraftCode": "空客A300",
            "depAirport": "DMK",
            "depTerminal": "T1",
            "depTime": "2024-10-24T03:18",
            "arrAirport": "SIN",
            "arrTerminal": "T2",
            "arrTime": "2024-10-25T05:10",
            "stopAirport": null,
            "stopDuration": null
        }
    ]
}'

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

data

object (Ancillary booking response)

All the data returned according to the Request

optional

All the data returned according to the Request.
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": "auxOrder_NEWAPI24093010540068707710",
  "code": "000000",
  "message": "ok",
  "processingTime": 1031,
  "data": {
    "auxOrderNo": "17981648020443136",
    "auxOrderStatus": "1",
    "partnerAuxOrderNo": "",
    "orderNo": "17981635587543040",
    "createTime": null,
    "currency": "USD",
    "totalPrice": 45.64,
    "ancillary": {
      "baggage": [
        {
          "paxId": "1",
          "segmentIds": [
            "cdabc75289fb9dcf917526324de0e878"
          ],
          "auxId": "ba956d7f02354134a442294275f232b0",
          "totalPrice": 45.64,
          "baseFare": 45.64,
          "serviceFee": 0,
          "size": "e",
          "piece": 1,
          "weight": 25,
          "quantity": 1
        }
      ],
      "seatInfos": null
    },
    "passengers": [
      {
        "paxId": "1",
        "name": "YGVU/ZTMII"
      }
    ],
    "segments": [
      {
        "segmentId": "cdabc75289fb9dcf917526324de0e878",
        "duration": 1492,
        "carrier": "FD",
        "flightNo": "8750",
        "codeShare": false,
        "operatingCarrier": "FD",
        "operatingFlightNo": "FD8750",
        "aircraftCode": "空客A300",
        "depAirport": "DMK",
        "depTerminal": "T1",
        "depTime": "2024-10-24T03:18",
        "arrAirport": "SIN",
        "arrTerminal": "T2",
        "arrTime": "2024-10-25T05:10",
        "stopAirport": null,
        "stopDuration": null
      }
    ],
    "payDeadline": null
  }
}