AncillaryOrderDetail

  • Purpose: Used to retrieve the details of a specified ancillary order, including its status, contact information, and SSR or seat details.
  • Request: POST
  • Encryption: No
  • FareMarket Address: /supplier/v1/api/ancillary_order_detail

Request

Parameter Name Type Required Description
apiKey string ✅ Unique supplier identity key provided by AeroHub before interface testing.
requestId string ✅ Request ID. It must be unique for each call and must contain 32 characters.
ancillaryOrderNo string ✅ AeroHub ancillary order number corresponding to ancillaryOrderNo returned by AncillaryOrderList.

Sample Request:

{
  "apiKey": "PcrNq8964iFUkE0CyVV4bhgXXX",
  "requestId": "3fd720b5bf544161bd14c535c9a1b2c3",
  "ancillaryOrderNo": "A1745527321051406356"
}

Response

Parameter Name Type Required Description
code int ✅ AeroHub status code. Refer to Market Errors in General.
msg string ✅ AeroHub status or error description. Refer to Market Errors in General.
data object/Data Object ✅ Ancillary order details.

object/Data Object

Parameter Name Type Required Description
purchaseOrderNo string ✅ AeroHub flight order number.
ancillaryOrderNo string ✅ AeroHub ancillary order number.
ancillaryOrderStatus string ✅ Ancillary order status: TOBEISSUED pending issuance, ISSUED completed, REJECTED rejected because issuance failed.
totalCost float ✅ Total cost of the after-sales ancillary order.
lastUpdateTime string ✅ Time when the order was last updated in AeroHub, in ISO 8601 format.
createTime string ✅ Time when the order was created in AeroHub, in ISO 8601 format.
ancillaryType string ⬜ Ancillary order type: ssr for existing baggage or other SSR orders, and seat for seat orders. An empty string may be returned for historical orders.
ssr array/SSR Element ⬜ Existing after-sales ancillary details. Returned only when ancillaryType=ssr. The existing field structure remains unchanged.
seat array/Seat Element ⬜ Seat details. Returned only when ancillaryType=seat.
contact object/Contact Element ⬜ Contact information for the ancillary order.

object/Contact Element

Parameter Name Type Required Description
fullName string ✅ Contact name in LastName/FirstName MiddleName format, with / between the last name and first name.
address string ✅ Contact address.
postCode string ⬜ Postal code.
email string ✅ Contact email address.
mobile string ✅ Contact mobile number.

array/SSR Element

Parameter Name Type Required Description
passengerNo int ✅ Passenger sequence number, starting from 0.
passengerName string ✅ Passenger name in LastName/FirstName MiddleName format, with / between the last name and first name.
nationality string ✅ Passenger nationality using the ISO 3166 two-letter country code standard.
birthday string ✅ Date of birth in YYYYMMDD format.
gender string ✅ Passenger gender: M male, F female.
cardType int ✅ Document type: 0 empty, 1 unknown, 2 passport, 3 Mainland Travel Permit for Hong Kong and Macao Residents, 4 Mainland Travel Permit for Taiwan Residents, 5 Taiwan Compatriot Permit, 6 Home Return Permit, 7 International Seafarer’s Identity Document, 8 ID card.
cardNo string ✅ Document number, with a maximum length of 15 characters.
cardExpired string ✅ Document expiration date in YYYYMMDD format.
ageType int ✅ Passenger type: 0 adult, 1 child, 2 infant.
flightNumber string ✅ Flight number.
depAirport string ✅ Departure airport code.
arrAirport string ✅ Arrival airport code.
depTime string ✅ Local departure date and time in ISO 8601 format.
arrTime string ✅ Local arrival date and time in ISO 8601 format.
name string ✅ Ancillary product name.
type int ✅ Ancillary type: 0 checked baggage, 1 cabin baggage, 2 check-in, 3 cabin baggage plus priority boarding package.
code string ✅ Ancillary product code.
weight int ✅ Weight.
count int ✅ Number of pieces.
bookSalePrice float ✅ Unit price.
currency string ✅ Currency.

array/Seat Element

Parameter Name Type Required Description
passengerNo int ✅ Passenger sequence number, starting from 0.
passengerName string ✅ Passenger name in LastName/FirstName MiddleName format, with / between the last name and first name.
nationality string ✅ Passenger nationality using the ISO 3166 two-letter country code standard.
birthday string ✅ Date of birth in YYYYMMDD format.
gender string ✅ Passenger gender: M male, F female.
cardType int ✅ Document type: 0 empty, 1 unknown, 2 passport, 3 Mainland Travel Permit for Hong Kong and Macao Residents, 4 Mainland Travel Permit for Taiwan Residents, 5 Taiwan Compatriot Permit, 6 Home Return Permit, 7 International Seafarer’s Identity Document, 8 ID card.
cardNo string ✅ Document number, with a maximum length of 15 characters.
cardExpired string ✅ Document expiration date in YYYYMMDD format.
ageType int ✅ Passenger type: 0 adult, 1 child, 2 infant.
ticketNo string ⬜ Ticket number corresponding to the passenger and flight segment.
flightNumber string ✅ Flight number.
depAirport string ✅ Departure airport code.
arrAirport string ✅ Arrival airport code.
depTime string ✅ Local departure date and time in ISO 8601 format.
arrTime string ✅ Local arrival date and time in ISO 8601 format.
rowNo string ✅ Seat row number.
colNo string ✅ Seat column number.
deck string ✅ Deck: M for Main Deck and U for Upper Deck.
amount float ✅ Sale amount for the seat.
currency string ✅ Currency.
pnrCode string ✅ PNR corresponding to the seat detail. When a flight order is split for ticketing, different seat details may contain different PNRs. This field applies only to the newly added seat[] and does not change the existing ssr[].

Response Rules

  • When ancillaryType=ssr, return the existing ssr[]. pnrCode is not added to ssr[].
  • When ancillaryType=seat, return the newly added seat[]. Each seat element contains one pnrCode.
  • When an ancillary order contains multiple PNRs because the flight order was split for ticketing, return them in separate seat[] elements and associate each PNR with passengerNo, flightNumber, and ticketNo.
  • The same PNR may be repeated in multiple seat details.
  • Historical orders may omit ancillaryType or return an empty string. Integrators must maintain backward compatibility.

Response Examples

SSR Order Success Response:

{
  "code": 200,
  "msg": "Successful",
  "data": {
    "purchaseOrderNo": "333679914567",
    "ancillaryOrderNo": "A1772961465922359296",
    "ancillaryOrderStatus": "ISSUED",
    "totalCost": 24.44,
    "lastUpdateTime": "2024-03-11T12:30:45",
    "createTime": "2024-03-10T15:45:20",
    "ancillaryType": "ssr",
    "contact": {
      "fullName": "ZHANG/SAN",
      "address": "haugenlia 12447",
      "postCode": "10001",
      "email": "sansan@aerohub.uk",
      "mobile": "13801112547"
    },
    "ssr": [
      {
        "passengerNo": 0,
        "passengerName": "CHEN/RUKUN",
        "nationality": "PE",
        "birthday": "19650929",
        "gender": "F",
        "cardType": 2,
        "cardNo": "2230512125",
        "cardExpired": "20280327",
        "ageType": 0,
        "flightNumber": "DD123",
        "depAirport": "HKT",
        "arrAirport": "BKK",
        "depTime": "2023-01-12T03:25:22",
        "arrTime": "2023-01-12T03:25:22",
        "name": "15 KG",
        "type": 1,
        "code": "PA15",
        "weight": 15,
        "count": 2,
        "bookSalePrice": 12.22,
        "currency": "USD"
      }
    ]
  }
}

Seat Order Success Response — Split Ticketing:

{
  "code": 200,
  "msg": "Successful",
  "data": {
    "purchaseOrderNo": "333679914567",
    "ancillaryOrderNo": "A1772961465922359297",
    "ancillaryOrderStatus": "ISSUED",
    "totalCost": 58.64,
    "lastUpdateTime": "2024-03-11T12:30:45",
    "createTime": "2024-03-10T15:45:20",
    "ancillaryType": "seat",
    "contact": {
      "fullName": "ZHANG/SAN",
      "address": "haugenlia 12447",
      "postCode": "10001",
      "email": "sansan@aerohub.uk",
      "mobile": "13801112547"
    },
    "seat": [
      {
        "passengerNo": 0,
        "passengerName": "CHEN/RUKUN",
        "nationality": "PE",
        "birthday": "19650929",
        "gender": "F",
        "cardType": 2,
        "cardNo": "2230512125",
        "cardExpired": "20280327",
        "ageType": 0,
        "ticketNo": "1234567890123",
        "flightNumber": "5J378",
        "depAirport": "CGY",
        "arrAirport": "MNL",
        "depTime": "2023-01-12T03:25:22",
        "arrTime": "2023-01-12T03:25:22",
        "rowNo": "12",
        "colNo": "A",
        "deck": "M",
        "amount": 29.32,
        "currency": "USD",
        "pnrCode": "YF7F6F"
      },
      {
        "passengerNo": 1,
        "passengerName": "LI/MING",
        "nationality": "CN",
        "birthday": "19900101",
        "gender": "M",
        "cardType": 2,
        "cardNo": "E12345678",
        "cardExpired": "20300101",
        "ageType": 0,
        "ticketNo": "1234567890124",
        "flightNumber": "5J378",
        "depAirport": "CGY",
        "arrAirport": "MNL",
        "depTime": "2023-01-12T03:25:22",
        "arrTime": "2023-01-12T03:25:22",
        "rowNo": "12",
        "colNo": "B",
        "deck": "M",
        "amount": 29.32,
        "currency": "USD",
        "pnrCode": "A2B3C4"
      }
    ]
  }
}

Error Response:

{
  "code": 1000,
  "msg": "Invalid API Key"
}
Author：AeroHub  Create time：2024-03-13 10:19
Last editor：AeroHub  Update time：2026-10-20 11:28