AncillarySSR
- Purpose: This interface allows obtaining prices for ancillary services charged by the supplier, including checked baggage, carry-on baggage, priority boarding, etc.
- Request Method:
POST - Interface Encryption:
No
Request Parameters
| Parameter Name |
Type |
Required |
Description |
| requestId |
string |
✅ |
Request ID, unique for each interface in the booking process, can be used to link a complete booking process, 32 characters in length |
| channelCode |
string |
✅ |
Code for the sales channel, specific sales channels; AeroHub will agree with suppliers on special ticketing or after-sales requirements |
| segments |
array/Segment Element |
✅ |
Itinerary information |
| orderNo |
string |
✅ |
AeroHub ticket order number; must be provided when purchasing ancillary products after ticket issuance |
| isCache |
int |
⬜️ |
Whether to use cached data; null or 0 for not using cache, 1 for using cached data |
array/Segment Element
| Parameter Name |
Type |
Required |
Description |
| depAirport |
string |
✅ |
Departure airport code, using IATA three-letter code as standard |
| arrAirport |
string |
✅ |
Arrival airport code, using IATA three-letter code as standard |
| flightNumber |
string |
✅ |
Flight number, e.g., CA123 |
| depDate |
string |
✅ |
Departure date, format: YYYYMMDD, e.g., 20230310 for March 10, 2023 |
| passengerName |
string |
✅ |
Passenger name, separated by “/“, LastName/FirstName MiddleName |
| passengerNo |
int |
✅ |
Passenger number, starting from 0 |
| ageType |
int |
✅ |
Passenger type: 0 Adult, 1 Child, 2 Infant |
| nationality |
string |
⬜️ |
Passenger nationality, using ISO 3166 two-letter code as standard |
| birthday |
string |
✅ |
Date of birth, format: YYYYMMDD |
| gender |
string |
✅ |
Passenger gender, M for male, F for female |
| cardType |
int |
✅ |
Type of identification: 1 Unknown, 2 Passport, 3 Hong Kong/Macau Pass, 4 Taiwan Pass, 5 Taiwan Compatriot Pass (Mainland Travel Permit for Taiwan Residents), 6 Home Return Permit (Mainland Travel Permit for Hong Kong/Macau Residents), 7 International Seafarer’s Certificate, 8 Identity Card |
| cardNo |
string |
⬜️ |
Identification number, maximum 15 characters |
| cardExpired |
string |
⬜️ |
Expiry date of identification, format: YYYYMMDD |
| pnrCode |
string |
✅ |
PNR code of the flight ticket order, can be used for airline official website reservation management |
Request Example
{
"requestId": "74e155e75f9d4a33",
"channelCode":"RF362",
"orderNo": "F123123123111121",
"isCache": 0,
"segments": [{
"depAirport": "CNX",
"arrAirport": "DMK",
"flightNumber": "DD133",
"depDate": "20231226",
"passengerName": "CHEN/RU",
"passengerNo": 1
"ageType": 0,
"birthday ": "20231226",
"gender ": "F"
}]
}
Response Parameters
| Parameter Name |
Type |
Required |
Description |
| marketErrorCode |
int |
✅ |
Supplier system error code, used to assist AeroHub and the supplier in troubleshooting issues; please return the real error accurately |
| marketErrorMsg |
string |
✅ |
Description of the supplier system error; please return the real error reason accurately; length should be less than 300 |
| passengers |
array/Passengers Element |
⬜️ |
Passenger information; returned when purchasing ancillary services again after ticket issuance |
| flights |
array/flights Element |
✅ |
Flight and baggage information |
array/passengers Element
| Parameter Name |
Type |
Required |
Description |
| passengerName |
string |
✅ |
Passenger name, separated by “/“, LastName/FirstName MiddleName |
| ageType |
int |
✅ |
Passenger type: 0 Adult, 1 Child, 2 Infant |
| passengerNo |
int |
✅ |
Passenger number, starting from 0 |
| nationality |
string |
⬜️ |
Passenger nationality, using ISO 3166 two-letter code as standard |
| birthday |
string |
✅ |
Date of birth, format: YYYYMMDD |
| gender |
string |
✅ |
Passenger gender, M for male, F for female |
| cardType |
int |
⬜️ |
Type of identification: 1 Unknown, 2 Passport, 3 Hong Kong/Macau Pass, 4 Taiwan Pass, 5 Taiwan Compatriot Pass (Mainland Travel Permit for Taiwan Residents), 6 Home Return Permit (Mainland Travel Permit for Hong Kong/Macau Residents), 7 International Seafarer’s Certificate |
| cardNo |
string |
⬜️ |
Identification number, maximum 15 characters |
| cardExpired |
string |
⬜️ |
Expiry date of identification, format: YYYYMMDD |
array/flights Element
| Parameter Name |
Type |
Required |
Description |
| passengerNo |
int |
✅ |
Passenger number, starting from 0 |
| ssrs |
array/ssrs Element |
✅ |
Baggage information for the segment |
| flightNumber |
string |
✅ |
Flight number, e.g., CA123 |
| isDirect |
bool |
✅ |
Whether the baggage is direct, true for direct, false for non-direct, requiring recheck-in for checked baggage |
array/ssrs Element
| Parameter Name |
Type |
Required |
Description |
| applyType |
int |
✅ |
Type of ancillary service application: 1 During booking, 2 After booking |
| name |
string |
✅ |
Name of the ancillary service |
| code |
string |
✅ |
Code of the ancillary service; refer to the SSR Code Enum in this document for rules |
| type |
int |
✅ |
Type of ancillary service: 0 Checked baggage, 1 Carry-on baggage, 2 Check-in, 3 for priority boarding&carry-on baggage. |
| bookSalePrice |
float |
✅ |
Price of the ancillary service, rounded to 2 decimal places |
| currency |
string |
✅ |
Currency of the ancillary service, should be consistent with the ticket currency |
| weight |
int |
✅ |
Weight of the baggage; assign 0 if unknown or not applicable |
| dimensions |
object/dimensions Element |
⬜️ |
Dimensions of the ancillary service |
| unit |
string |
✅ |
Measurement unit of the ancillary service; KG for baggage, PC for check-in and priority boarding |
| desc |
string |
✅ |
Description of the ancillary service; provide an empty string if not available |
object/dimensions Element
| Parameter Name |
Type |
Required |
Description |
| length |
int |
✅ |
Length of the ancillary service |
| width |
int |
✅ |
Width of the ancillary service |
| height |
int |
✅ |
Height of the ancillary service |
Response Example
Success-Response:
{
"marketErrorCode": 200,
"marketErrorMsg": "Successful",
"passengers": [{
"passengerName": "John/Doe",
"ageType": 0,
"passengerNo": 1,
"nationality": "US",
"birthday": "19850101",
"gender": "M",
"cardType": 2,
"cardNo": "1234567890",
"cardExpired": "20251231"
}],
"flights": [{
"passengerNo": 0,
"ssrs": [{
"applyType": 1,
"name": "40 KG",
"code": "PA40",
"type": 0,
"bookSalePrice": 38.86,
"currency": "USD",
"weight": 40,
"dimensions": {
"length": 10,
"width": 5,
"height": 2
},
"unit": "KG",
"desc": ""
},
{
"applyType": 1,
"name": "25 KG",
"code": "PA25",
"type": 0,
"bookSalePrice": 22.4,
"currency": "USD",
"weight": 25,
"dimensions": {
"length": 10,
"width": 5,
"height": 2
},
"unit": "KG",
"desc": ""
}],
"flightNumber": "DD133",
"isDirect": true
}]
}
SSR Code Enum
Specify the baggage weight along with the code (e.g., PA20 represents 20 kilograms; if the airline does not have weight specifications, then use PA00)
| 代码 |
示例 |
定义 |
描述 |
| PA+Weight |
PA20 |
Checked baggage during booking |
This code is used for passengers to add checked baggage during booking |
| PB+Weight |
PB15 |
Checked baggage after booking |
This code is used for passengers to add checked baggage after booking |
| CA+Weight |
CA10 |
Carry-on baggage during booking |
This code is used for passengers to add carry-on baggage during booking |
| CB+Weight |
CB10 |
Carry-on baggage after booking |
This code is used for passengers to add carry-on baggage after booking |
| PE00 |
PE00 |
Priority boarding during booking |
This code indicates priority boarding added during booking. If priority boarding is bundled with other ancillary services such as carry-on baggage, it should be passed as PE00 |
| PS00 |
PS00 |
Priority boarding after booking |
This code indicates priority boarding added after booking. If priority boarding is bundled with other ancillary services such as carry-on baggage, it should be passed as PS00 |
Author:AeroHub Create time:2024-04-18 11:46
Last editor:AeroHub Update time:2025-07-29 17:21