Get-ancillaries Array
# 1. Tổng quan
- Action URL:
/api/v1/bamboo/flight/ancillaries - Đặc tả chi tiết: Swagger Link (opens new window)
- Mô tả:
API này cho phép lấy danh sách dịch vụ phụ trợ (Ancillary) cho chuyến bay Bamboo Airways theo mảng mã chuyến bay.
# 2. Hướng dẫn
- Thực hiện request từ thông tin mã chuyến bay để lấy danh sách dịch vụ phụ trợ.
- POST tới API Action URL để nhận về kết quả danh sách phụ trợ.
- Nhận response và xử lý dữ liệu ở phía ứng dụng của đại lý.
# 3. Parameters
# Bảng mô tả Parameters
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả |
|---|---|---|---|
x-api-token | Có | String | Token API (F10) |
x-api-password | Có | String | Mật khẩu API (F10) |
x-api-account | Có | String | Tài khoản API (F10) |
# 4. Request Body
# 4.1 Ví dụ Request Body
{
"ancillaryRequests": [
{
"point_of_purchase": "string",
"air_booking_id": "string"
}
]
}
# 4.2 Bảng mô tả Request Body
| Thuộc tính | Bắt buộc | Kiểu dữ liệu | Mô tả | Ví dụ |
|---|---|---|---|---|
Point_of_purchase | Có | String | Loại tiền tệ | "VND" |
Air_booking_id | Có | String | Mã chuyến bay | "QH1234" |
# 5. Response
# 5.1 Ví dụ Response
{
"statusCode": 200,
"timestamp": "2025-07-31T08:42:32.072Z",
"path": "/api/v1/bamboo/flight/ancillary/get-ancillaries",
"message": "Lấy danh sách dịch vụ phụ trợ Bamboo Airways theo mảng thành công",
"data": {
"totalRequests": 2,
"successCount": 2,
"failureCount": 0,
"totalDuration": 1500,
"results": [
{
"index": 0,
"success": true,
"duration": 800,
"data": {
"success": true,
"id": "ANC20250731154229175395134929710006",
"message": [
{ "message": "Thành công!" }
],
"data": [
{
"id": "anc_001",
"name": "Baggage 20kg",
"description": "Hành lý ký gửi 20kg",
"type": "BAGGAGE",
"price": 200000,
"currency": "VND",
"available": true,
"remaining_quantity": 10
}
],
"total_count": 1
}
},
{
"index": 1,
"success": true,
"duration": 700,
"data": {
"success": true,
"id": "ANC20250731154229175395134929710007",
"message": [
{ "message": "Thành công!" }
],
"data": [
{
"id": "anc_002",
"name": "Seat Selection",
"description": "Chọn ghế ngồi",
"type": "SEAT",
"price": 150000,
"currency": "VND",
"available": true,
"remaining_quantity": 50
}
],
"total_count": 1
}
}
],
"errors": null
}
}
# 5.2 Bảng mô tả Response
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
status_code | number | Mã trạng thái HTTP/ứng dụng |
path | string | Thời gian tìm kiếm |
timestamp | string | Nguồn tìm kiếm |
success | boolean | Trạng thái thành công của yêu cầu |
id | string | ID yêu cầu gửi tới Bamboo Airways |
message | array<object> | Danh sách thông điệp phản hồi từ Bamboo Airways |
total_count | number | Tổng số dịch vụ phụ trợ Bamboo Airways trả về |
data | object | Dữ liệu batch trả về |
# 5.3 Bảng mô tả cấu trúc Data
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
totalRequests | number | Tổng số yêu cầu |
successCount | number | Số yêu cầu thành công |
failureCount | number | Số yêu cầu thất bại |
totalDuration | number | Tổng thời gian xử lý của toàn bộ batch |
results | array | Kết quả của từng yêu cầu trong batch |
# 5.4 Bảng mổ tả cấu trúc Results
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
index* | number | Vị trí phần tử trong mảng request/batch |
success* | boolean | Trạng thái thành công của phần tử request |
data* | object | Dữ liệu trả về khi thành công (cấu trúc tùy API con) |
error* | string | Thông báo lỗi khi thất bại (rỗng nếu thành công) |
duration* | number (ms) | Thời gian xử lý cho phần tử request |
# 5.5 Bảng mô tả cấu trúc Data, ListService
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
StatusCode | string | Mã trạng thái |
Success | boolean | Trạng thái thành công |
Message | string | Thông báo phản hồi |
Language | string | Ngôn ngữ phản hồi |
RequestID | string | ID yêu cầu |
Session | string | Phiên làm việc |
ListBaggage | array<BaggageDto> | Danh sách hành lý |
ListService | array<ServiceDto> | Danh sách dịch vụ phụ trợ |
Remark | string | Ghi chú |
# 5.6 Bảng mô tả cấu trúc ListBaggage
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
| Session | string | Phiên làm việc |
| Airline | string | Hãng hàng không (mã IATA 2 ký tự hoặc tên) |
| Value | string | Mã dịch vụ (giá trị) |
| Code | string | Mã dịch vụ |
| Type | string (enum) | Loại dịch vụ (BAGGAGE, PRESEAT, WCHR, MEAL, OTHER) |
| Name | string | Tên dịch vụ |
| Description | string | Mô tả dịch vụ |
| Price | number | Giá dịch vụ |
| Currency | string | Loại tiền tệ (ISO-4217) |
| Quantity | number | Số lượng |
| Leg | number | Số thứ tự chặng bay |
| StartPoint | string | Mã sân bay khởi hành (IATA 3 ký tự) |
| EndPoint | string | Mã sân bay hạ cánh (IATA 3 ký tự) |
| StatusCode | string | Mã trạng thái |
| Confirmed | boolean | Đã xác nhận |