Change | SubmitChange

Submit for rescheduling.
The “changeType”, the “changeReason” and the “updatedSegments” should be same in one changing process. Multiple submission operations are necessary if different cusomters have different changing needs.

Notice:
Product Scope ：FareMarket

POST

/flight/change

Parameter

Field Mandatory Type Scope Description
action required String SubmitChange
key required String API security key applied from AeroHub.
signature required String Refer to the Guidelines for generation.
timestamp required Int The ‘timestamp’ field should be a 10-digit Unix timestamp in seconds, used for encryption and data verification.
version optional String API version information, e.g. “3.2.0”.
request required Object
  orderNum required String Original order number for rescheduling, generated by Booking API “Commit”.
  changeType required String Type of rescheduling:
VOLUNTARY: voluntary change
INVOLUNTARY: involuntary change
INFORMATION_UPDATER: information update
OTHER: other reasons
Refer to appendix ‘Change Type List’ for details
  changeReason optional String Resason for rescheduling:
FLIGHT_CHANGE: flight change
FLIGHT_CANCEL: flight cancel
OTHER: other reasons
The field is required when the “changeType” is “INVOLUNTARY”
Refer to appendix ‘Change Reason List’ for details
  passengers required Object[] Passenger information for rescheduling.
    originalPassengers required Object Original Passenger information.
      firstName required String Passenger first name. If there is a middle name, connect it with a space like “firstname middlename”.
      lastName required String Passenger last name.
      ageType required Int Passenger type:
0: adult
1: child
2: infant
      birthday required String Birthday, formatted with “YYYYMMDD”.
    updatedPassengers optional Object Updated passenger information.
The field is required when the “changeType” is “INFORMATION_UPDATER”.
      firstName required String Passenger first name. If there is a middle name, connect it with a space like “firstname middlename”.
      lastName required String Passerger last name.
      ageType required Int Passenger type:
0: adult
1: child
2: infant
      birthday required String Passenger birthday, formatted with”YYYYMMDD”.
      gender required String Passenger gender:
M: male
F: female
      nationality optional String Passenger nationality, 2-letter country code.
      cardNum optional String Passenger identity number, maximum 15 characters.
      cardExpired optional String The expiration date of the identity card, formatted with “YYYYMMDD”.
  segments required Object[] Itinerary information for rescheduling.
    originalSegments required Object[] Original itinerary information.
      flightNumber required String Flight number, e.g. CA123.
      depAirport required String Departure airport, IATA 3-letter code.
      arrAirport required String Arrival airport, IATA 3-letter code.
    updatedSegments required Object[] Updated itinerary information.
      flightNumber required String Flight number, e.g. CA123.
      depAirport required String Departure airport, IATA 3-letter code.
      arrAirport required String Arrival airport, IATA 3-letter code.
      departureDate required String Departure date, formatted with “YYYYMMDD”.
      depTime optional String Departure date and time, formatted with “YYYYMMDDHHMM”.(e.g. 201203100315 represents 2012/03/10 03:15)
      arrTime optional String Arrival date and time, formatted with “YYYYMMDDHHMM”.(e.g. 201203101305 represents 2012/03/10 13:05)
  notificationEmail optional String Email address for receiving updates and status for rescheduling, one time valid. if none be specified, the mailbox in the configuration file will be used.
  customerRemark optional String Customer remarks.
  attachments optional Object[] Attachment. The field is required when the “changeType” is “INFORMATION_UPDATER”. The supported file types are as follows, JPG, JPEG, PNG, PDF. Maximum single upload file size: 10M.
    name required String File name with extension.
    content required String File content text, converted by the original file with base64 encoding.

Request_Example:

{
    "action": "SubmitChange",
    "key": "n93mPT7WzN6cLKC2",
    "signature": "YhQ2EoBQOfOnf/EOnuuuK5i+K+ncydeQhjFpoXYiEMo=",
    "timestamp": 1685116516,
    "version": "3.2.0",
    "request": {
        "orderNum": "1234567890",
        "changeType": "INFORMATION_UPDATER",
        "changeReason": null,
        "passengers": [
            {
                "originalPassengers": {
                    "firstName": "John",
                    "lastName": "Doe",
                    "ageType": 0,
                    "birthday": "19900101"
                },
                "updatedPassengers": {
                    "firstName": "John",
                    "lastName": "Doe",
                    "ageType": 0,
                    "birthday": "19900101",
                    "gender": "M",
                    "nationality": "US",
                    "cardNum": "1234567890",
                    "cardExpired": "20300101"
                }
            }
        ],
        "segments": [
            {
                "originalSegments": [
                    {
                        "flightNumber": "CA123",
                        "depAirport": "PEK",
                        "arrAirport": "SHA"
                    }
                ],
                "updatedSegments": [
                    {
                        "flightNumber": "CA456",
                        "depAirport": "PEK",
                        "arrAirport": "SHA",
                        "departureDate": "20240901",
                        "depTime": "202409010900",
                        "arrTime": "202409011100"
                    }
                ]
            }
        ],
        "notificationEmail": "example@example.com",
        "customerRemark": "Please process this rescheduling as soon as possible.",
        "attachments": [
            {
                "name": "example.jpg",
                "content": "your_base64_encoded_content"
            }
        ]
    }
}

Response

Field Type Description
status Int 0: Succeeded
Others: Failed
Refer to “Status Code” below for details.
msg String Return message, maximum 64 characters.
changeNum String Rescheduling order number.

Success-Response:

{
  "status": 0,
  "msg": "Success",
  "changeNum": "C20241018101144760"
}

Status Code

Name Description
7700 Order does not exist
7701 Passenger does not exist
7702 The rescheduling for {firstName/lastName} is already in progress.
7703 Failed to create a change

Error-Response

{
    "status": 1000,
    "msg": "General system error"
}
Author：SunKang  Create time：2024-11-18 17:26
Last editor：AeroHub  Update time：2025-04-22 14:25