Change | SubmitChange
Submits a change request for an existing booking. Within a single change workflow, changeType, changeReason, and updatedSegments must remain the same. If different passengers require different changes, submit separate change requests.
Notice:
Product Scope: FareMarket and TechHub
POST
/flight/changeParameter
| 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 generated by the Booking API Commit operation. | |
| changeType | required |
String | Type of change request: VOLUNTARY: Voluntary change requested by the customer. INVOLUNTARY: Involuntary change caused by airline or operational reasons. INFORMATION_UPDATER: Passenger information update. OTHER: Other reason. Refer to appendix ‘Change Type List’ for details |
|
| changeReason | optional |
String | Reason for the change request: 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 change. | |
| 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 | optional |
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 | Passenger last name. | |
| ageType | required |
Int | Passenger type: 0 = ADT (Adult) 1 = CHD (Child) 2 = INF (Infant). |
|
| birthday | optional |
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 change. | |
| 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 | optional |
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 change, 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. | |
| url | required |
String | This field uses the url returned by the UploadAttachment interface. |
Request_Example:
{ "action": "SubmitChange", "key": "{{key}}", "signature": "{{signature}}", "timestamp": {{timestamp}}, "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", "url": "http://cdn.letsflytech.com/upload%2F2025121811%2F2025121811_0.JPG" } ] } }
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 | change 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:admin Update time:2026-03-19 18:19
Last editor:admin Update time:2026-03-19 18:19