Cancellation | SubmitCancellation

submit cancellation information

Notice:
Product Scope ：FareMarket

POST

/flight/cancellation

Parameter

Field Mandatory Type Scope Description
action required String SubmitCancellation
key required String API security key applied from AeroHub
signature required String Refer to Guideline to generate.
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
  applyType required String apply type
QUOTATIONProvide inquiry value before cancellation if a quotation is necessary.
TICKETSubmit cancellation request without pricing inquiry or after receiving a quotation.
  orderNum required String AeroHub Order number generated by Commit. Unique ID for bookings for FareMarket
  cancellationCategory required String For more details visit: Cancellation Category
  segments required Object[] Segment Information for Cancellation
    depAirport required String Departure airport IATA 3-Letter Codes
    arrAirport required String Arrival airport IATA 3-Letter Codes
    flightNumber required String Flight number, e.g. CA123
  passengers required Object[] Passenger Information for Cancellation
    firstName required String FirstName，in case of middle name, format is firstName middleName
    lastName required String LastName
    birthday required String Birthday, format: YYYYMMDD
  customerRemark optional String Customer remarks

Request_Example:

{
  "action": "SubmitCancellation",
  "key": "n93mPT7WzN6cLKC2",
  "signature": "YhQ2EoBQOfOnf/EOnuuuK5i+K+ncydeQhjFpoXYiEMo=",
  "timestamp": 1685116516,
  "request": {
    "orderNum": "1777597590234345472",
    "cancellationCategory": "VOLUNTARY_CANCELLATION",
    "segments": [
      {
        "depAirport": "DMK",
        "arrAirport": "HKT",
        "flightNumber": "SL770"
      },
      {
        "depAirport": "HKT",
        "arrAirport": "DMK",
        "flightNumber": "SL751"
      }
    ],
    "passengers": [
      {
        "firstName": "EMILYNK",
        "lastName": "COOPERTD",
        "birthday": "20170410"
      }
    ],
    "customerRemark": "customerRemark"
  }
}

Response

Field Type Description
status Int 0 for success, others for failure, refer to status error appendix for details
msg String Return message, maximum 64 char
cancellationNum String Cancellation number generated by Aerohub

Success-Response:

{
  "status": 0,
  "msg": "Success",
  "cancellationNum": "R20240409152629973"
}

Status Code

Name Description
1000 General system error
1001 Request parameters or part of parameters missing
1002 Invalid Action
1003 API request timeout, please request again
1004 Invalid request parameter
1005 Service system error
1101 Authentication fail, wrong signature
1102 Account disabled, please contact with account administrator
3101 Order does not exist
3103 Segment does not exist
3104 Passenger does not exist
3105 {passenger_name} : {depart_airport}-{arrival_airport} Cancellation in process
3106 {passenger_name} : {depart_airport}-{arrival_airport} Cancellation completed
3107 Failed to create a cancellation

Error-Response

{
    "status": 1000,
    "msg": "General system error"
}
Author：AeroHub  Create time：2024-09-10 13:30
Last editor：AeroHub  Update time：2025-04-22 14:25