取消订单

方向:青云聚信系统→配送商系统

用途:取消订单,该接口必须可以将配送订单取消成功,取消订单需支持幂等。

请求参数:

字段 描述 是否必填 类型 示例值 规则
orderId 青云聚信平台订单号 string 长度为18-45个字符。
可作为唯一识别单号,建议配送商作为商家订单号使用。
carrierShopId 配送商门店id string
cancelReasonCode 取消原因code int 详细枚举见 附录-取消原因Code
cancelReasonDesc 取消原因说明 string 最长不超过256个字符

返回参数:

字段 描述 是否必填 类型 示例值 规则
code 结果code int 0 0:成功。
非0:失败,详情查看message字段
详细枚举见 附录-接口返回结果Code
message 失败的描述信息 string 成功
data 结果 map {"cancelFee":0.0} 如果取消成功则需要传入

取消扣费:

字段 描述 是否必填 类型 示例值 规则
cancelFee 取消扣费 double 如果未产生费用则传入0