批量同步接口
- 接口:/common/commodities/v2/batch
- Method:POST
- 数据格式:JSON
- 限流信息:100次每天和50次每小时
- 多语言环境:在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
- 接口说明:该接口用作商品的批量同步,在整批数据中如果只有几条数据因为其他原因失败,那么只有这几条数据不会被处理,其他数据仍会被正常处理
- 其他补充信息:单次数据量过大时候(超过200条)会全部转为异步处理,具体参考回调示例
参数:
请求参数
字段名称 |
字段类型 |
字段描述 |
是否必填 |
长度限制(字节) |
bizId |
String |
当前次接口同步的唯一标识 |
TRUE |
36 |
timestamp |
long |
当前次接口同步对应的时间戳 |
TRUE |
13 |
data |
Array |
当前次接口同步的数据集合 |
TRUE |
无 |
data.code |
String |
商品信息唯一编码 |
TRUE |
32 |
data.tax_commodity_code |
String |
商品税收编码 |
TRUE |
64 |
data.name |
String |
商品名称 |
TRUE |
64 |
data.unit_code |
String |
商品单位代码 |
TRUE |
64 |
data.tax_code |
String |
商品税率 |
TRUE |
64 |
data.abbreviation |
String |
商品信息的简称 |
FALSE |
64 |
data.price |
BigDecimal |
商品单价 |
FALSE |
65 |
data.description |
String |
商品描述信息 |
FALSE |
64 |
data.specification |
String |
商品的规格型号 |
FALSE |
64 |
data.enabled_flag |
String |
商品信息是否被启用(Y/N,默认为Y) |
FALSE |
1 |
data.deleted_flag |
String |
是否删除的标识(Y/N,默认为N) |
FALSE |
1 |
返回参数
字段名称 |
字段类型 |
字段描述 |
bizId |
String |
当前次接口同步的唯一标识 |
resCode |
Integer |
响应状态码(见附录) |
resMsg |
String |
返回信息描述 |
created |
String |
创建成功的条数 |
updated |
String |
更新成功的条数 |
validatorErrors |
Array |
字段强校验不合格的数据 |
dbErrors |
Array |
数据持久化时出现错误的数据 |
warnings |
Array |
字段弱校验不合格的数据,任会做同步处理 |
示例:
请求数据
{
"bizId" : "c40f1bf0-e757-4a72-8863-fd6749821584",
"timestamp" : 1591266599229,
"data" : [ {
"code" : "code1",
"unit_code":"003111111",
"abbreviation" : "商品信息的简称1",
"tax_commodity_code" : "1000000000000000000",
"name" : "商品名称1",
"description" : "商品的描述信息1",
"specification" : "商品的规格型号1",
"price" : 200,
"tax_code" : "VAT6%",
"enabled_flag" : "Y",
"deleted_flag": "N"
},{
"code" : "code2",
"unit_code":"003",
"abbreviation" : "商品信息的简称2",
"tax_commodity_code" : "1000000000000000000111111",
"name" : "商品名称2",
"description" : "商品的描述信息2",
"specification" : "商品的规格型号2",
"price" : 200,
"tax_code" : "VAT6%",
"enabled_flag" : "Y",
"deleted_flag": "N"
},{
"code" : "code3",
"unit_code":"003",
"abbreviation" : "商品信息的简称3",
"tax_commodity_code" : "1000000000000000000",
"name" : "商品名称3",
"description" : "商品的描述信息3",
"specification" : "商品的规格型号3",
"price" : 200,
"tax_code" : "VAT6%11111111",
"enabled_flag" : "Y",
"deleted_flag": "N"
},{
"code" : "code4",
"unit_code":"003",
"abbreviation" : "商品信息的简称4",
"tax_commodity_code" : "1000000000000000000",
"name" : "商品名称4",
"description" : "商品的描述信息4",
"specification" : "商品的规格型号4",
"price" : 200,
"tax_code" : "VAT6%",
"enabled_flag" : "Y",
"deleted_flag": "N"
},{
"code" : "code5",
"unit_code":"003",
"abbreviation" : "商品信息的简称5",
"tax_commodity_code" : "1000000000000000000",
"name" : "商品名称5",
"description" : "商品的描述信息5",
"specification" : "商品的规格型号5",
"price" : 200,
"tax_code" : "VAT6%"
}]
}
返回数据
{
"resCode": 200000,
"resMsg": "success",
"bizId": "c40f1bf0-e757-4a72-8863-fd6749821584",
"data": {
"validatorErrors": [
{
"code": "code1",
"messages": [
"单位编码003111111不存在"
]
},
{
"code": "code3",
"messages": [
"商品的税率VAT6%11111111不存在"
]
},
{
"code": "code2",
"messages": [
"税收商品编码1000000000000000000111111不存在"
]
}
],
"created": "此次请求新建成功了0条数据",
"warnings": [],
"dbErrors": [],
"updated": "此次请求更新成功了2条数据"
}
}