取消订单接口
更新时间: 2022-10-17 必须接入 在线调试(沙箱环境)
接口概述
1、该接口用来取消指定供应商的用车订单。
2、如果携程未收到确认信息,携程会持续重试3次,每次间隔5秒。3次都无信息则该订单默认取消。因此,供应商接口需要根据ctripPurchaseOrderId字段支持幂等(同一个ctripPurchaseOrderId多次调用返回首次处理成功的结果)。
3、性能要求:从携程发起请求必须在2000ms以内返回信息。
请求地址
地址格式: {Domain}/{Channel}/ordercancel/2.0/{timeStamp}/{sign}
请求内容
CancelOrderRequest
参数 | 类型 | 必传 | 描述 | 示例 | 备注 |
---|---|---|---|---|---|
ctripPurchaseOrderId | Long | 是 | 携程采购单号 | 881823967638342968 | 18位 |
vendorOrderId | String | 是 | 供应商订单id | ||
cancelReason | String | 是 | 取消原因 | ||
force | Boolean | 否 | 是否强制取消 | 为true时取消订单,false时查询取消费。(对接前请联系商务确定取消规则)</br>注1:仅打车场景下有值 | |
cancelFee | BigDecimal | 否 | 取消费 | ||
serviceProviderId | Long | 否 | 服务商ID | 1000000 | 用于多服务商接入场景,需要的供应商请联系我方技术添加 |
返回内容
CancelOrderResponse
参数 | 类型 | 必传 | 描述 | 示例 | 备注 |
---|---|---|---|---|---|
msgCode | String | 是 | 响应码 | OK | 响应码 |
message | String | 否 | 响应详情 | 成功 | 响应码 |
cancelFee | BigDecimal | 否 | 取消费 | 仅在查询取消费时需要返回 | |
success | Boolean | 否 | 是否取消成功 | 仅打车产线需要返回 |
请求示例
{
"ctripPurchaseOrderId": 881888888888888888,
"vendorOrderId": "2022022022",
"cancelReason": "用户取消"
}
响应示例
{
"msgCode": "OK",
"message": "成功",
}
异常示例
{
"msgCode": "ERROR_NO_ORDERID",
"message": "找不到订单"
}