取消&拦截接口
基本信息
请求方式 | Post application/x-www-form-urlencoded |
---|---|
功能描述 | 商家在揽收前取消包裹及揽收后下发拦截指令功能 |
编码 | UTF-8 |
入参
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
对接码 | logistic_provider_id | String | 是 | 菜鸟侧提供 |
签名 | data_digest | String | 是 | Base64(Md5(logistics_interface+双方约定的secretKey)),0.2 签名方法 |
业务报文 | logistics_interface | String | 是 | JSON |
logistics_interface内容
项目 | 名称 | 类型 | 必填 | 描述 |
---|---|---|---|---|
运单号 | mailNo | String | 是 | 示例:20140804138802 |
取消原因 | remark | String | 是 | 示例:不需要寄了 |
取消类型 | cancelType | String | 是 | 示例:WAYBILL |
扩展信息 | feature | Map<String,String> | 否 |
出参
项目 | 名称 | 类型 | 必填 |
---|---|---|---|
成功标识 | success | boolean | 是 |
错误码 | errorCode | String | 否 |
错误说明 | errorMsg | String | 否 |
示例报文
url:
http://edi-daily.xpm.cainiao.com/ext/gateway/ediStandardCancelOrIntercept/api
请求: 仅供参考,实际测试账号需联系菜鸟速递开发提供
logistic_provider_id: edi_test_gongpei_json
data_digest: a4drgzJuYyrgFwY/BdWRWQ==
logistics_interface:
{"mailNo":"test1235565","cancelType":"WAYBILL","remark":"不需要寄了"}
返回:
{
"success": true,
"errorCode": "",
"errorMsg": ""
}
附录
取消类型说明
取消类型名称 | 取消类型编码 | 备注 |
---|---|---|
整单取消 | ORDER | |
单元取消 | UNIT | |
揽件单元取消 | COLLECT_UNIT | |
运单取消 | WAYBILL | |
揽件单申请取消 | COLLECT_APPLY |