取消订单
说明
- 取消叫车订单,行程中的订单不能取消(司机一旦点击开始计费,订单将不能取消)
- 司机应答后,乘客取消订单需要强制取消,请求参数时force=true(默认为false),否则会取消失败
请求地址
/v1/order/Cancel
支持格式
Json或普通form
HTTP请求方式
Post
是否需要登录
是
关于登录授权,参见 如何登录授权
访问授权限制
暂无
请求参数
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
client_id | string | yes | 申请应用时分配的AppKey |
access_token | string | yes | 授权后的access token |
timestamp | int | yes | 当前时间戳 |
sign | string | yes | 签名 详细算法参见 签名验证 章节 |
order_id | string | yes | 订单id |
force | enum | no | 是否强制取消(true 或 false)默认false |
注意事项
暂无
请求示例
方式一:
curl -X POST -H 'Content-Type: application/json' \
-d '{
"client_id": "testclient",
"access_token": "test",
"timestamp": "2867831074",
"sign": "test",
"order_id": "7640112764569538614",
"force": "true"
}' https://api.es.xiaojukeji.com/v1/order/Cancel
方式二:
curl -i -X POST -H "Content-type:application/x-www-form-urlencoded" \
-d "client_id=testclient" \
-d "access_token=test" \
-d "timestamp=2867831074" \
-d "sign=test" \
-d "order_id=7640112764569538614" \
-d "force=true" \
https://api.es.xiaojukeji.com/v1/order/Cancel
返回参数说明
错误码请参见 常见错误解决方案章节
返回值字段 | 字段类型 | 字段说明 |
---|---|---|
errno | int | 错误码 |
errmsg | string | 错误信息 |
data | object | data对象 |
data.cost | float | (非必返回字段)扣费金额,如果传force=false且此订单已被司机抢单,就会返回cost字段(此订单未被取消,有可能产生扣费,需要确认),这时如果要强制取消订单,需要再次请求此接口且传force=true,这时此订单会发生扣款(此订单强制取消)。 |
返回示例
{
"errno": 0,
"errmsg": "SUCCESS",
"data": null
}