跳到主要内容

订单挂起

系统相关界面​

"界面路径：【订单管理】"

请求地址​

环境服务地址(HTTP/HTTPS)
V2正式环境（推荐）https://gw.superboss.cc/router
V2测试环境https://gw3.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.halt
必填

请求参数​

全部展开
参数名
类型
描述
必填
默认值
sids
string
系统订单号,多个用逗号分隔，最多支持20组
系统订单号和平台订单号二选一
tids
string
平台订单号,多个用逗号分隔，最多支持20组
系统订单号和平台订单号二选一
autoUnHalt
int
是否开启自动解挂 0不开启 1开启 不开启则仅挂起
必填
unHaltType
int
解挂依据 0按订单挂起时间 1按承诺发货与揽收时间，如果是否开启自动解挂时间传值为1，那么该字段必填
haltTimeUnit
int
挂起时长单位 时间单位 1：分 2：小时 3：天 4：月 5：年，如果是否开启自动解挂时间传值为1，那么该字段必填
haltTimeVal
int
挂起时长 具体的时长，最大不超过999，如果是否开启自动解挂时间传值为1，那么该字段必填
isUrgent
int
自动解除后更新为加急订单 0不更新 1更新，如果是否开启自动解挂时间传值为1，那么该字段必填

请求示例​

示例一：

{
 "sids":"5058208293858409,5058208293858408",
 "autoUnHalt":0
}

响应参数​

全部展开
参数名
类型
描述
必填
successIds
array
成功id 集合
failedIds
array
失败id 集合
success
boolean
示例：true
trace_id
string
示例：3553483395407017

响应示例​

{
    "successIds":[5058208293858409],
    "failedIds":[5058208293858408],
    "traceId": "3669319614952014527",
    "success": true
}

异常示例​

{
    "traceId": "4071991477422416710",
    "msg": "失败",
    "code": "33",
    "success": false
}

错误码解释​

错误信息错误码解决方案
资源异常,请联系管理员!400检查参数是否合法
非法参数!50检查参数类型等是否合法
唯一码数量最大支持20组!20029参数过长