跳到主要内容

上传备注与旗帜

系统相关界面

"界面路径:【交易】----【订单管理】"

请求地址

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

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

公共参数

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

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

请求头

全部展开
参数名
类型
描述
必填
Content-Type
string
application/x-www-form-urlencoded
必填

API接口地址

全部展开
参数名
类型
描述
必填
method
string
erp.trade.upload.memo.flag
必填

请求参数

全部展开
参数名
类型
描述
必填
memo
string
备注
必填
flag
long
旗帜 系统旗帜 0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红
必填
userId
long
店铺编号
必填
tid
string
平台订单号
必填

请求示例

示例一:

{
"tid":"string",
"userId":"long",
"flag":"long",
"memo":"string"
}

响应参数

全部展开
参数名
类型
描述
必填
success
boolean
示例:true
必填
trace_id
string
示例:3553483395407017
必填

响应示例

{ 
"success": boolean,
"trace_id": "long"
}

异常示例

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

错误码解释

错误码错误信息解决方案
50旗帜类型不合法![0(灰);1(红);2(橙);3(绿);4(蓝);5(紫)]请检查该参数是否有值
30009上传备注与旗帜缺少必要参数请检查入参是否有值
30010上传备注与旗帜失败请根据返回的错误信息进行处理