Add-passport
# 1. Tổng quan
- Action URL:
/api/v1/bamboo/information/add-passport - Đặc tả chi tiết: Swagger Link (opens new window)
- Mô tả: Tính năng này cho phép thêm thông tin hộ chiếu (passport) cho hành khách của Bamboo Airways.
# 2. Hướng dẫn
- Thực hiện request từ thông tin mã máy bay để thêm thông tin passport cho khách hàng Bamboo Airways.
- POST tới API Action URL để nhận về kết quả thêm thông tin passport.
- Nhận về response và xử lý dữ liệu ở phía ứng dụng của đại lý.
# 3. 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
{
"guest_details": [
{
"guest_id": 2,
"document": {
"type": "P",
"country": "US",
"number": "011145115",
"nationality": "US",
"date_of_birth": "1963-05-29",
"expiry_date": "2026-07-26",
"first_name": "NAM HONG",
"last_name": "NGUYEN",
"gender": "M"
}
}
],
"air_booking_id": "FLN202510240931021761273062101532914"
}
# 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ụ |
|---|---|---|---|---|
air_booking_id | Có | string | ID đặt chỗ từ Bamboo Airways | |
guest_details | Có | array<object> | Danh sách khách và giấy tờ | |
guest_id | Có | number | ID khách trong PNR | |
document | Có | object | Thông tin giấy tờ (passport/ID) của khách | |
type | Có | string (enum) | Loại giấy tờ: P = Passport, N/I = National ID… | |
country | Có | string (ISO 3166-1 alpha-2) | Quốc gia cấp hộ chiếu/giấy tờ | |
number | Có | string | Số hộ chiếu/CMND | |
nationality | Có | string (ISO 3166-1 alpha-2) | Quốc tịch của khách | |
date_of_birth | Có | string (YYYY-MM-DD) | Ngày sinh | |
expiry_date | Có | string (YYYY-MM-DD) | Ngày hết hạn hộ chiếu/giấy tờ | |
first_name | Có | string | Tên (Given/First Name) theo giấy tờ | |
last_name | Có | string | Họ (Surname/Last Name) theo giấy tờ | |
gender | Có | string (enum) | Giới tính: M / F / X |
# 5. Response
# 5.1 Ví dụ Response
{
"statusCode": 200,
"timestamp": "2025-08-15T09:24:49.000Z",
"path": "/api/v1/bamboo/information/add-passport",
"message": "Thêm passport Bamboo Airways thành công",
"data": {
"success": true,
"id": "FLN202508150924271755224667052496961",
"message": [{ "message": "Thành công!" }],
"data": {
"error": null,
"pnr_on_hold": false,
"last_modified_datetime": "",
"number_of_seats": 1,
"itinerary": [...],
"guest_details": [...],
"pnr_contact": {...},
"itin_price": {...},
"errors": null
}
}
}
# 5.2 Bảng mô tả Cấu trúc Response (top-level)
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
statusCode | number | Mã trạng thái HTTP |
timestamp | string (ISO 8601) | Thời điểm phản hồi |
path | string | Đường dẫn API |
message | string | Thông báo chung |
data | object | Khối dữ liệu chi tiết |
errors | array<object> | null | Danh sách lỗi nếu có |
# 5.3 Cấu trúc data
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
success | boolean | Trạng thái thành công phía Bamboo |
id | string | ID truy vết/yêu cầu Bamboo |
message | array<object> | Danh sách thông điệp chi tiết |
data | object | Dữ liệu chi tiết sau khi thêm passport |
# 5.4 Cấu trúc data.data
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
flight_segment_group_id | number | ID nhóm chặng |
segment_id | number | ID chặng |
carrier_code | string | Mã hãng |
flight_number | string | number | Số hiệu chuyến bay |
flight_date | string (YYYY-MM-DD) | Ngày bay |
board_point | string | Sân bay khởi hành |
off_point | string | Sân bay đến |
scheduled_departure_datetime | string | Giờ cất cánh dự kiến |
scheduled_arrival_time | string | Giờ hạ cánh dự kiến |
departure_terminal | string | Nhà ga đi |
arrival_terminal | string | Nhà ga đến |
cabin_class | string | Hạng khoang |
flight_status | string | Tình trạng PNR/segment |
aircraft_type | string | Loại tàu bay |
booking_class | string | Hạng đặt chỗ |
is_international | boolean | Chặng quốc tế hay nội địa |
# 5.5 Cấu trúc data.data.itinerary[]
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
| flight_segment_group_id | number | ID nhóm chặng |
| segment_id | number | ID chặng |
| carrier_code | string | Mã hãng |
| flight_number | string | number | Số hiệu chuyến bay |
| flight_date | string (YYYY-MM-DD) | Ngày bay |
| board_point | string | Sân bay khởi hành |
| off_point | string | Sân bay đến |
| scheduled_departure_datetime | string | Giờ cất cánh dự kiến |
| scheduled_arrival_time | string | Giờ hạ cánh dự kiến |
| departure_terminal | string | Nhà ga đi |
| arrival_terminal | string | Nhà ga đến |
| cabin_class | string | Hạng khoang |
| flight_status | string | Tình trạng PNR/segment |
| aircraft_type | string | Loại tàu bay |
| booking_class | string | Hạng đặt chỗ |
| is_international | boolean | Chặng quốc tế hay nội địa |
# 5.6 Cấu trúc data.data.guest_details[]
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
given_name | string | Tên khách |
sur_name | string | Họ khách |
name_prefix | string | Xưng hô |
type | string | Loại khách: ADULT / CHILD / INFANT |
guest_id | number | ID khách |
ticket_details | array<object> | Chi tiết vé của khách |
# 5.7 Cấu trúc data.data.pnr_contact
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
address | object | Địa chỉ liên hệ |
name_prefix | string | Xưng hô người liên hệ |
language | string | Ngôn ngữ |
sur_name | string | Họ người liên hệ |
given_name | string | Tên người liên hệ |
# 5.8 Cấu trúc data.data.pnr_contact.address
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
email | string | Email liên hệ |
phone_number | string | Số điện thoại liên hệ |
# 5.9 Cấu trúc data.data.itin_price
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
guest_price_break_down | array<object> | Chi tiết giá theo từng khách |
total_amount_tobe_paid | object | Tổng tiền phải trả |
total_amount_paid | object | Tổng đã thanh toán |
remarks | array<string> | Ghi chú hệ thống |
# 5.10 Cấu trúc data.data.itin_price.guest_price_break_down[].price_break_down[].applied_fare_detail_type
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
base_fare | number | Giá cước gốc |
base_fare_currency | string | Tiền tệ của base_fare |
applied_fare | number | Giá cước đã áp dụng |
display_fare_amount | number | Giá hiển thị |
currency | string | Tiền tệ hiển thị |
# 5.11 Cấu trúc data.data.total_amount_tobe_paid
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
currency | string | Tiền tệ tổng thanh toán |
amount | number | Tổng tiền phải trả |
guest_amount | array<object> | Tổng theo từng khách |
# 5.12 Cấu trúc data.data.total_amount_tobe_paid.guest_amount[]
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
guest_id | number | ID khách |
amount | number | Số tiền phải trả của khách |
currency | string | Tiền tệ |
guest_type | string | Loại khách |
# 5.13 Cấu trúc data.data.time_limit_detail
| Thuộc tính | Kiểu dữ liệu | Mô tả |
|---|---|---|
time_limit_action | string | Hành động khi quá hạn |
time_limit_ltc | string | Hạn theo local time |
time_limit_tst | string | Hạn hệ thống (TST) |
note | string | Ghi chú |