跳到主要内容

订单作废接口

接口描述​

订单作废接口,作废订单状态范围:待付款,待审核,等待财审,等待人工审核,审核完成,待打印快递单,待打印发货单,待打包,待称重,待发货,待供销商发货

系统相关界面​

"界面路径：【交易】----【订单管理】----【作废订单】"

请求地址​

环境服务地址(HTTP/HTTPS)
V2正式环境（推荐）https://gw.superboss.cc/router

2022年4月1日以后申请的APP Key，统一使用V2正式环境的请求地址：https://gw.superboss.cc/router

公共参数​

调用任何一个API都必须传入的参数，目前支持的公共参数有：

参数名称参数类型是否必须参数描述
methodstring是API接口名称
appKeystring是分配给应用的AppKey
timestampstring是时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟
formatstring否响应格式。默认为json格式，可选值：json
versionstring是API协议版本 可选值：1.0
sign_methodstring否签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。
signstring是签名
sessionstring是授权会话信息 （即access_token，由系统分配）

请求头​

参数名
类型
描述
必填
Content-Type
string
application/x-www-form-urlencoded;charset=UTF-8
必填

API接口地址​

参数名
类型
描述
必填
method
string
erp.trade.cancel
必填

请求参数​

参数名
类型
描述
必填
sids
string
系统订单号,多个逗号隔开，选填:平台订单号二选一，优先系统订单号
tids
string
平台订单号,多个逗号隔开，选填:系统订单号二选一，优先系统订单号

请求示例​

示例一：

{
  sids:"1,2,3"
}

示例二：

{
  tids:"1,2,3"
}

响应参数​

参数名
类型
描述
必填
successIds
long[]
成功id集合
failedIds
long[]
失败id集合
success
boolean
示例：true
trace_id
string
示例：3553483395407017

响应示例​

{
  "successIds": long[],
  "failedIds": long[],
  "success": "boolean",
  "trace_id": "long"
}

异常示例​

{
    "code": "25",
    "msg": "服务方法(erp.trade.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}

错误码解释​

错误信息错误码解决方案
资源异常,请联系管理员!400检查参数是否合法
非法参数!50检查参数类型等是否合法
系统订单号数量最大支持20组！20005参数过长
系统订单号数量最大支持20组!20009参数过长
系统订单号和平台订单号不能同时为空!20010
系统订单号格式不正确！20009检查参数是否合法
平台订单号格式不正确20010检查参数是否合法
订单作废失败30079请根据返回的错误信息进行处理