说明

商品、sku、库存、价格分开同步
库存和价格有门店的概念，其他没有
会员价门店不统一

场景

用户进入微店，展示商品、类目等信息

其中商品信息、类目信息先从erp同步到微店，首页展示的商品信息是调用微店的数据

这里需要一个同步商品、类目信息的接口（1）

进入商品详情页面，展示商品详细信息、SKU信息

其中商品详情是（1）获取的信息，sku需要先从erp同步到微店

这里需要一个同步商品sku是接口(2)

用户下单支付

因为是sku信息是先从erp同步到微店，并不是实时的，用户在详情页的时候，可能该商品库存已经没有了，但是因为还没有同步过来，下单的时候，需要调用erp，查看该商品是否有库存

这里需要一个查看商品sku的接口（3.1）

另外，由于现在微店可以使用购物卡，用户下单的时候，需要调用erp，来确定该用户在该门店是否有购物卡，以及购物卡相关金额

这里需要一个查看购物卡列表（根据需求文档，需要返回该用户的所有购物卡）(3.2)

下单到支付的期间，需要冻结库存，支付完成增加已售库存，取消订单回滚库存

需要提供一个库存相关的接口（3.3）

生成订单

生成订单后，需要将订单信息同步到erp

需要一个同步订单的接口（4.1）

订单状态改变

订单状态改变有如下两种情况

5.1. 微店改变状态（比如用户操作确认收货、下单），需要将订单状态从微店同步到erp。
5.2. erp改变订单状态（比如自提、退款），需要将订单状态从erp同步到微店

退货、退款

用户退款或者退货后，订单状态改变（5.1接口），微店没有退款退货逻辑，无须关心退款退货逻辑。在erp上完成退款操作后，将订单状态回传给我们即可（5.2接口）

几点疑问

因为以前有与erp对接，微店需求的相关接口是与之前的接口放在一起还是全部使用新的接口，技术双方还没有结论

目前微店这边相关数据表和之前是分开的，建议erp也分开，不然洋老板的数据和微店数据混合在一起，到时候排查问题会比较麻烦。如果有不同意见或者建议，请及时沟通

接口

类目列表接口

场景：用户进入微店首页的时候，可以进行目录与品牌筛选，需要从ERP获取类目属性
交互方式：ERP监听，微店调用
接口名称：catalog.list.get
接口描述：获取类目列表
参数：无，如果类目数据量过大，则可以用如下方式

{
"parentId":string //如果不传，返回所有类目信息，如果传入，则返回该目录下的直接子目录
}

返回结果

{
"code":200,
"msg":"success",
"success":true,
"data":[
{
"id": "类目ID(Varchar-Y)",
"name":"类目名称(Varchar-Y)",
"type":"1: 一级类目 2: 二级类目 3: 三级类目(TinyInt-Y)",
"parentId":"父id，一级类目parent_id 是字符串0(Varchar-Y)",
"createTime":"yyyy-MM-dd HH:mm:ss(datetime-N)",
"updateTime":"yyyy-MM-dd HH:mm:ss(datetime-N)",
},
{
"id": "类目ID(Varchar-Y)",
"name":"类目名称(Varchar-Y)",
"type":"1: 一级类目 2: 二级类目 3: 三级类目",
"parentId":"父id，一级类目parent_id 是字符串0",
"createTime":"yyyy-MM-dd HH:mm:ss",
"updateTime":"yyyy-MM-dd HH:mm:ss",
}
]
}

类目新增（编辑）接口，如果不好命名，可以分成两个接口

场景：ERP修改了类目信息，需要同步
交互方式：洋老板监听，ERP调用
接口名称：catalog.add_or_edit
接口描述：新增或修改类目，如果微店没有该类目，则新增，否则修改
参数：

{
"id":"类目ID(Varchar-Y)",
"name":"类目名称(Varchar-Y)",
"type":"1: 一级类目 2: 二级类目 3: 三级类目",
"parentId":"父id，一级类目parent_id 是字符串0",
"createTime":"yyyy-MM-dd HH:mm:ss",
"updateTime":"yyyy-MM-dd HH:mm:ss"
}

返回结果

{
"code":200,
"msg":"success",
"success":true
}

商品列表接口

场景：店铺商品都是从erp同步过来
交互方式：ERP监听，微店调用，每隔一段时间，微店发起同步请求
接口名称：prod.list.get
接口描述：erp同步商品列表到微店
参数：

{
"pageNum":1,
"pageSize":20,
"startUpdateTime":"yyyy-MM-dd HH:mm:ss", //这个参考的是之前商品同步，要确保erp修改商品后，修改时间会变化，否则就同步全量
"endUpdateTime":"yyyy-MM-dd HH:mm:ss",
}

返回结果

{
"code":200,
"msg":"success",
"data":{
"records":[
{
"prodId":"商品唯一标识(全局唯一，不能和其他商品ID重复，也不能和规格商品SkuId重复) -varchar(20)-y",//微店有一个id，是主键，是我们这边自动生成的，不知道后续是用哪个
"erpProdCode":"ERP商品编码-varchar(50)-y",
"catalogId":"所属三级类目id-varchar(20)-y",
"catalogChain":"类目链: 一级类目id-二级类目id-三级类目id- 比如 11-1123-112366,varchar(255)-y",
"brand":"品牌-varchar(255)-y",
"album":"商品图册,多个用逗号隔开,存图片相对地址-varchar(500)-y",
"description":"商品描述,详情图-text-y",
"shippingPlace":"发货地-varchar(50)-y",
"originPlace":"原产地-varchar(50)-y",
"grossWeight":"毛重-float(11,2)-y",
"supplier":"供应商名称-varchar(255)-y",
"enable":"启用状态,0: 禁用, 1: 启用-bit(1)-y",
"createTime":"yyyy-MM-dd HH:mm:ss",
"updateTime":"yyyy-MM-dd HH:mm:ss",
"unit":"计件单位，如个、件-varchar(20)-y",
"barCode":"商品条码-varchar(20)-y",
"price":"单价-float(11,2)-y 这个可能不需要，在sku中有"
}
],
"total":13, //总条数
"current":1, //当前页
"pages":1 //总页数
},
"success":true
}

商品新增（编辑）接口

场景：erp新增或者编辑一个商品的时候，点击确定或者同步的时候同步到微店
交互方式：洋老板监听，ERP调用，手动触发
接口名称：prod.add_or_edit
接口描述：erp同步商品列表到微店
参数：如果是编辑，除了主键id和修改字段外，其他的是非必填项

{
"prodId":"商品唯一标识(全局唯一，不能和其他商品ID重复，也不能和规格商品SkuId重复) -varchar(20)-y",//微店有一个id，是主键，是我们这边自动生成的，不知道后续是用哪个
"erpProdCode":"ERP商品编码-varchar(50)-y",
"catalogId":"所属三级类目id-varchar(20)-y",
"catalogChain":"类目链: 一级类目id-二级类目id-三级类目id- 比如 11-1123-112366,varchar(255)-y",
"brand":"品牌-varchar(255)-y",
"album":"商品图册,多个用逗号隔开,存图片相对地址-varchar(500)-y",
"description":"商品描述,详情图-text-y",
"shippingPlace":"发货地-varchar(50)-y",
"originPlace":"原产地-varchar(50)-y",
"grossWeight":"毛重-float(11,2)-y",
"supplier":"供应商名称-varchar(255)-y",
"enable":"启用状态,0: 禁用, 1: 启用-bit(1)-y",
"createTime":"yyyy-MM-dd HH:mm:ss",
"updateTime":"yyyy-MM-dd HH:mm:ss",
"unit":"计件单位，如个、件-varchar(20)-y",
"barCode":"商品条码-varchar(20)-y",
"price":"单价-float(11,2)-y"
}

返回结果

{
"code":200,
"msg":"success",
"success":true
}

SKU列表接口（因为时间问题以及不确定是一次性同步所有sku，还是只同步某个商品的sku，所以暂时不列出）

SKU详情接口（这个可能不需要）列表一次性同步过来后，使用编辑即可即可

场景：用户在下单的时候，需要调用该接口来判断该商品的sku是否有效
交互方式：洋老板监听，ERP调用，手动触发
接口名称：sku.detail
接口描述：获取sku信息
参数：

{
"skuId":"SKU唯一标识-varchar(20)-y"
}

返回结果

{
"skuId":"SKU唯一标识-varchar(20)-y",
"code":"SKU商家编码-varchar(20)-y",
"barCode":"sku条码-varchar(20)-y",
"shopId":"微店（门店)id-bigint(20)-y",
"inventory":"可用库存-int(11)-y",
"saled":"已售库存-int(11)-y",
"freeze":"冻结库存-int(11)-y",
"skuPic":"sku主图-varchar(100)",
"originalPurchasePrice":"原始采购价-float(11,2)-y",
"retailPrice":"零售价-float(11,2)-y",
"vipPrice":"会员价(产品目前定义的是，所有门店价格全部统一)-float(11,2)-y",
"referencePrice":"市场参考价-float(11,2)-float(11,2)-y",
"skuAttr":"属性, JSON格式: [{"name": "规格", "value": "1段"},{"name": "颜色", "value": "红色"}]-varchar(200)-N",
"createTime":"yyyy-MM-dd HH:mm:ss",
"updateTime":"yyyy-MM-dd HH:mm:ss",
}

SKU库存查询接口

场景：用户在下单的时候，需要调用该接口来判断该商品的sku是否有效
交互方式：微店调用ERP监听（下单），
接口名称：sku.inventory.get
接口描述：获取某个门店的sku信息
参数：

{
"skuId":"SKU唯一标识-varchar(20)-y",
"shopId":"微店（门店)id-bigint(20)-y"
}

返回结果

{
"skuId":"SKU唯一标识-varchar(20)-y",
"shopId":"微店（门店)id-bigint(20)-y",
"inventory":"可用库存-int(11)-y",
"saled":"已售库存-int(11)-y",
"freeze":"冻结库存-int(11)-y"

}

SKU库存修改接口

场景：ERP修改库存，需要同步库存信息到微店
交互方式：ERP调用微店监听（ERP修改库存），
接口名称：sku.inventory.update
接口描述：获取某个门店的sku信息
参数：

{
"skuId":"SKU唯一标识-varchar(20)-y",
"shopId":"微店（门店)id-bigint(20)-y",
"inventory":"可用库存-int(11)-y",
"saled":"已售库存-int(11)-y",
"freeze":"冻结库存-int(11)-y"
}

返回结果

{
"code":200,
"msg":"success",
"success":true
}

SKU会员价查询接口

场景：这个接口有待商榷，如果修改接口起作用，且价格变动不是很频繁的时候，该接口可忽略，下单的时候也不需要再去查询
交互方式：微店调用，ERP监听(下单)
接口名称：sku.price.get
接口描述：获取某个门店的sku会员价信息
参数：

{
"skuId":"SKU唯一标识-varchar(20)-y",
"shopId":"微店（门店)id-bigint(20)-y"
}

返回结果

{
"skuId":"SKU唯一标识-varchar(20)-y",
"vipPrice":"会员价(产品目前定义的是，所有门店价格全部统一)-float(11,2)-y"
}

SKU会员价修改接口

场景：ERP修改会员价后，需要同步到微店
交互方式：ERP调用，微店监听（ERP改价）
接口名称：sku.price.update
接口描述：同步门店会员价
参数：

{
"skuId":"SKU唯一标识-varchar(20)-y",
"shopId":"微店（门店)id-bigint(20)-y",
"vipPrice":"会员价-float(11,2)-y"
}

返回结果

{
"code":200,
"msg":"success",
"success":true
}

2019-06-28-微店