本规范确定了“互联网+第四方物流”供销集配科技支撑体系数据对接标准,是供销集配科技支撑体系信息化系统统一的基础、是各合作商对接供销集配体系的依据,是江西省供销电子商务有限公司(以下简称电商公司)对社会统一开放共享的前提。
本规范由江西省供销电子商务有限公司技术部提出并归口。
本规范由归口部门负责解释。
本规范起草单位:江西省电子商务有限公司
适用对象为江西省供销电子商务有限公司内部及合作方, 用于在业务开展、招标选型、工程建设、运行维护、设备开发等方面提供技术参考依据。
2、接口说明
本规范支持以下接口或协议:http/https和数据库接口,并可根据客户、合作方的具体需求提供相应的对接方式。
包含集配中心及集配中心设计到所有实体,例如车辆、司机、服务站、仓库、客户、供应商、产品等。以及集配中心开展业务经营情况信息,例如快递、快消品、生鲜、等业务数据
正式请求地址:具体官网公布为准
官网地址:https://www.jxcoop.com.cn/
对接方式:http接口
3.1集配企业主体信息上报
该接口用于上报集配企业基础信息
接口名称:uploadCompanyInformation
请求方式:post
接口示例:参见附件一
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | Hdh#qqashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
车辆数 | car_num | 是 | int | 20 | 车辆总数 |
仓库面积 | area_num | 是 | float | 3525.3 | 仓库面积 |
网点数 | shop_num | 是 | int | 222 | 网点数量 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "car_num": "20", "area_num": "3525.3", "shop_num": "222", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", }
|
接口描述:该接口用于上报集配中心车辆信息
接口名称:uploadCarInformation
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | Hdh#qqashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
车牌号 | car_name | 是 | int | 20 | 车辆总数 |
车辆长度(米) | car_long | 是 | float | 12 | 仓库面积 |
车载重量(吨) | shop_num | 是 | int | 22 | 网点数量 |
购买时间 | buy_date | 是 | date | 2022-12-09 |
|
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
{ "code_id": "360102", "key": "Hdh#qqashdas", "car_num": "20", "car_long": "12", "shop_num": "20", "buy_date ": "2022-12-09", "create_time": "2022-12-09" }
|
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.3司机信息上报
接口描述:该接口用于上报集配中心司机信息
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | Hdh#qqashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
司机名字 | driver_name | 是 | int | 王小明 | 司机名字 |
司机性别 | driver_sex | 是 | float | 1 | 1.男2女 |
从业证件 | driver _certificate | 是 | int | 222 | 上传图片 |
数据时间 | create_time | 是 | date | 2022-12-09 | 数据上报时间 |
返回参数:
变量名 | 必填 | 类型 | 示例值 | 描述 | |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "driver_name": "王小明", "driver_sex": "1", "driver _certificate ": "图片", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.4服务站点上报
接口描述:该接口用于上报服务站点信息
接口名称:uploadPartnerInformation
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | Hdh#qqashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
站点名称 | partner_name | 是 | int | XXX超市 | 提货点、小卖铺、服务站点、合伙人 |
联系人名字 | link_name | 是 | float | 翟志刚 | 联系人名字 |
联系人电话 | link_phone | 否 | int | 18918882910 | 联系人电话 |
经度 | lot | 是 | float | 28.32 | 经度 |
纬度 | lat | 是 | float | 112.23 | 纬度 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
变量名 | 必填 | 类型 | 示例值 | 描述 | |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "partner_name": " XXX超市", "link_name": "翟志刚", "link_phone": "18918882910", "lot": "28.32", "lat": "112.23", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.5素材上传
接口描述:该接口用于上传素材信息、例如集配企业营业执照、车辆行驶证、驾照、重要文件、宣传资料等信息
接口名称:uploadFile
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | Hdh#qqashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
素材名称 | file_name | 是 | int | 测试图片 | 提货点、小卖铺、服务站点、合伙人 |
素材类型 | file_type | 是 | int | 1 | 1 图片 2 视频 3 文件 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
{ "code_id": "360102", "key": "Hdh#qqashdas", "file_name": "测试图片", "file_type": "1", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.6车辆实时坐标
接口描述:该接口用于实时上报车辆位置,设备开启后间隔30s传输一次。
接口名称:uploadCarPosition
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | Hdh#qqashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
车辆id | car_id | 是 | int | 20 | 车辆id |
车牌号 | car_name | 是 | string | 赣A23131 | 车牌号 |
经度 | lot | 是 | float | 28.31 | 经度 |
纬度 | lat | 是 | float | 116.23 | 纬度 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
变量名 | 必填 | 类型 | 示例值 | 描述 | |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "car_id": "20", "car_name": "赣A23131", "lot": "28.31", "lat": "116.23", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.7快递数据接口
集配中心每日快递数据上报接口(每日上报一次快递数据)
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | hdhashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
快递上行件 | up_num | 是 | int | 1344 | 快递上行件的数量 |
快递下行件 | down_num | 是 | int | 222 | 快递下行件的数量 |
日期 | data_time | 是 | date | 2022-12-09 | 快递数据日期一般为当天的日期 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
变量名 | 必填 | 类型 | 示例值 | 描述 | |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "up_num ": "2021", "down_num ": "3525", "date_time": "2022-12-09", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.8订单数据上报接口
集配中心订单数据上报接口(每个成功的订单上报一次数据)
地址:uploadOrder
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | hdhashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
订单类型 | type | 是 | int | 1 | 标识订单类型(1、新零售2、生鲜3、农资) |
订单总价 | price | 是 | decimal | 222.11 | 订单总金额 |
日期 | data_time | 是 | string | 202006100909 | 下单日期 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
变量名 | 必填 | 类型 | 示例值 | 描述 | |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "type ": "2", "price ": "3525.3", "data_time ": "2022-12-09", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
3.9订单商品数据上报接口
县级运营中心订单数据上报接口,该接口主要根据订单单品来上报,用于统计每个单品的销售情况
请求方式:post
请求参数:
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
密钥 | key | 是 | string | hdhashdas | 密钥主要用于上报数据接口验证每个运营中心的密钥都是唯一的 |
订单类型 | type | 是 | int | 1 | 标识订单类型(1、新零售2、生鲜3、农资) |
订单金额 | price | 是 | decimal | 222.11 | 订单总金额 |
单品名称 | sku_name | 是 | string | 橘子 | 商品名称 |
单品id | sku_id | 是 | int | 00001 | 商品规格id |
日期 | data_time | 是 | date | 202006100909 | 下单日期 |
ip | ip | 是 | string | 47.86.170.30 | 县级运营中心上报数据的ip地址 |
数据时间 | create_time | 是 | date | 2022-12-09 | 该字段是数据上报的时间 |
返回参数:
变量名 | 必填 | 类型 | 示例值 | 描述 | |
返回状态码 | code | 是 | int | 1 | 返回值为1时代表成功,为0时代表失败 |
msg | msg | 是 | string | 成功 | 主要表述数据上报是否成功 |
返回信息 | body | 是 | string | null | 部分接口会有返回信息 |
请求参数示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "type ": "1", "price": "222.11", "sku_name ": "橘子", "sku_id ": "00001", "data_time ": "2022-12-09", "ip": "47.86.170.30", "create_time": "2022-12-09" } |
返回值示例:
{ "code": "1", "msg": "正常", "body ": "null", } |
4、数据库对接
通过http接口对接的数据会经过筛选和处理,容易导致数据失真,不利于后续数据的分析和利用。可以采取开放数据库权限,直接对接数据库的方式获取原始数据。
数据库方式通信所对应的数据库组网方式有以下两种:
一、由合作伙伴提供一个交互用的数据库服务器,要求数据库的结构满足本规范中定义要求。
二、电商公司提供一个符合规范定义的结构要求的标准数据库,供合作方数据交互。
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 360102 | 地区id标识的是县级运营中心所在的地区(详情请查看附件) |
公司名称 | name | 是 | string | XX公司 | 公司名称 |
订单类型 | type | 是 | int | 1 | 标识订单类型(1、新零售2、生鲜3、农资) |
注册资金 | registered_capital | 是 | decimal | 222万 | 公司注册资金 |
股权占比 | equity_ratio | 是 | float | 36.3% | 股权占比 |
经营类型 | business_type | 是 | int | 1 | 公司经营类型1快递,2新零售,3生鲜,4 |
员工数量 | staff_num | 否 | int | 20 | 员工数量 |
店铺数量 | shop_num | 否 | int | 47 | 公司名下店铺数量 |
总场地面积 | totle_area | 是 | float | 10000㎡ | 总场地面积 |
快递品牌 | express_brand | 是 | int | 1 | 快递品牌1.中通2圆通等等 |
配送单价 | express_price | 否 | decimal | 1.2 | 配送快递的价格 |
配送线路 | route_num | 否 | int | 2 | 配送线路 |
企业负责人 | real_name | 是 | string | 王小明 | 企业负责人 |
联系方式 | phone | 是 | string | 13154218546 | 企业负责人联系方式 |
省 | province | 是 | string | 江西 | 省 |
市 | city | 是 | string | 南昌 | 市 |
县 | area | 是 | string | 西湖区 | 县/区 |
gps x坐标 | gps_x | 否 | float | 28.33 | 百度地图坐标 |
gps y坐标 | gps_y | 否 | float | 115.212 | 百度地图坐标 |
注册时间 | create_time | 是 | datetime | 2020-02-03 | 注册时间 |
服务站点表
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
公司id | company_id | 是 | int | 12 | 公司id |
企业名称 | company_name | 是 | string | XX公司 | 所属公司名称 |
服务站点名称 | name | 是 | string | XXX超市 | 服务站点名称 |
联系人 | link_man | 是 | string | 1 | 联系人 |
联系电话 | link_phone | 是 | string | 13154218546 | 联系电话 |
经度 | longitude | 是 | float | 28.23 | 订单总金额 |
纬度 | latitude | 是 | float | 116.3 | 商品名称 |
创建时间 | create_time | 是 | datetime | 2020-03-03 | 商品规格id |
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
公司id | key_id | 是 | int | 12 | 公司id |
公司名称 | add_name | 是 | string | XX公司 | 所属公司名称 |
快递单号 | sn | 是 | string | XXX超市 | 快递单号 |
快递品牌 | logis_name | 是 | string | 圆通 | 快递品牌 |
操作人 | user_name | 是 | string | 小明 | 操作人 |
数据时间 | data_time | 是 | date | 2020-03-03 | 数据时间 |
地址 | address | 是 | string | 民安路99号 | 地址 |
手机号 | phone | 是 | string | 13154218546 | 手机号 |
数据传输时间 | create_time | 是 | datetime | 2020-03-03 | 数据传输时间 |
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 12 | 地区id |
公司id | company_id | 是 | string | 06 | 订单所属公司id |
商品名 | goods_name | 是 | string | 小白菜 | 商品名 |
商品数量 | goods_num | 是 | Int | 111 | 商品数量 |
订单数量 | order_num | 是 | Int | 111 | 订单数量 |
订单总价 | totle_price | 是 | decimal | 124214.2 | 订单总价 |
数据时间 | data_time | 是 | date | 2020-03-03 | 数据时间 |
数据传输时间 | create_time | 是 | datetime | 2020-03-03 | 数据传输时间 |
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 12 | 地区id |
公司id | company_id | 是 | int | 06 | 订单所属公司id |
快递名称 | express_name | 是 | string | 圆通快递 | 快递名称 |
快递上行数量 | up_num | 是 | int | 6465 | 快递上行数量 |
快递下行数量 | down_num | 是 | int | 3122 | 快递下行数量 |
数据时间 | data_time | 是 | date | 2020-03-03 | 数据时间 |
数据传输时间 | create_time | 是 | datetime | 2020-03-03 | 数据传输时间 |
新零售数据表
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 12 | 地区id |
公司id | company_id | 是 | string | 06 | 订单所属公司id |
商品名 | goods_name | 是 | string | 王老吉 | 商品名 |
商品数量 | goods_num | 是 | int | 111 | 商品数量 |
订单数量 | order_num | 是 | int | 111 | 订单数量 |
订单总价 | totle_price | 是 | decimal | 124214.2 | 订单总价 |
数据时间 | data_time | 是 | date | 2020-03-03 | 数据时间 |
数据传输时间 | create_time | 是 | datetime | 2020-03-03 | 数据传输时间 |
农资农具数据表
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
地区id | code_id | 是 | int | 12 | 地区id |
公司id | company_id | 是 | string | 06 | 订单所属公司id |
商品名 | goods_name | 是 | string | 化肥 | 商品名 |
商品数量 | goods_num | 是 | int | 111 | 商品数量 |
订单数量 | order_num | 是 | int | 111 | 订单数量 |
订单总价 | totle_price | 是 | decimal | 124214.2 | 订单总价 |
数据时间 | data_time | 是 | date | 2020-03-03 | 数据时间 |
数据传输时间 | create_time | 是 | datetime | 2020-03-03 | 数据传输时间 |