新增工单商品
请求地址
| 环境 | 服务地址(HTTP/HTTPS) |
|---|---|
| V2正式环境(推荐) | https://gw.superboss.cc/router |
2022年4月1日以后申请的APP Key,统一使用V2正式环境的请求地址:https://gw.superboss.cc/router
公共参数
调用任何一个API都必须传入的参数,目前支持的公共参数有:
| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
|---|---|---|---|
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳,时区为GMT+8,例如:2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式,可选值:json |
| version | string | 是 | API协议版本 可选值:1.0 |
| sign_method | string | 否 | 签名的摘要算法(默认 hmac),可选值为:hmac,md5,hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 (即access_token,由系统分配) |
请求头
全部展开
参数名
类型
描述
必填
Content-Type
string
application/x-www-form-urlencoded;charset=UTF-8
必填
API接口地址
全部展开
参数名
类型
描述
必填
method
string
erp.aftersale.workorder.item.add
必填
请求参数
全部展开
参数名
类型
描述
必填
workOrderId
long
售后工单ID
必填
type
int
商品类型 1-退货商品 2-补发商品
必填
itemList
string
商品列表JSON字符串
必填
outerId
string
商家编码
必填
count
int
商品数量(必须大于0)
必填
goodItemCount
int
良品数量(销退入库时使用)
badItemCount
int
次品数量(销退入库时使用)
remark
string
商品备注
请求示例
{
"workOrderId": 1234567890,
"type": 1,
"itemList": "[{\"outerId\":\"SKU001\",\"count\":1,\"goodItemCount\":1,\"badItemCount\":0,\"remark\":\"商品备注\"}]"
}
响应参数
全部展开
参数名
类型
描述
必填
code
string
错误码
必填
msg
string
错误信息
必填
itemIds
array
新增成功的商品ID列表
必填
trace_id
string
示例:3553483395407017
必填
响应示例
{
"code": "",
"msg": "",
"itemIds": [1001, 1002],
"trace_id": "3553483395423660"
}
异常示例
{
"code": "25",
"msg": "服务方法(erp.aftersale.workorder.item.add:1.0)的签名无效",
"success": false,
"trace_id": "3553483395423660"
}
错误码解释
| 错误码 | 错误信息 | 解决方案 |
|---|---|---|
| content1 | content2 | content3 |
注意事项
- 商品数量(count)必须大于0
- 良品数量(goodItemCount) + 次品数量(badItemCount) 必须等于商品数量(count)
- 商品类型(type)必须为1(退货商品)或2(补发商品)