本規範确定了“互聯網+第四方物(wù)流”供銷集配科技支撐體系數據對接标準,是供銷集配科技支撐體系信息化系統統一(yī)的基礎、是各合作商(shāng)對接供銷集配體系的依據,是江西省供銷電子商(shāng)務有限公司(以下(xià)簡稱電商(shāng)公司)對社會統一(yī)開放(fàng)共享的前提。
本規範由江西省供銷電子商(shāng)務有限公司技術部提出并歸口。
本規範由歸口部門負責解釋。
本規範起草單位:江西省電子商(shāng)務有限公司
适用對象爲江西省供銷電子商(shāng)務有限公司内部及合作方, 用于在業務開展、招标選型、工(gōng)程建設、運行維護、設備開發等方面提供技術參考依據。
2、接口說明
本規範支持以下(xià)接口或協議:http/https和數據庫接口,并可根據客戶、合作方的具體需求提供相應的對接方式。
包含集配中(zhōng)心及集配中(zhōng)心設計到所有實體,例如車輛、司機、服務站、倉庫、客戶、供應商(shāng)、産品等。以及集配中(zhōng)心開展業務經營情況信息,例如快遞、快消品、生(shēng)鮮、等業務數據
正式請求地址:具體官網公布爲準
官網地址:/
對接方式:http接口
3.1集配企業主體信息上報
該接口用于上報集配企業基礎信息
接口名稱:uploadCompanyInformation
請求方式:post
接口示例:參見附件一(yī)
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | Hdh#qqashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
車輛數 | car_num | 是 | int | 20 | 車輛總數 |
倉庫面積 | area_num | 是 | float | 3525.3 | 倉庫面積 |
網點數 | shop_num | 是 | int | 222 | 網點數量 |
ip | ip | 是 | string | 47.86.170.30 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "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", }
|
接口描述:該接口用于上報集配中(zhōng)心車輛信息
接口名稱:uploadCarInformation
請求方式:post
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | Hdh#qqashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
車牌号 | 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 | 部分(fēn)接口會有返回信息 |
{ "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司機信息上報
接口描述:該接口用于上報集配中(zhōng)心司機信息
請求方式:post
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | Hdh#qqashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
司機名字 | driver_name | 是 | int | 王小(xiǎo)明 | 司機名字 |
司機性别 | 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 | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "driver_name": "王小(xiǎo)明", "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标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | Hdh#qqashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
站點名稱 | partner_name | 是 | int | XXX超市 | 提貨點、小(xiǎo)賣鋪、服務站點、合夥人 |
聯系人名字 | link_name | 是 | float | 翟志(zhì)剛 | 聯系人名字 |
聯系人電話 | link_phone | 否 | int | 18918882910 | 聯系人電話 |
經度 | lot | 是 | float | 28.32 | 經度 |
緯度 | lat | 是 | float | 112.23 | 緯度 |
ip | ip | 是 | string | 47.86.170.30 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
變量名 | 必填 | 類型 | 示例值 | 描述 | |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "code_id": "360102", "key": "Hdh#qqashdas", "partner_name": " XXX超市", "link_name": "翟志(zhì)剛", "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标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | Hdh#qqashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
素材名稱 | file_name | 是 | int | 測試圖片 | 提貨點、小(xiǎo)賣鋪、服務站點、合夥人 |
素材類型 | file_type | 是 | int | 1 | 1 圖片 2 視頻 3 文件 |
ip | ip | 是 | string | 47.86.170.30 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
{ "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傳輸一(yī)次。
接口名稱:uploadCarPosition
請求方式:post
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | Hdh#qqashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
車輛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 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
變量名 | 必填 | 類型 | 示例值 | 描述 | |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "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快遞數據接口
集配中(zhōng)心每日快遞數據上報接口(每日上報一(yī)次快遞數據)
請求方式:post
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | hdhashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
快遞上行件 | up_num | 是 | int | 1344 | 快遞上行件的數量 |
快遞下(xià)行件 | down_num | 是 | int | 222 | 快遞下(xià)行件的數量 |
日期 | data_time | 是 | date | 2022-12-09 | 快遞數據日期一(yī)般爲當天的日期 |
ip | ip | 是 | string | 47.86.170.30 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
變量名 | 必填 | 類型 | 示例值 | 描述 | |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "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訂單數據上報接口
集配中(zhōng)心訂單數據上報接口(每個成功的訂單上報一(yī)次數據)
地址:uploadOrder
請求方式:post
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | hdhashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
訂單類型 | type | 是 | int | 1 | 标識訂單類型(1、新零售2、生(shēng)鮮3、農資) |
訂單總價 | price | 是 | decimal | 222.11 | 訂單總金額 |
日期 | data_time | 是 | string | 202006100909 | 下(xià)單日期 |
ip | ip | 是 | string | 47.86.170.30 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
變量名 | 必填 | 類型 | 示例值 | 描述 | |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "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訂單商(shāng)品數據上報接口
縣級運營中(zhōng)心訂單數據上報接口,該接口主要根據訂單單品來上報,用于統計每個單品的銷售情況
請求方式:post
請求參數:
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
密鑰 | key | 是 | string | hdhashdas | 密鑰主要用于上報數據接口驗證每個運營中(zhōng)心的密鑰都是唯一(yī)的 |
訂單類型 | type | 是 | int | 1 | 标識訂單類型(1、新零售2、生(shēng)鮮3、農資) |
訂單金額 | price | 是 | decimal | 222.11 | 訂單總金額 |
單品名稱 | sku_name | 是 | string | 橘子 | 商(shāng)品名稱 |
單品id | sku_id | 是 | int | 00001 | 商(shāng)品規格id |
日期 | data_time | 是 | date | 202006100909 | 下(xià)單日期 |
ip | ip | 是 | string | 47.86.170.30 | 縣級運營中(zhōng)心上報數據的ip地址 |
數據時間 | create_time | 是 | date | 2022-12-09 | 該字段是數據上報的時間 |
返回參數:
變量名 | 必填 | 類型 | 示例值 | 描述 | |
返回狀态碼 | code | 是 | int | 1 | 返回值爲1時代表成功,爲0時代表失敗 |
msg | msg | 是 | string | 成功 | 主要表述數據上報是否成功 |
返回信息 | body | 是 | string | null | 部分(fēn)接口會有返回信息 |
請求參數示例:
{ "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接口對接的數據會經過篩選和處理,容易導緻數據失真,不利于後續數據的分(fēn)析和利用。可以采取開放(fàng)數據庫權限,直接對接數據庫的方式獲取原始數據。
數據庫方式通信所對應的數據庫組網方式有以下(xià)兩種:
一(yī)、由合作夥伴提供一(yī)個交互用的數據庫服務器,要求數據庫的結構滿足本規範中(zhōng)定義要求。
二、電商(shāng)公司提供一(yī)個符合規範定義的結構要求的标準數據庫,供合作方數據交互。
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 360102 | 地區id标識的是縣級運營中(zhōng)心所在的地區(詳情請查看附件) |
公司名稱 | name | 是 | string | XX公司 | 公司名稱 |
訂單類型 | type | 是 | int | 1 | 标識訂單類型(1、新零售2、生(shēng)鮮3、農資) |
注冊資金 | registered_capital | 是 | decimal | 222萬 | 公司注冊資金 |
股權占比 | equity_ratio | 是 | float | 36.3% | 股權占比 |
經營類型 | business_type | 是 | int | 1 | 公司經營類型1快遞,2新零售,3生(shēng)鮮,4 |
員工(gōng)數量 | staff_num | 否 | int | 20 | 員工(gōng)數量 |
店(diàn)鋪數量 | shop_num | 否 | int | 47 | 公司名下(xià)店(diàn)鋪數量 |
總場地面積 | totle_area | 是 | float | 10000㎡ | 總場地面積 |
快遞品牌 | express_brand | 是 | int | 1 | 快遞品牌1.中(zhōng)通2圓通等等 |
配送單價 | express_price | 否 | decimal | 1.2 | 配送快遞的價格 |
配送線路 | route_num | 否 | int | 2 | 配送線路 |
企業負責人 | real_name | 是 | string | 王小(xiǎo)明 | 企業負責人 |
聯系方式 | phone | 是 | string | 13154218546 | 企業負責人聯系方式 |
省 | province | 是 | string | 江西 | 省 |
市 | city | 是 | string | 南(nán)昌 | 市 |
縣 | 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 | 是 | 28.23 | 訂單總金額 | |
緯度 | latitude | 是 | float | 116.3 | 商(shāng)品名稱 |
創建時間 | create_time | 是 | datetime | 2020-03-03 | 商(shāng)品規格id |
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
公司id | key_id | 是 | int | 12 | 公司id |
公司名稱 | add_name | 是 | string | XX公司 | 所屬公司名稱 |
快遞單号 | sn | 是 | string | XXX超市 | 快遞單号 |
快遞品牌 | logis_name | 是 | string | 圓通 | 快遞品牌 |
操作人 | user_name | 是 | string | 小(xiǎo)明 | 操作人 |
數據時間 | 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 |
商(shāng)品名 | goods_name | 是 | string | 小(xiǎo)白(bái)菜 | 商(shāng)品名 |
商(shāng)品數量 | goods_num | 是 | Int | 111 | 商(shāng)品數量 |
訂單數量 | 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 | 快遞上行數量 |
快遞下(xià)行數量 | down_num | 是 | int | 3122 | 快遞下(xià)行數量 |
數據時間 | data_time | 是 | date | 2020-03-03 | 數據時間 |
數據傳輸時間 | create_time | 是 | datetime | 2020-03-03 | 數據傳輸時間 |
新零售數據表
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
地區id | code_id | 是 | int | 12 | 地區id |
公司id | company_id | 是 | string | 06 | 訂單所屬公司id |
商(shāng)品名 | goods_name | 是 | string | 王老吉 | 商(shāng)品名 |
商(shāng)品數量 | goods_num | 是 | int | 111 | 商(shāng)品數量 |
訂單數量 | 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 |
商(shāng)品名 | goods_name | 是 | string | 化肥 | 商(shāng)品名 |
商(shāng)品數量 | goods_num | 是 | int | 111 | 商(shāng)品數量 |
訂單數量 | order_num | 是 | int | 111 | 訂單數量 |
訂單總價 | totle_price | 是 | decimal | 124214.2 | 訂單總價 |
數據時間 | data_time | 是 | date | 2020-03-03 | 數據時間 |
數據傳輸時間 | create_time | 是 | datetime | 2020-03-03 | 數據傳輸時間 |