01-基础资料.md 12 KB
基础资料
基础资料分类提供店铺、仓库、物流公司等基础数据的管理接口，共 9 个API。
接口列表
| 序号 | 接口名称 | Method | 说明 |
|---|---|---|---|
| 1 | 店铺查询 | foonsu.erp.shop.shopInfo |
查询店铺信息 |
| 2 | 仓库查询 | foonsu.erp.warehouse.list |
查询仓库信息 |
| 3 | 系统物流公司查询 | foonsu.erp.logisticsCompany.list |
查询系统物流公司 |
| 4 | 企业物流公司查询 | foonsu.erp.logisticsCompany.enterpriseList |
查询企业物流公司 |
| 5 | 批量新增/修改仓库 | foonsu.erp.warehouse.save |
批量新增或修改仓库 |
| 6 | 批量新增/修改店铺 | foonsu.erp.shop.save |
批量新增或修改店铺 |
| 7 | 查询店铺授权URL | foonsu.erp.shop.oauthURL |
获取店铺平台授权地址 |
| 8 | 查询店铺授权进度状态 | foonsu.erp.shop.asyncProcess |
查询店铺授权进度 |
| 9 | 店铺非标准授权 | foonsu.erp.shop.nonStandardAuth |
店铺非标准授权 |
1. 店铺查询
Method： foonsu.erp.shop.shopInfo
请求方式： POST
简要描述： 查询店铺信息
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| shopId | 否 | Long | 店铺ID |
| outShopIds | 否 | List[Long] | 外部店铺ID集合 |
| pageIndex | 否 | String | 默认 1 |
| pageSize | 否 | String | 默认 20，最大不超过 50 |
| modifyDateStart | 否 | Date | 修改时间开始 |
| modifyDateEnd | 否 | Date | 修改时间结束 |
| platformShopId | 否 | String | 平台店铺ID |
data(Object)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| total | Integer | 记录总数 |
| data | List[Object] | 集合参数响应 |
data(List)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| shopId | Long | 店铺id |
| outShopId | String | 外部店铺id |
| shopName | String | 店铺名称 |
| shopPlatformCode | String | 店铺平台编号 |
| nickName | String | 卖家账号 |
| accessTokenExpiredTime | Date | 授权到期时间 |
| createDate | Date | 创建时间 |
| status | String | 状态：0-停用 1-启用 |
| modifyDate | Date | 修改时间 |
| shopCode | String | 店铺编码 |
| platformShopId | String | 平台店铺ID |
| authorizationFlag | String | 1-已授权，否则未授权 |
| serviceExpirationTime | Date | 服务到期时间 |
返回示例
{
"errorCode": null,
"msg": "操作成功",
"data": {
"total": 1,
"data": [{
"shopId": 9900100000000136,
"shopName": "淘宝-小小白5101",
"shopPlatformCode": "01",
"accessTokenExpiredTime": "2020-10-15 06:00:00",
"nickName": "小小白5101",
"status": "1",
"createDate": "2019-06-28 15:39:30",
"modifyDate": "2020-05-19 12:28:01",
"shopCode": "SP1B15805655077888",
"serviceExpirationTime": "2028-10-15 00:00:00"
}]
},
"date": null,
"version": null,
"success": true
}
2. 仓库查询
Method： foonsu.erp.warehouse.list
请求方式： POST
简要描述： 查询仓库信息
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| pageIndex | 否 | Integer | 页码，默认 1 |
| pageSize | 否 | Integer | 每页大小，默认 20，最大不超过 50 |
| modifyDateStart | 否 | Date | 开始时间 |
| modifyDateEnd | 否 | Date | 结束时间 |
| timeStatus | 否 | String | 搜索时间类型：0-创建时间；1-修改时间；默认 1 |
| status | 否 | String | 仓库启用状态：0-禁用；1-启用 |
| warehouseName | 否 | String | 仓库名称 |
| warehouseId | 否 | Long | 仓库ID |
data(List)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| warehouseId | Integer | 仓库Id |
| warehouseName | String | 仓库名称 |
| warehouseAddress | String | 仓库地址 |
| remark | String | 备注 |
| createDate | Date | 创建时间 |
| modifyDate | Date | 修改时间 |
| linkman | String | 联系人 |
| phone | String | 联系电话 |
| mobile | String | 联系手机 |
| warehouseTypeId | Long | 仓库类型 |
| district | String | 地区信息 |
| status | String | 启用状态 |
3. 系统物流公司查询
Method： foonsu.erp.logisticsCompany.list
请求方式： POST
简要描述： 查询系统支持的物流公司列表
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| pageIndex | 否 | Integer | 第几页，从1开始 |
| pageSize | 否 | Integer | 默认 20，最大不超过 50 |
data(List)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| logisticsCompanyCode | String | 快递公司编码，ERP唯一 |
| logisticsCompanyNameZh | String | 快递公司名称 |
4. 企业物流公司查询
Method： foonsu.erp.logisticsCompany.enterpriseList
请求方式： POST
简要描述： 查询企业自定义的物流公司列表
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| pageIndex | 否 | Integer | 第几页，从1开始 |
| pageSize | 否 | Integer | 默认 20，最大不超过 50 |
| logisticsCompanyId | 否 | Long | 企业物流公司ID |
| status | 否 | String | 状态：1-启用；0-停用 |
data(List)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| logisticsCompanyId | Long | 快递公司ID |
| systemLogisticsCompanyCode | String | 快递公司编码，ERP唯一 |
| logisticsCompanyName | String | 快递公司名称 |
| status | String | 状态：1-启用；0-停用 |
5. 批量新增/修改仓库
Method： foonsu.erp.warehouse.save
请求方式： POST
简要描述： 批量新增或修改仓库，根据 outWarehouseId 判断新增或更新
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| data | 是 | List[Object] | 仓库数据集合 |
data(List[Object]) 参数说明
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| outWarehouseId | 是 | Long | 外部仓库ID（唯一） |
| warehouseName | 是 | String | 仓库名称（唯一） |
| warehouseCode | 否 | String | 仓库编码 |
| warehouseTypeName | 否 | String | 仓库类型名称（系统存在自动匹配，不存在自动创建。不传值会新建"默认类型"的仓库类型并匹配上） |
| linkman | 是 | String | 联系人 |
| phone | 是 | String | 手机 |
| mobile | 是 | String | 电话 |
| province | 是 | String | 省份 |
| city | 是 | String | 城市 |
| district | 是 | String | 市/区 |
| address | 是 | String | 地址 |
| isPeriod | 否 | String | 是否关账仓库：0-否，1-是，默认 0 |
| isNegativeInventory | 否 | String | 是否允许负库存：0-否，1-是，默认 0 |
| remark | 否 | String | 备注 |
| distributorsId | 否 | Long | 经销商ID |
data[Object]返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| totalCount | Integer | 总的条数 |
| updateCount | Integer | 更新的条数 |
| insertCount | Integer | 插入的条数 |
| failCount | Integer | 失败的条数 |
| errorMsgList | List[Object] | 错误数据的具体报错信息，有则返回，无则为null |
errorMsgList 返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| failOutId | String | 失败的外部仓库ID |
| errorMsg | String | 失败信息 |
| errorCode | String | 失败编码 |
6. 批量新增/修改店铺
Method： foonsu.erp.shop.save
请求方式： POST
简要描述： 批量新增或修改店铺，根据 outShopId 判断新增或更新
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| data | 是 | List[Object] | 店铺数据集合 |
data(List[Object]) 参数说明
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| outShopId | 是 | String | 外部店铺ID（唯一） |
| shopName | 是 | String | 店铺名称 |
| linkman | 否 | String | 联系人 |
| phone | 否 | String | 手机 |
| mobile | 否 | String | 电话 |
| province | 否 | String | 省份 |
| city | 否 | String | 城市 |
| district | 否 | String | 市/区 |
| address | 否 | String | 地址 |
| customCode | 否 | String | 店铺编码 |
| deduction | 否 | BigDecimal | 扣点，百分之一传 0.01 |
| stockPushAddress | 否 | String | 库存修改推送地址 |
| deliveryPushAddress | 否 | String | 发货信息推送地址 |
| routePushAddress | 否 | String | 路由信息推送地址 |
| presellType | 否 | String | 预售类型：0-不下载；1-下载，默认 0 |
| providerIds | 否 | String | 供应商Id集合 |
| remark | 否 | String | 备注 |
| autoMatchWhileDownload | 否 | String | 自动匹配商品：0-否；1-是，默认 0 |
data[Object]返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| totalCount | Integer | 总的条数 |
| updateCount | Integer | 更新的条数 |
| insertCount | Integer | 插入的条数 |
| failCount | Integer | 失败的条数 |
| errorMsgList | List[Object] | 错误数据的具体报错信息，有则返回，无则为null |
| successShopInfoList | List[Object] | 成功的数据集合，有则返回，无则为null |
errorMsgList 返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| failOutId | String | 失败的外部店铺ID |
| errorMsg | String | 错误信息 |
| errorCode | String | 错误编码 |
successShopInfoList 返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| shopId | Long | 企得宝的店铺ID |
| shopName | String | 店铺名称 |
| customCode | String | 店铺编码 |
| state | String | 新增还是修改：added新增，modified修改 |
7. 查询店铺授权URL
Method： foonsu.erp.shop.oauthURL
请求方式： POST
简要描述： 获取店铺在平台的授权URL，用于店铺授权流程
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| shopPlatformCode | 是 | String | 店铺平台编码，例如抖店：43 |
data(Object)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| request | String | 请求ID，用于查询授权进度 |
| authorizationCodeURL | String | 平台授权地址 |
8. 查询店铺授权进度状态
Method： foonsu.erp.shop.asyncProcess
请求方式： POST
简要描述： 查询店铺授权进度状态
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| requestId | 是 | String | 请求ID，由查询店铺授权URL接口返回 |
data(Object)返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| status | String | 0-等待授权；1-成功；-1-失败 |
| shopId | String | 平台店铺ID |
| shopName | String | 平台店铺名称 |
| msg | String | 描述信息 |
9. 店铺非标准授权
Method： foonsu.erp.shop.nonStandardAuth
请求方式： POST
简要描述： 店铺非标准授权
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| platformShopId | 是 | String | 平台店铺ID（平台提供） |
| shopPlatformCode | 是 | String | 店铺平台编码，例如视频号：B5 |
返回参数
data 为 String 类型，成功返回 "授权成功"，失败为 null。