GET/v1/trains/book/:gdsprovider/:bookingId/required-fields

获取火车预订必填字段

获取创建订单所需的旅客和持有人字段。

分享

获取创建订单所需的旅客和持有人字段。

认证和请求头

请求头说明
AuthorizationBearer <secret_key>。密钥只能保存在服务器端，不能写入客户端日志。
X-Travelandz-Id<public_key>:<profile_code>，持久化的 profile code 格式为 dp_<12 位字母数字>。
Content-Type带 JSON body 的请求使用 application/json。

请求

Path 参数：gdsprovider 当前为 0；bookingId 来自预订。

请求参数结构

gdsprovider
enum
0
是
Currently 0
bookingId
string是
Booking id returned by prebook.

成功响应

返回 holder 和 passengers[] 标志。每个 boolean 表示创建订单时是否必须发送对应字段；idx 表示旅客位置。

响应体结构

holder
object是
holderphone
boolean是
holderemail
boolean是
holdercountryCode
boolean是
passengers
array是
passengers[]idx
number是
passengers[]title
boolean是
passengers[]type
boolean是
passengers[]name
boolean是
passengers[]lastName
boolean是
passengers[]age
boolean是
passengers[]nationality
boolean是
passengers[]gender
boolean是
passengers[]phone
boolean是
passengers[]email
boolean是
passengers[]countryCode
boolean是
passengers[]address
boolean是
passengers[]city
boolean是
passengers[]postalCode
boolean是
passengers[]bornDate
boolean是
passengers[]cityOfBirth
boolean是
passengers[]countryOfBirth
boolean是
passengers[]documentIdentifier
boolean是
passengers[]documentType
boolean是
passengers[]documentIssuedAt
boolean是
passengers[]documentExpiresAt
boolean是
passengers[]documentCountryCode
boolean是
passengers[]allowedDocuments
array是
passengers[]allowedDocuments[]
string[]是

错误

  • 400 表示验证失败或存在未知字段。
  • 401 或 403 表示 API 凭证无效。
  • 供应方失败时返回 500 internal_communication_error 或 unknown_error。
  • 预订不存在或已过期时返回 booking_not_found。

使用说明

根据标记为 true 的字段构建旅客表单；不要假设每个预订需要相同的身份数据。

cURL 示例

bash
bash
curl --request GET \
  --url "https://api.sandbox.travelandz.com/v1/trains/book/0/booking_123/required-fields" \
  --header "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  --header "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"