取消同城配送订单技术文档
一、同城配送取消下单接口
对下完单的订单进行取消操作
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://order.kuaidi100.com/sameCity/order
请求参数：
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| method | 是 | string | 业务类型（默认：cancel） |
| key | 是 | string | 授权码，请到快递100页面申请企业版接口获取 |
| sign | 是 | string | 32位大写，签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号。secret在企业管理后台获取 |
| t | 是 | string | 时间戳如：1576123932000 |
| param | 是 | param | 由其他字段拼接 |
param数据结构：
| 参数名 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| taskId | 是 | string | 任务ID |
| orderId | 是 | string | 订单ID |
| cancelMsg | 是 | string | 取消原因，例：暂时不寄件了 |
1.3 返回结果
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| result | boolean | 提交结果 | true提交成功，false失败 |
| returnCode | string | 返回编码 | |
| message | string | 返回报文描述 | |
| data | data | 这里默认为空 |
1.4 提供数据内容
请求参数示例
method = cancel
key = *******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param ={
"taskId": "2B389A891A2C4AF8AB29927050DA52CC",
"orderId": "1000086",
"cancelMsg": "地址信息填错啦，重新下单"
}
返回结果示例
{
"returnCode": "200",
"result": true,
"message": "取消成功"
}
1.5 信息代码含义
| 信息代码 | 信息内容描述 | 原因及建议处理方式 |
|---|---|---|
| 200 | 成功 | 成功 |
| 500 | 取消失败 | 配送公司返回异常，失败原因见配送公司返回的错误信息 |
