修改/新增商品V2
接口描述
修改/新增商品V2。支持新增/修改普通商品、加工商品、套件商品、组合商品
系统相关界面
"界面路径:【商品】----【商品档案V2】----【新建】/【编辑】"
请求地址
环境 | 服务地址(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.item.general.addorupdate
必填
请求参数
参数名
类型
描述
必填
itemRequestType
integer
商品类型(0-普通商品,1-加工 2-套件 3-组合),除了普通商品类型,其他类型的商品都需要填写“单品”字段的值。注意:新增时为必填,修改时为非必填
outerId
string
平台商家编码(主商家编码)
必填
title
string
商品名称
必填
skus
array
sku 列表(含规格时必填)
propertiesName
string
规格真正的属性,包括颜色属性、其他属性、第三属性、第四属性,以分号分隔,如:“红色;XL”
必填
outerId
string
sku级别的规格商家编码
必填
id
long
平台skuID
barcode
string
规格条形码(如果要更新为空,则传入字符串“empty”)
weight
double
重量(单位:Kg),示例:0.05
purchasePrice
double
成本价(单位:元),示例:100.99
sellingPrice
double
销售价(单位:元),示例:100.99
wholesalePrice
double
批发价(单位:元),示例:100.99
picPath
string
sku的图片地址
propertiesAlias
string
规格别名
sellerCids
string
规格分类ID
itemCategoryNames
string
规格分类名称,多个用逗号隔开; 支持指定多级分类 , 格式:[["一级分类","二级分类","三级分类"],["一级分类","二级分类","三级分类1"]]
brandId
string
规格品牌ID
brand
string
规格品牌名称
remark
string
规格备注
skuComponent
string
规格成分
marketPrice
double
规格市场价(单位:元),示例:100.99
otherPrice1
double
规格其他价格1(单位:元),示例:100.99
otherPrice2
double
规格其他价格2(单位:元),示例:100.99
otherPrice3
double
规格其他价格3(单位:元),示例:100.99
controlPurchase
boolean
是否维护历史成本价:默认为false,不维护历史成本价
uniqueCodeType
integer
唯一码类型 * 0-弱唯一码 * 1-强唯一码
activeStatus
boolean
商品状态,true-启用,false-停用
simpleSuiteBridgeModels
array
sku级别的单品(与外层单品二选一填写)
sysItemId
long
系统主商品ID
sysSkuId
long
系统商品skuID
ratio
integer
比例,数量
safekind
string
安全类别
standard
string
执行标准
place
string
产地
suppliers
array
code
string
供应商编码
必填
itemTitle
string
供应商商品名称
itemOuterId
string
供应商的商品商家编码
caigouUrl
string
采购链接
discountRate
double
折扣率(不大于100不小于等于0的数字)示例 98.88
returnRate
double
退货率或采退率 (不大于100不小于等于0的数字)示例 6.67
supplierPurchasePrice
double
供应商报价信息(进价)(不大于9999999.99不小于0的数字) 示例 98.88
skuCustomAttribute
array
规格自定义属性 格式 :{definedKey:key1,definedValue:value1}
definedKey
string
规格自定义属性名称
definedValue
string
规格自定义属性值
shortTitle
string
商品简称
barcode
string
商品条形码(当用户开启一品双码时,企业数据全局唯一,不能和商家编码重复)
id
long
系统主商品ID (有值表示修改已存在的商品)
catId
sting
商品类目属性ID
itemCatName
string
商品类目名称,各类目层级中如果没有重复可以只传商品类目名称; 支持指定多级类目,类目层级格式:["根类目","一级类目","二级类目","三级类目"]
sellerCids
string
商品分类ID
itemCategoryNames
string
商品分类名称,各分类层级中如果没有重复可以只传商品分类名称,多个 分类用逗号隔开; 支持指定多级分类,分类层级格式:[["一级分类","二级分类","三级分类","四级分类1"],["一级分类","二级分类","三级分类","四级分类2"]]
picPath
string
预览图片URL
brandId
long
商品品牌ID (通过品牌接口去查询)
brand
string
商品品牌名称
purchasePrice
double
成本价(单位:元),示例:100.99
sellingPrice
double
销售价(单位:元),示例:100.99
weight
double
商品重量(单位:Kg), 示例:0.05
remark
string
商品备注
washLabels
arrayString
水洗唛列表
id
long
水洗唛id
必填
sourceType
int
水洗唛类型 0:系统, 1:自定义
必填
productFeature
int
申报产品特性 0:普货,1:带电池,2:侵权,3:带磁,4:非液体(化妆品),5:液体(化妆品),6:液体(非化妆品),7:粉末,8:膏体
makeGift
boolean
是否标记为赠品(默认为false)
periodCast
integer
保质期(单位:天)
unit
string
商品单位 ,示例:件、箱
x
double
长(单位:cm) ,示例:0.01
y
double
宽(单位:cm) ,示例:0.01
z
double
高(单位:cm) ,示例:0.01
wholesalePrice
double
批发价(单位:元),示例:100.99
invoice
string
开票名称
boxnum
integer
箱规
place
string
产地
component
string
成分
standard
string
执行标准
safekind
string
安全类别
marketPrice
double
市场价(单位:元)
otherPrice1
double
其他价格1(单位:元)
otherPrice2
double
其他价格2(单位:元)
otherPrice3
double
其他价格3(单位:元)
listTime
string
上架时间 格式为:yyyy-MM-dd HH:mm:ss
customAttribute
array
自定义属性信息 最多10对属性 kv的map,格式 :{definedKey:key1,definedValue:value1}
definedKey
string
属性名称
必填
definedValue
string
属性值
activeStatus
boolean
商品状态,true-启用,false-停用(会影响下面所有规格的状态)
simpleSuiteBridgeModels
array
单品(与sku层面的单品二选一填写)
sysItemId
long
系统主商品ID
sysSkuId
long
系统商品skuID
ratio
integer
比例,数量
uniqueCodeType
integer
唯一码类型 * 0-弱唯一码 * 1-强唯一码
suppliers
array
code
string
供应商编码
必填
caigouUrl
string
采购链接
discountRate
double
折扣率(不大于100不小于等于0的数字)示例 98.88
returnRate
double
退货率或采退率 (不大于100不小于等于0的数字)示例 6.67
itemTitle
string
供应商商品名称
itemOuterId
string
供应商的商品商家编码
supplierPurchasePrice
double
供应商报价信息(进价)(不大于9999999.99不小于0的数字) 示例 98.88
请求示例
示例一:
{
"id": long,
"outerId": "string",
"barcode": "string",
"skus": "[{\"id\":1,\"propertiesName\":\"string\"}]",
"title": "string",
"shortTitle": "string",
"catId": long,
"brandId": long,
"brand": "string",
"purchasePrice": double,
"sellingPrice ": double
}
响应参数
参数名
类型
描述
必填
skus
array
sku列表
必填
sysSkuId
long
系统商品skuID
必填
skuOuterId
string
平台商家编码
必填
code
string
返回码
必填
trace_id
string
流水id
必填
outerId
string
平台商家编码
必填
id
long
系统主商品ID
必填
success
boolean
true-成功,false-失败
必填
响应示例
{
"msg": "zhangsan",
"traceId": "zhangsan",
"code": "zhangsan",
"skus": [
{
"sysSkuId": 12345,
"skuOuterId": "zhangsan"
}
],
"solution": "zhangsan",
"subCode": "zhangsan",
"outerId": "zhangsan",
"subMsg": "zhangsan",
"id": 12345,
"body": "zhangsan",
"forbiddenField": "zhangsan"
}
异常示例
{
"code": "25",
"msg": "服务方法(erp.item.general.addorupdate:1.0)的签名无效",
"success": false,
"trace_id": "3553483395423660"
}