基于RESTfulAPI接口规范,使用HTTPS通信协议;
如果报错,返回格式:
访问限制【后期可能增加这方面的限制,提前注意请求次数和频率】
提供白名单
提供接口联系人,方便以后接口升级,及时通知
如果超出限制,及时做一些通知
示例[{"branchId":1,"branchName":"上海科力普分公司",xxxxx:xxxx},{"branchId":2,"branchName":"北京科力普分公司",xxxxx:xxxx},......]
GET/api/v1/basic/getAllArea查询全部省市区,注意是拉平的全部数据,注意本地缓存
示例[{"provinceId":1,"provinceName":"北京",xxxxx:xxxx},{"provinceId":2,"provinceName":"上海",xxxxx:xxxx},......]
GET/api/v1/basic/getAllExpress查询全部承运商
示例[{"expressId":1,"expressCode":"EMS",xxxxx:xxxx},{"expressId":2,"expressCode":"SF",xxxxx:xxxx},......]
GET/api/v1/basic/getAllPlatform查询所有平台
示例[{"platformId":1,"platformCode":"BeiJingZhengCai",xxxxx:xxxx},{"platformId":2,"platformCode":"ShangHaiZhengCai",xxxxx:xxxx},......]
GET/api/v1/order/getByOrderCode订单查询需要配合消息中心使用,首先根据消息中心推送的订单编号,然后利用订单查询接口,进行订单详情信息查询
订单明细(orderItem)【不能用skuCode直接取商品信息中的信息,那个是实时商品状态,这个是下单时的状态,】
订单拓展(orderExtend键值对,后期针对不同供应商不同的需求需要拓展返回信息)
收货地址信息【orderAddres】
示例{"orderCode":"2001457555W","totalAmt":12.1252,"orderItems":[{"skuCode":"13839","skuName":"A4打印纸80g",...},{"skuCode":"15122","skuName":"晨光签字笔",...},...],"orderAddress":{"contactName":"张三","address":"上海市徐汇区古美路1528号A2幢11-12层",...}}
POST/api/v1/order/delivery
快递包裹列表【deliveryParcel】
自配发货信息【deliveryInfo】
示例{"clientCode":"V0001","deliveryType":"2","orderCode":"2001465458W","deliveryParcel":[{"expressId":1,"expressNum":"DPH12323321","expressName":"德邦","driverId":0,"truckId":0}]}
POST/api/v1/order/uploadSignFile上传附件并签收
示例{"clientCode":"V0001","orderCode":"2001457555W","fileName":"20230111.jpg","base64String":"iVBORw0KGgoAAAANSUhEUgAAA08AAAC...."}
POST/api/v1/order/signConfirm需提前调用上传附件功能
GET/api/v1/return/getByReturnCode订单查询需要配合消息中心使用,首先根据消息中心推送的订单编号,然后利用订单查询接口,进行订单详情信息查询
退单明细(SKU明细)【returnItem】
发货地址信息、上面取件地址【senderAddres】参考4.1订单查询的《收货地址信息【orderAddres】》
备注:
基础数据一般不会轻易修改(或删除),故无需增加是否有效字段
数据可以全部进入缓存(缓存有限期1~2小时)
销售单位
品牌
分类对外提供B2C渠道C网可售的分类数据
分类属性:待确认
发货仓
返回参数
为了避免客户端,一直请求业务库进行数据查询,所以增加一个消息中心表,把新增的订单,同步到该表,用完即删
GET/api/v1/msgqueue/getByClientCode获取并确认处理成功之后请调用消息删除接口,否则推送的消息会越来越多!!
示例[{"msgType":310,"bizCode":"2000634729W"},{"msgType":310,"bizCode":"2000634727W"},......]
POST/api/v1/msgqueue/deleteMessageQueue消息查询并确认处理成功之后请调用消此接口,否则推送的消息会越来越多!!