DELETE/v1/transfers/reservations/:reservationId

取消接送预订

取消预订并查看退款结果。

分享
DELETE/v1/transfers/reservations/:reservationId

API 控制台

试一试

向沙箱 API 发送真实请求并查看响应。

凭证

登录后即可从已保存的 API 密钥中选择，无需手动粘贴。

路径参数

1 个字段

预订 ID

创建预订时返回的预订标识符。在统一详情端点中，reservationId、confirmationNumber、searchId 三者只能发送其中一个。

查询参数

2 个字段

货币

返回金额所用的货币。若已存在报价或预订，必须与其保持一致。

语言

旧版语言字段。建议使用 LANG 或 Accept-Language 请求头。

cURL 请求

cURL
bash
curl -X DELETE 'https://api.sandbox.travelandz.com/v1/transfers/reservations/:reservationId?currency=USD' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'

请填写凭证以发送请求。

此请求需要来自上一次调用的标识符或令牌。请先运行前一个步骤，然后把它的值粘贴到这里。

响应

点击「试一试！」发送请求，响应将显示在此处。

取消预订并查看退款结果。

认证和请求头

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

请求

此端点不接收请求体。reservationId 放在路径中。若发送 currency，必须与该预订实际收费的货币一致。

请求参数结构

reservationId
string是
Reservation identifier returned when the booking was created.

请求查询参数模式

currency
enum
EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN
否
Lowercase values are accepted and normalized. Defaults to USD on a new search and is inherited afterwards.
language
enum
en-USes-ESde-DEfr-FRpt-BRzh-CNit-IT
否
Legacy field. Prefer the LANG or Accept-Language header.

成功响应

返回预订是否已取消以及是否适用退款。退款遵循报价中展示的取消政策。

cancelled: false 和 refunded: false 是有效的 HTTP 200 结果，而不是错误。请始终读取这两个字段，不要只依赖状态码。

响应体结构

cancelled
boolean是
False is a valid HTTP 200 outcome.
refunded
boolean是
False is a valid HTTP 200 outcome.
refundAmount
number否
Amount refunded to the traveller.
currency
enum
EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN
否
refundPercent
number否

响应示例

json
json
{
  "cancelled": true,
  "refunded": true,
  "refundAmount": 181.97,
  "currency": "USD",
  "refundPercent": 100
}

错误

HTTP代码含义建议操作
400请求体、查询参数或路径无效，或包含未知属性。根据 message 数组修正请求。
400transfer_invalid_currency该货币不在支持列表中。使用受支持的货币。
400transfer_invalid_language请求的语言不受支持。使用文档中列出的语言值之一。
429transfer_provider_error服务暂时被限流。使用指数退避重试。
502transfer_provider_error请求无法完成。不要假定成功。保留标识符，并在该操作可能已创建时查询预订。
400transfer_currency_mismatch货币与报价、报价单或预订不一致。复用上一步返回的货币，或省略该字段以继承它。
503当前无法确认价格。稍后重试。不要预订，也不要向旅客收费。

使用说明

当 refunded 为 true 时，请将 refundAmount 与同一响应中返回的 currency 一起展示。请在旅客预订前查看报价的取消政策，以免退款结果出人意料。

cURL 示例

bash
bash
curl --request DELETE \
  --url "https://api.sandbox.travelandz.com/v1/transfers/reservations/f390daff1fdf4cccb19b7abd825dc011?currency=USD" \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"