OrderDetail

  • Purpose: Used to retrieve detailed information for a specific order, including all order statuses.
  • Request: POST
  • Encryption: No
  • URL: /supplier/v1/api/order_detail

Request

name type required description
apiKey string ✅ Each supplier has a unique apiKey to represent their identity. Provided by AeroHub before interface testing.
requestId string ✅ Unique ID for each call during the ticketing process. 32 characters in length.
purchaseOrderNo string ✅ AeroHub’s order number, corresponding to the Order interface request’s OrderNo.

Sample Request:

{
    "apiKey": "PcrNq8964iFUkE0CyVV4bhgXRH",
    "requestId": "3fd720b5bf544161bd14c535c9",
    "purchaseOrderNo": "F1745527321051406356"
}

Response

Name Type Required Description
code int ✅ AeroHub status code. Refer to Market Errors in the general documentation.
msg string ✅ AeroHub error description. Refer to Market Errors in the general documentation.
data array/Data Element ⬜️ Order details.

Data Element

Parameter Name Type Required Description
purchaseOrderNo string ✅ AeroHub’s order number, corresponding to the OrderNo in the Order interface request.
supplierOrderNo string ✅ Supplier’s own system order number, corresponding to the OrderNo in the response from the Order interface.
pnrCode string ✅ PNR code for ticketing, can be used for booking management on the airline’s official website.
tripType int ✅ Itinerary type: 1 for one-way, 2 for round-trip.
channelCode string ✅ Sales channel code, for specific sales channels where AeroHub and the supplier have special ticketing or after-sales requirements.
parentCarrier string ✅ Outbound airline carrier code, using the IATA two-letter code standard, corresponding to the first two characters of the flightNumber.
paymentCode string ✅ Payment method, currently only AG is available, which means payment by supplier balance.
lastUpdateTime string ✅ The last update time of the order in AeroHub’s system, in ISO 8601 format.
createTime string ✅ The creation time of the order in AeroHub’s system, in ISO 8601 format.
contact object/Contact Element ✅ Contact information for the order, consistent with the supplier’s return from the Order interface.
flightSegments array/FlightSegments Element ✅ Itinerary information for the order.
serviceTag object ✅ The service requirements tag for this specific order, including ticketing speed, whether split-ticket issuance is allowed, whether ticket number changes are allowed, and whether platform email is used for invoicing.
ssr array/ssr Element ⬜️ Ancillary service information for the order.
siteChannel int ⬜ Site source, different service requirements for each site. For example, 1 represents site1.

object/Contact Element

Name Type Required Description
fullName string ✅ Full name of the contact person, with the last name and first name separated by a slash, LastName/FirstName MiddleName.
address string ✅ Contact address.
postCode string ⬜️ Postal code.
email string ✅ Contact person’s email address.
mobile string ✅ Contact person’s mobile phone number.

array/FlightSegments Element

Parameter Name Type Required Description
depAirport string ✅ Departure airport code, using IATA three-letter codes as the standard.
arrAirport string ✅ Arrival airport code, using IATA three-letter codes as the standard.
depTime string ✅ Departure date and time (local time), in ISO 8601 format.
arrTime string ✅ Arrival date and time (local time), in ISO 8601 format.
ageType int ✅ Passenger type: 0 for Adult, 1 for Child, 2 for Infant.
passengerNo int ✅ Passenger’s serial number, starting from 0, consistent with the passengerNo in the Order request.
passengerName string ✅ Passenger’s name, with the last name and first name separated by a slash: LastName/FirstName MiddleName.
nationality string ✅ Passenger’s nationality, using ISO 3166 two-letter codes as the standard.
birthday string ✅ Passenger’s date of birth, in the format YYYYMMDD.
withPassengerNo int ⬜️ Will be returned when the passenger type is an infant, indicating the accompanying adult passenger’s passengerNo.
gender string ✅ Passenger’s gender: M for Male, F for Female.
cardType int ✅ Type of identification: 0 for Null, 1 for Unknown, 2 for Passport, 3 for Hong Kong/Macau Pass, 4 for Taiwan Pass, 5 for Taiwan Compatriot Pass, 6 for Home Return Permit, 7 for International Seafarer’s Certificate, 8 for Identity Card. 9 NIE for Foreign Identification Number (Spain), 10 DNI for Identification Number (Spain),
cardNo string ✅ Identification card number, maximum of 15 characters.
cardExpired string ✅ Expiry date of the identification card, in the format YYYYMMDD.
seatGrade string ✅ Cabin class: F for First Class, C for Business Class, S for Premium Economy Class, Y for Economy Class.
seatClass string ✅ Seat class.
flightNumber string ✅ Flight number, e.g., CA123.
segmentNo int ✅ Journey order: 1 for Outbound, 2 for Return.
sequence int ✅ Segment order, starting from 1. Note: For round-trip flights, both outbound and return start from 1.
currency string ✅ Currency of the quote, generally consistent with the settlement currency agreed with the supplier.
ticketPrice float ✅ Ticket face value, excluding taxes.
taxAmount float ✅ Tax amount.
totalCost float ✅ Total ticket amount (base fare + taxes).

Object/ServiceTag Element

Name Type Required Description
ticketSpeed int ✅ 0: 30 minutes; 1: 1 hour; 2: 12 hours.
nonSplitOrder int ✅ 0 - Unlimited, 1 - Prohibit splitting orders for ticketing.
nonReplaceTicketNo int ✅ 0 - Unlimited, 1 - Prohibit replacing ticket number after ticketing.
issueMailbox int ✅ 0 - Unlimited, 1 - Customer provided.

array/ssr Element

Parameter Name Type Required Description
passengerNo int ✅ Passenger’s serial number, starting from 0, consistent with the passengerNo in FlightSegments.
passengerName string ✅ Passenger’s name, with the last name and first name separated by a slash: LastName/FirstName MiddleName.
flightNumber string ✅ Flight number, e.g., CA123.
segmentNo int ✅ Journey order: 1 for Outbound, 2 for Return.
sequence int ✅ Segment order, starting from 1. Note: For round-trip flights, both outbound and return start from 1.
depAirport string ✅ Departure airport code, using IATA three-letter codes as the standard.
arrAirport string ✅ Arrival airport code, using IATA three-letter codes as the standard.
departureTime string ✅ Departure date and time (local time), in the format: YYYYMMDDHHMM. For example, 202303100300 represents March 10, 2023, at 3:00 AM.
code string ✅ SSR code, should be consistent with the code returned in the Order interface.
name string ✅ SSR name, should be consistent with the name returned in the Order interface.
type string ✅ SSR type: 0 for Checked Baggage, 1 for Carry-on Baggage, 2 for Check-in, 3 for Carry-on Baggage + Priority Boarding Package, consistent with the type in the Order interface.
count int ✅ Quantity of SSR items, should be consistent with the count in the Order interface.
weight int ✅ Weight of SSR, should be consistent with the weight in the SSR interface.
bookSalePrice float ✅ Price of the SSR at booking (unit price), should be consistent with the price in the Order interface, rounded to two decimal places.
currency string ✅ SSR currency, should be consistent with the currency of the flight ticket and the currency in the Order interface.
baggageSources string ⬜️ Empty: Supplier’s quoted baggage; FMKT: Faremarket’s quoted baggage data.

array/seats Element

Parameter Name Type Required Description
passengerNo int ✅ Passenger’s serial number, starting from 0, consistent with the passengerNo in FlightSegments.
passengerName string ✅ Passenger’s name, with the last name and first name separated by a slash: LastName/FirstName MiddleName.
flightNumber string ✅ Flight number, e.g., CA123.
segmentNo int ✅ Journey order: 1 for Outbound, 2 for Return.
sequence int ✅ Segment order, starting from 1. Note: For round-trip flights, both outbound and return start from 1.
depAirport string ✅ Departure airport code, using IATA three-letter codes as the standard.
arrAirport string ✅ Arrival airport code, using IATA three-letter codes as the standard.
departureTime string ✅ Departure date and time (local time), in the format: YYYYMMDDHHMM. For example, 202303100300 represents March 10, 2023, at 3:00 AM.
amount float ✅ Price for seat selection. A value of 0 means the seat is included in the package for free.
currency string ✅ Transaction currency.
seatCode string ✅ Seat position code.

Success Response:

{
    "code": 200,
    "msg": "Successful",
    "data": {
        "purchaseOrderNo": "F1745527321051406356",
        "supplierOrderNo": "240112032518897783",
        "pnrCode": "EFN5M5",
        "tripType": 2,
        "channelCode": "",
        "parentCarrier": "LA",
        "paymentCode": "AG",
        "lastUpdateTime": "2023-01-12 03:25:19",
        "createTime": "2023-01-12 03:25:19",
        "serviceTag": {
            "ticketSpeed": 1,
            "nonSplitOrder": 0,
            "nonReplaceTicketNo": 1,
            "issueMailbox": 0
        },
        "contact": {
            "fullName": "ZHANG/SAN",
            "address": "haugenlia 12447",
            "postCode": "10001",
            "email": "sansan@aerohub.uk",
            "mobile": "13801112547"
        },
        "flightSegments": [{
                "depAirport": "LIM",
                "arrAirport": "CUN",
                "depTime": "2023-01-23T10:50:00",
                "arrTime": "2023-01-23T16:20:00",
                "ageType": 0,
                "passengerNo": 0,
                "passengerName": "ZHANG/SAN",
                "nationality": "PE",
                "birthday": "19650929",
                "gender": "F",
                "cardType": 2,
                "cardNo": "2230512125",
                "cardExpired": "20280327",
                "seatGrade": "Y",
                "seatClass": "K",
                "flightNumber": "LA2454",
                "segmentNo": 1,
                "sequence": 1,
                "currency": "USD",
                "ticketPrice": 682.46,
                "taxAmount": 259.85,
                "totalCost": 942.31
            },
            {
                "depAirport": "CUN",
                "arrAirport": "LIM",
                "depTime": "2023-01-29T00:25:00",
                "arrTime": "2023-01-29T05:40:00",
                "ageType": 0,
                "passengerNo": 0,
                "passengerName": "ZHANG/SAN",
                "nationality": "PE",
                "birthday": "19650929",
                "gender": "F",
                "cardType": 2,
                "cardNo": "2230512125",
                "cardExpired": "20280327",
                "seatGrade": "Y",
                "seatClass": "V",
                "flightNumber": "LA2457",
                "segmentNo": 2,
                "sequence": 1,
                "currency": "USD",
                "ticketPrice": 0.0,
                "taxAmount": 0.0,
                "totalCost": 0.0
            }
        ],
        "ssr": [{
                "passengerNo": 0,
                "passengerName": "ZHANG/SAN",
                "flightNumber": "LA2454",
                "segmentNo": 1,
                "sequence": 1,
                "depAirport": "LIM",
                "arrAirport": "CUN",
                "departureTime": "2023-01-23T10:50:00",
                "code": "PA20",
                "name": "PA20",
                "type": 0,
                "count": 1,
                "weight": 20,
                "bookSalePrice": 50.00,
                "currency": "USD"
            },
            {
                "passengerNo": 0,
                "passengerName": "ZHANG/SAN",
                "flightNumber": "LA2457",
                "segmentNo": 2,
                "sequence": 1,
                "depAirport": "CUN",
                "arrAirport": "LIM",
                "departureTime": "2023-01-29T00:25:00",
                "code": "PA20",
                "name": "PA20",
                "type": 0,
                "count": 1,
                "weight": 20,
                "bookSalePrice": 50.00,
                "currency": "USD"
            }
        ],
        "seats": [{
                "passengerNo": 0,
                "passengerName": "ZHANG/SAN",
                "flightNumber": "LA2454",
                "segmentNo": 1,
                "sequence": 1,
                "depAirport": "LIM",
                "arrAirport": "CUN",
                "departureTime": "2023-01-23T10:50:00",
                "amount": 19.32,
                "currency": "USD",
                "seatCode": "A1"
            },
            {
                "passengerNo": 0,
                "passengerName": "ZHANG/SI",
                "flightNumber": "LA2457",
                "segmentNo": 2,
                "sequence": 1,
                "depAirport": "CUN",
                "arrAirport": "LIM",
                "departureTime": "2023-01-29T00:25:00",
                "amount": 19.32,
                "currency": "USD",
                "seatCode": "A2"
            }
        ]
    }
}

Error Response

{
    "code": 1000,
    "msg": "Invalid API Key"
}

Special

  • In cases where the code in the returned JSON data is not equal to 200 or the HTTP status code is not 200, suppliers should retry the call to ensure successful processing of the request.
Author：AeroHub  Create time：2023-07-10 16:14
Last editor：AeroHub  Update time：2025-07-29 17:21