供应商同步
- 接口:common/suppliers/v2/batch
- Method:POST
- 数据格式:JSON
- 200次每天和50次每小时
- 接口说明:供应商批量同步接口
- 在整批数据中若由于某些原因导致几条数据处理失败,失败数据不会被同步,其他数据仍会正常同步
- 单次数据量过大(超过200条)时会全部转为异步处理,具体参考回调示例
- 多语言设置:请求头(Headers)中添加KEY为locale,VALUE取语言参数其中之一:zh_CN(中文简体)、en_US(英文)、ja_JP(日文)、zh_TW(中文繁体)的Header参数
请求参数
字段名称 |
字段类型 |
字段描述 |
是否必填 |
长度 |
bizId |
String |
当前接口同步的唯一标识 |
true |
36 |
timestamp |
Number |
当前接口同步的对应时间戳 |
true |
13 |
data |
Array<Object> |
当前接口同步的数据集合 |
true |
/ |
data.code |
String |
供应商代码 |
true |
64 |
data.supplier_name |
String |
供应商名称 |
true |
255 |
data.enabled_flag |
String |
启用标志(Y/N,新增时默认为Y) |
false |
1 |
data.branch_code_flag |
String |
是否设置所属分公司标志(Y/N,默认为Y,置为N则清空当前分公司配置,重置为默认状态即所有分公司可用) |
false |
1 |
data.branch_code |
Array<String> |
所属分公司代码集合(branch_code_flag为Y时生效,集合为空时仍为默认状态即所有分公司可用) |
false |
/ |
data.city |
String |
供应商所属城市 |
false |
64 |
data.state |
String |
供应商所属省份 |
false |
64 |
data.country |
String |
供应商所属国家 |
false |
64 |
data.postal_code |
String |
供应商地区对应的邮政编码 |
false |
64 |
data.contact_person |
String |
供应商联系人 |
false |
64 |
data.contact_phone |
String |
供应商联系电话 |
false |
64 |
data.contact_email |
String |
供应商邮件地址 |
false |
64 |
data.contact_address |
String |
供应商联系地址 |
false |
255 |
data.contact_postal_code |
String |
供应商联系人邮政编码 |
false |
64 |
data.tax_number |
String |
供应商纳税人识别号 |
false |
64 |
data.legal_representative |
String |
供应商法人姓名 |
false |
64 |
column1-column50 |
String |
column字段信息 |
false |
255 |
请求示例
{
"bizId": "dbe1c496-0d51-415e-87a5-ed104dea597f",
"timestamp": 1636600092809,
"data": [
{
"code": "test",
"supplier_name": "上海xx进出口有限公司",
"enabled_flag": "Y",
"branch_code_flag": "Y",
"branch_code": [
"B004",
"B009"
],
"city": "上海",
"state": "上海",
"country": "中国",
"postal_code": "32345",
"contact_person": "李帅帅",
"contact_phone": "2345",
"column1": "自定义测试"
},
{
"code": "c3",
"enabled_flag": "N",
"branch_code_flag": "N"
}
]
}
返回参数
字段名称 |
字段类型 |
字段描述 |
resCode |
Number |
响应状态码(见附录) |
resMsg |
String |
返回信息描述 |
bizId |
String |
当前接口同步的唯一标识 |
created |
String |
创建成功的条数 |
updated |
String |
更新成功的条数 |
validatorErrors |
Array |
字段强校验不合格的数据 |
warnings |
Array |
字段弱校验不合格的数据,仍会做同步处理 |
dbErrors |
Array |
数据持久化时出现错误的数据 |
返回示例
{
"resCode": 200000,
"resMsg": "success",
"bizId": "dbe1c496-0d51-415e-87a5-ed104dea597f",
"data": {
"validatorErrors": [
{
"code": "c3",
"messages": [
"供应商的名称不能为空"
]
}
],
"created": "此次请求新建成功了0条数据",
"warnings": [],
"dbErrors": [],
"updated": "此次请求更新成功了1条数据"
}
}