GET/v1/transfers/reservations/:reservationId/vehicle
API 控制台
试一试
向沙箱 API 发送真实请求并查看响应。
凭证
登录后即可从已保存的 API 密钥中选择,无需手动粘贴。
路径参数
1 个字段预订 ID
创建预订时返回的预订标识符。在统一详情端点中,reservationId、confirmationNumber、searchId 三者只能发送其中一个。
查询参数
2 个字段货币
返回金额所用的货币。若已存在报价或预订,必须与其保持一致。
语言
旧版语言字段。建议使用 LANG 或 Accept-Language 请求头。
cURL 请求
bash
curl -X GET 'https://api.sandbox.travelandz.com/v1/transfers/reservations/:reservationId/vehicle?currency=USD' \
-H 'Authorization: Bearer YOUR_SECRET_KEY' \
-H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'请填写凭证以发送请求。
此请求需要来自上一次调用的标识符或令牌。请先运行前一个步骤,然后把它的值粘贴到这里。
响应
点击「试一试!」发送请求,响应将显示在此处。
查询分配给某个预订的司机和车辆。
认证和请求头
| 请求头 | 说明 |
|---|---|
Authorization | Bearer <secret_key>。密钥只能保存在服务器端,不能写入客户端日志。 |
X-Travelandz-Id | <public_key>:<profile_code>,持久化的 profile code 格式为 dp_<12 位字母数字>。 |
LANG | 推荐的语言请求头,也支持 Accept-Language。 |
Content-Type | 带 JSON body 的请求使用 application/json。 |
请求
此端点不接收请求体。reservationId 放在路径中。
请求参数结构
reservationIdReservation identifier returned when the booking was created.
请求查询参数模式
currencyLowercase values are accepted and normalized. Defaults to
USD on a new search and is inherited afterwards.languageLegacy field. Prefer the
LANG or Accept-Language header.成功响应
在完成分配前会省略 driver 和 vehicle,因此界面需要能处理只包含 status 的响应。
响应体结构
statusAssignment state, for example
active.driverdriveriddriverexternalIddrivernamedriverphonedriverlicenseNumberdriverimageUrlvehiclevehicleidvehicleexternalIdvehicletypevehiclemanufacturervehiclemodelvehicleplatevehiclecolorvehicledescriptionvehicleimageUrl响应示例
json
{
"status": "active",
"driver": {
"id": "123",
"externalId": "DRV456",
"name": "John Doe",
"phone": "+1234567890",
"licenseNumber": "AB123456",
"imageUrl": "https://cdn.example.com/drivers/driver123.jpg"
},
"vehicle": {
"id": "789",
"externalId": "VEH789",
"type": "Sedan",
"manufacturer": "Toyota",
"model": "Camry",
"plate": "XYZ1234",
"color": "Blue",
"description": "A blue Toyota Camry in excellent condition.",
"imageUrl": "https://cdn.example.com/vehicles/vehicle789.jpg"
}
}错误
| HTTP | 代码 | 含义 | 建议操作 |
|---|---|---|---|
400 | 请求体、查询参数或路径无效,或包含未知属性。 | 根据 message 数组修正请求。 | |
400 | transfer_invalid_currency | 该货币不在支持列表中。 | 使用受支持的货币。 |
400 | transfer_invalid_language | 请求的语言不受支持。 | 使用文档中列出的语言值之一。 |
429 | transfer_provider_error | 服务暂时被限流。 | 使用指数退避重试。 |
502 | transfer_provider_error | 请求无法完成。 | 不要假定成功。保留标识符,并在该操作可能已创建时查询预订。 |
使用说明
旅客打开预订时调用一次即可。如果需要在无用户操作时自动更新界面,请使用流式端点,而不要循环调用此端点。
cURL 示例
bash
curl --request GET \
--url "https://api.sandbox.travelandz.com/v1/transfers/reservations/f390daff1fdf4cccb19b7abd825dc011/vehicle?currency=USD" \
-H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
-H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"