API 總覽
v1.0.1 · 2025-12-22本文檔描述第三方 ERP 系統與 Teamotto Digital Operations Platform(WDOP)之間的數據同步接口,供日常運營中兩系統數據互通使用。文檔版本 1.0.1(格式調整版),UAT 環境。
/login/v1/pc/password 取得 token,之後每個請求帶 header Authorization: {token}。
② 接口狀態碼支持多語言返回,需在請求 header 指定語言,默認 Language: zh_CN。
③ 統一回應封裝:{ "state": true, "code": 1, "message": null, "data": … },state=true 且 code=1 表示成功。
④ 文檔中 snowflake 型 ID(Long)位數長,注意 JSON 解析時 JS Number 精度問題(超過 Number.MAX_SAFE_INTEGER),建議用字符串或 bigint 處理。
待確認問題(Review Notes)
建議向 Teamotto / Zoe 跟進通讀全文檔後發現以下不確定點,建議在開發前與 Teamotto 確認:
| # | 位置 | 問題 | 建議 |
|---|---|---|---|
| 1 | Item §6 商品同步 | URL、Description、參數全部為空(僅示例域名根路徑),接口未定義完整 | 要求提供正式接口定義(疑為 ERP 與 WDOP 間 item 同步主接口,對 NAV 對接最關鍵) |
| 2 | Device §3 | URL 行寫成 /scenario/v1/getScenarioListtag/v1/getByEslCode(明顯排版錯誤),正確應為 /tag/v1/getByEslCode | 以 Example 行為準,順帶請對方修訂文檔 |
| 3 | Item §1/2/5 | 多處回應示例引用附件 [商品信息返回 json.txt]、[商品导入第一步 json.txt]、[商品返回详情 json.txt],PDF 中未附 | 向 Zoe 索取三份 json 附件,補全字段定義 |
| 4 | §1.1 登入 | tokenExpiresIn 示例值 36000000000000(ms),換算約 1142 年,與實際過期時間不符 | 確認 token 實際過期策略與更新機制 |
| 5 | §1.1 登入 | 登入接口請求參數標註為 query type,但示例為 JSON body | 確認實際是 body 傳參(示例為準) |
| 6 | 全局 | Long 型 snowflake ID 位數長(19 位),JS 默認 Number 解析會丟精度 | 對接時用字符串/bigint;可問對方是否支持 JSON 數字以字符串返回 |
| 7 | Item §1 | 參數名 inputCondtion 為原文檔拼寫(Condition 缺 e) | 按原文拼寫調用,確認後再定 |
| 8 | Device §1 ESL 列表 | 參數表中 currentPage 與分頁 current 同時存在,用途區分不明 | 確認 currentPage 是否為「標籤當前頁」篩選而非分頁 |
Miscellaneous · 1. 登入與授權
POST /login/v1/pc/passwordLogin to obtain information of store, scenario, authorization, etc.(登入取得店舖、場景、授權等信息)。Content-Type: application/json。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| account | 是 | String | 郵箱格式用戶名 |
| password | 是 | String | MD5 加密後密碼 |
| loginOs | 是 | String | 登入設備 OS:PC / Android / iOS / PDA |
請求示例
{
"account": "[email protected]",
"password": "81e7ff9dd1367e76b2542ca653c13eec",
"loginOs": "PC"
}
回應參數
統一封裝 state / code / message / data,data 主要字段:
| 字段 | 說明 |
|---|---|
| token | 登入 token,後續請求帶 Authorization: {token} |
| tokenExpiresIn | token 有效期(毫秒)⚠️ 示例值疑似不準,見待確認 #4 |
| userId / userName / loginId | 用戶 ID / 姓名 / 登入賬號 |
| storeId / storeName | 用戶所屬店舖 ID / 名稱 |
| merchantId | 店舖 ID(merchant 層級) |
| agentId | 經銷商 ID |
| userRoleId / userRoleName | 角色 ID / 名稱(如 storeAdmin) |
| userType | 用戶類型(operation, admin, support, headquarter, store staff) |
| state / isEffect | 賬號狀態:0 正常、1 異常無法登入 / 見附錄 II |
| languageId / language{} | 賬號語言(多語言顯示,默認繼承店舖) |
| isAppModifyPrice | 允許 App 改價(0: 可以 1: 不可以) |
| defaultScenarioId1 | 默認場景 ID(字符串型;defaultScenarioId 已標註 obsoleted) |
| forceUpdatePassword | 是否強制改密碼 true/false |
| lastLoginTime / createTime / updateTime | 時間字段 |
| customerCode / customerName / industryId / department / phone | 客戶編碼 / 客戶名稱 / 行業 ID / 部門 / 手機 |
回應示例(摘要)
{
"state": true,
"code": 1,
"message": null,
"data": {
"userId": "1971028273233240065",
"storeId": "1970408274055413761",
"userName": "[email protected]",
"loginId": "[email protected]",
"userRoleId": "5",
"userRoleName": "storeAdmin",
"state": 0,
"languageId": 1,
"merchantId": "1970386961517891584",
"userType": 204,
"isAppModifyPrice": 0,
"storeName": "买卖小零售 2",
"token": "ZXlKMGVYQWlPaUpLVjFRaUxDSmhiR2NpT2lKSVV6STFOaUo5…(JWT 全長略)",
"tokenExpiresIn": 36000000000000,
"agentId": "1970386655077847040",
"forceUpdatePassword": false,
"defaultScenarioId1": "1970386962092511232",
"language": { "languageId": 1, "languageCode": "zh_CN", "name": "中文", "sort": 1, "isEffect": 0 }
}
}
storeId / merchantId / agentId / defaultScenarioId1 供後續接口參數使用。Miscellaneous · 2. 代碼列表
POST /code/v1/getList按 cateId 分類取回系統代碼表(如任務類型、店舖狀態等枚舉),cateId 見附錄 III。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| cateId | 是 | Integer | 分類 ID,見附錄 III |
請求示例
{ "cateId": 12 }
回應字段(data[])
| 字段 | 說明 |
|---|---|
| codeId | 代碼唯一 ID(如 1208=重推) |
| cateId | 分類 ID |
| codeName | 代碼名稱(如 重推 / 綁定 / 切頁) |
| codeValue | 該分類下代碼值 |
| codeHelp | 備註欄(如 taskSchedule) |
| langKey / sort | 語言 key / 排序號 |
| isEffect | 代碼狀態,見附錄 II |
分類 12(任務類型)示例返回:1201 圖片任務、1202 解綁、1203 閃燈、1204 切頁、1205 NFC、1206 切布局、1207 切模板、1208 重推、1209 綁定、1210 系統、1211 盤點任務、1212 切頁模板預發。
Miscellaneous · 3. 語言列表
POST /language/v1/getList無請求參數。返回系統支持語言,用於狀態碼多語言及 Language header 取值。
回應字段(data[])
| 字段 | 說明 |
|---|---|
| languageId | 語言 ID |
| languageCode | 語言代碼(zh_CN / en_US / hr_HR / pl_PL …) |
| name | 語言名稱 |
| langKey / logoPath / sort | 語言 key / flag 圖 / 排序 |
| isEffect | 狀態,見附錄 II |
Scenario 場景
1 個接口Query scenario list。場景(scenario)是 WDOP 組織商品數據的維度(如「商品 items」),item 類接口均需 scenarioId。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| merchantId | 否 | Long | 取自登入接口回應 |
| textKey | 否 | String | 場景名稱 |
| scenarioKey | 否 | String | 場景 key |
| isEffect | 否 | Integer | 場景狀態,見附錄 II |
| agentId | 否 | Long | 取自登入接口回應 |
回應字段(data[])
| 字段 | 說明 |
|---|---|
| scenarioId | 場景 ID(字符串型),item 接口必帶 |
| scenarioType | 類型(如 merchant) |
| scenarioKey / defaultTextName / translateTextName | 場景 key / 默認名稱 / 翻譯名稱 |
| languageList[] | 多語言名稱 {languageId, language, text} |
| fieldList / staticFields | 場景字段定義(示例為空陣列,實際字段清單待確認 — 建議要 fieldList 完整示例) |
| isEffect / isDefault | 狀態 / 是否默認場景 |
| merchantId / agentId / shareSourceId | 組織層級 ID |
scenarioFieldKey(如 item_name、item_code、normal_price、unit、specification、origin、membership_price)即對應場景字段,實際可寫字段以該店舖 scenario 的 fieldList 為準。Item 商品
6 個接口Retrieve item list in scenario view。在指定場景視圖下分頁查詢商品。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| scenarioId | 是 | String | 場景 ID,取自 scenario 接口 |
| viewId | 是 | Long | 視圖 ID;為 null 時用 global 默認視圖 |
| storeId | 否 | Long | 店舖 ID |
| storeType | 否 | Integer | 店舖查詢範圍,見附錄 II |
| inputCondtion | 否 | Map | 字段過濾條件(注意原文拼寫),如 {"field_2":"1231233210"} |
| isEffect | 否 | Integer | 視圖狀態,見附錄 II |
| current / size | 否 | int | 頁碼(默認 -1 表示第 1 頁)/ 每頁條數 10,20,50,100… |
| orders | 否 | String[] | 排序,如 ["desc:field_2"] |
請求示例
{
"storeId": 1864477508571508738,
"storeType": 2,
"scenarioId": "1863392490189238272",
"inputCondtion": { "field_2": "1231233210" },
"viewId": 1965291918650564608,
"isEffect": 0,
"current": 1,
"size": 10,
"orders": [ "desc:field_2" ]
}
[商品信息返回 json.txt] 未附於文檔,字段以實際調用為准(見待確認 #3)。File upload for importing items。两步導入第一步:上傳商品文件,返回 batchId 供第二步使用。Content-Type: application/form-data。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| delimiter | 是 | String | CSV 文件分隔符 |
| scenarioId | 是 | Long | 場景 ID |
| file | 否 | MultipartFile | 商品文件(支持 EXCEL/CSV/TXT,見附錄 III cateId 25) |
[商品导入第一步 json.txt](未附);核心返回值為 batchId。Field mapping and data submission。将上傳文件的列映射到場景字段後正式導入。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| batchId | 是 | Long | 取自 importForFirst |
| startReadLine | 是 | Integer | 開始讀取行(示例為 2,跳過表頭) |
| targetStore | 是 | String | 目標店舖,多店用逗號分隔 |
| targetStoreType | 是 | Integer | 0: 店舖編号 1: 字段列名 2: 指定店舖名稱 3:(見原文) |
| fieldMappingList[].fieldSeq | 是 | Integer | 文件列序號 |
| fieldMappingList[].fieldName | 是 | String | 列名(如 商品名稱) |
| fieldMappingList[].scenarioFieldKey | 是 | String | 映射到的場景字段 key(item_name / item_code / normal_price / unit / specification / origin / membership_price…) |
| fieldMappingList[].defaultValue | 是 | String | 默認值(可空) |
| fieldMappingList[].isRead | 是 | Integer | 0: 不讀 1: 讀取 |
| fieldMappingList[].thousandth | 是 | String | 千分位符號(如 ,,價格類字段用) |
請求示例
{
"batchId": 1990585643099553792,
"startReadLine": 2,
"targetStoreType": 0,
"targetStore": "1",
"fieldMappingList": [
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "item_name", "thousandth": null, "fieldSeq": 1, "fieldName": "商品名称" },
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "item_code", "thousandth": null, "fieldSeq": 2, "fieldName": "商品条码" },
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "normal_price", "thousandth": ",", "fieldSeq": 3, "fieldName": "价格" },
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "unit", "thousandth": null, "fieldSeq": 4, "fieldName": "商品单位" },
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "specification", "thousandth": null, "fieldSeq": 5, "fieldName": "商品规格" },
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "origin", "thousandth": null, "fieldSeq": 6, "fieldName": "商品产地" },
{ "isRead": 1, "defaultValue": "", "scenarioFieldKey": "membership_price", "thousandth": ",", "fieldSeq": 7, "fieldName": "会员价格" }
]
}
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| scenarioId | 是 | Long | 場景 ID |
| ids | 是 | String | 商品 ID,逗號分隔 |
{ "scenarioId": 1863392490189238272, "ids": "1985584671658995712" }
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| scenarioId | 是 | Long | 場景 ID |
| itemId | 是 | String | 商品 ID |
{ "itemId": 1990230644548993024, "scenarioId": 1863392490189238272 }
[商品返回详情 json.txt](未附)。文檔中該節的 URL、Description、Request parameters、Response Example 全部為空(示例僅到域名根路徑 https://esl-uat-api.wintec.com/)。
Device 設備
11 個接口Retrieve ESL list。查詢標籤設備狀態、電量、信號、綁定商品等。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| storeId | 是 | Long | 店舖 ID |
| viewId | 是 | Long | 視圖 ID,null 時用 global 默認視圖 |
| storeQueryType | 是 | Integer | 店舖查詢類型,見附錄 II |
| isEffect | 是 | Integer | 店舖狀態,見附錄 II |
| current / size | 是 | int | 分頁頁碼 / 每頁條數 |
| param | 否 | String | 模糊篩選(含 ESLCode / goodsName / goodsCode) |
| tagIdentity | 否 | String | ESL 編碼 |
| tagTypeId / tagTypeColor | 否 | Integer | ESL 型號 / 顏色,見附錄 III cateId 4 |
| goodsCode / goodsName | 否 | String | 商品編碼 / 名稱 |
| lastTransmissionStart / End | 否 | Date | 最後通訊時間範圍 |
| status | 否 | Integer | ESL 狀態 |
| lqi / tagPower | 否 | Integer / Double | 信號強度 / 電量(支持 tagPowerStart/End 區間) |
| lastTaskType | 否 | Integer | 最近任務類型,見附錄 III cateId 12 |
| bind | 否 | Integer | 綁定狀態 0: 全部 1: 已綁 2: 未綁 |
| connectivity | 否 | Integer | 0: 未激活 1: 已激活 |
| macAddress / coorIp / coorId | 否 | String/Long | 關聯 AP 的 MAC / IP / AP ID |
| storeName / currentPage / ver / temperature / nfcBarcode | 否 | — | 店舖名 / 標籤當前頁 / 固件版本 / 溫度 / NFC 編碼 |
| orders | 否 | String[] | 排序 |
請求示例
{
"storeId": 1864477508571508738,
"storeQueryType": 2,
"coorId": "", "tagTypeId": "", "lastTaskTypeId": "", "connectivity": "",
"isEffect": 0,
"viewId": 1863510251968147456,
"current": 1, "size": 10, "orders": [],
"tagPowerStart": 0, "tagPowerEnd": 3.5
}
回應字段(data.records[])
| 字段 | 說明 |
|---|---|
| tagId | ESL ID(綁定/重推接口用) |
| tagIdentity | ESL 編碼(物理標籤編號) |
| tagTypeId / tagTypeName / tagTypeSize / tagTypeColorName | 型號 ID / 尺寸名(如 2.13)/ 完整型號 / 顏色 |
| tagState / tagStateName | 標籤狀態(1003 更新中等) |
| onlineState / onlineStateName | 在線狀態(1001 未激活等) |
| tagPower | 電壓(如 3.01V,低於 ~2.9V 注意低電壓告警) |
| lqi | 信號強度 |
| temperature / ver | 溫度 / 固件版本 |
| lastTaskType / lastTaskState / lastTaskTypeName | 最近任務類型(1208 重推等)/ 狀態 / 名稱 |
| lastTaskStateName / connectivity / connectivityName | 任務狀態名(更新中/更新失敗)/ 連接狀態(在線) |
| goodsName[] / goodsCode[] | 綁定的商品名 / 編碼(多屏標籤為陣列) |
| macAddress / coorIp / coorId | 關聯 AP 信息 |
| currentPage / pageCount / lastPageNo | 標籤當前顯示頁 / 總頁數 |
| imageSrc | 標籤當前渲染圖(PNG URL,可做預覽) |
| tagTime / createTime / updateTime / lastBindTime | 最後通訊 / 創建 / 更新 / 最後綁定時間 |
| nfcBarcode / epdCode / layoutId | NFC 編碼 / EPD 代碼 / 所用 Layout ID |
| storeId / storeName / storeCode / merchantId / agentId | 店舖 / 組織 ID |
分頁字段:data.total / pages / current / size。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| tagId | 是 | Long | ESL ID |
{ "tagId": 102424 }
返回單個標籤完整對象,字段同 D1 records[] 單條(tagState、tagPower、goodsName、imageSrc 等)。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| tagIdentity | 是 | String | ESL 編碼 |
| storeId | 是 | Long | 店舖 ID |
{ "tagIdentity": "0010971052", "storeId": 1970408274055413761 }
/scenario/v1/getScenarioListtag/v1/getByEslCode),以 Example 行 /tag/v1/getByEslCode 為準。返回字段同 D2。Retrieve ESL update record by ESL ID。追蹤每次推送/綁定/切頁任務的成功失敗,同步後核對結果的依據。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| tagId | 是 | Long | ESL ID |
| orderType | 否 | Integer | 任務類型,見附錄 III cateId 12 |
| tId | 否 | Long | 任務 ID |
| updateResult | 否 | Integer | 0: 成功(1004=失敗,見示例) |
| createTimeStart / createTimeEnd | 否 | Date | 記錄創建時間範圍 |
| goodsMsg | 否 | String | 商品編碼 |
| updateMessage | 否 | String | 結果訊息後綴模糊匹配,如 'abc%' |
| current / size / orders | 否 | int/String[] | 分頁 / 排序 |
回應字段(data.records[])
| 字段 | 說明 |
|---|---|
| tagRecordId | 記錄 ID |
| orderType / taskTypeName | 任務類型(1204 切頁 / 1208 重推)/ 名稱 |
| updateResult / updateResultName | 結果(1004=更新失敗等)/ 名稱 |
| updateMessage | 失敗原因(如「重試超過次數」「failTaskCode_46」) |
| tid | 任務 ID |
| data | 推送數據(JSON 字符串,含 data 數組、pageNo、tid) |
| retryTime1/2/3 | 重試時間(系統會自動重試 3 次) |
| createTime / createUser / updateTime | 時間(createUser 為 taskSchedule 表示系統調度) |
| goodsMsg / storeName / tagIdentity | 商品編碼 / 店舖 / 標籤編碼 |
Retrieve layout by ESL type。綁定前需取 layoutId:標籤型號 → 布局分組 → 分屏策略 → 具體 layout → 模板。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| storeId | 是 | Long | 店舖 ID |
| storeQueryType | 是 | Integer | 店舖查詢類型,見附錄 II |
| current / size | 是 | int | 分頁 |
| groupName / groupSize | 否 | String/Integer | 布局分組名稱 / 尺寸(如 "38") |
| strategyName / strategyType | 否 | String/Integer | 策略名稱 / 類型 0: 普通 1: 分屏 2: 自適應 |
| itemCount / canvasSize / itemTag | 否 | Integer/String | 分屏數 / 分屏尺寸 / 商品入口號 |
| templateId / scenarioId | 否 | Long | 模板 ID / 場景 ID |
回應結構(四層樹形)
| 層級 | 關鍵字段 | 說明 |
|---|---|---|
| 1 布局分組 | layoutGroupId / layoutGroupName / layoutGroupSize / layoutGroupWidth / layoutGroupHeight | 如「266-旋轉」 |
| 2 分屏策略 | layoutStrategyId / layoutStrategyName / layoutStrategyType / scenarioId | 如「2.66-分屏-旋轉」 |
| 3 布局 | layoutId / layoutName / maxBind | 如「2 屏」,綁定接口用此 layoutId |
| 4 分區/模板 | layoutLumpId / lumpWidth / lumpHeight / templateId / templateName / itemNumber / isCurrentUsing | 每個分區對應的模板與商品位 |
Binding ESL & items。將標籤與商品掛鉤並觸發內容推送。itemId 格式為「屏號:商品編碼」。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| tagId | 是 | Long | ESL ID |
| itemId[] | 是 | String[] | 屏號:商品編碼,多屏依序排列 |
| layoutId | 是 | Long | 布局 ID(取自 D5) |
| scenarioId | 是 | Long | 場景 ID |
| storeId | 是 | Long | 店舖 ID |
單屏示例
{
"tagId": 2549504,
"itemId": [ "1:1231233210" ],
"layoutId": 1968261461710741504,
"scenarioId": 1863392490189238272,
"storeId": 1864477508571508738
}
雙屏示例
{
"tagId": 2549504,
"itemId": [ "1:1231233210", "2:141535636" ],
"layoutId": 1972180207709986816,
"scenarioId": 1863392490189238272,
"storeId": 1864477508571508738
}
push/v1/batchPushTag 重推,標籤自動顯示新價格;或用 bind 重新綁定觸發更新。綁定結果建議用 D4 更新記錄核對(updateResult)。Repushing ESL by Access Point。對某 AP 下所有標籤批量重推。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| coorIdList | 是 | List | AP ID 列表 |
{ "coorIdList": [ "1991423646251188225", "1991421680049553410" ] }
ESL batch repush。改價後定向更新指定標籤用這個。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| tagIds | 是 | String | ESL ID,逗號分隔 |
{ "tagIds": "102825,102826" }
ESL batch repush by ESL type。按標籤型號整店重推。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| storeId | 是 | Long | 店舖 ID |
| tagTypeIdList[] | 否 | List | 型號列表(空=全部) |
{ "storeId": 1863392490457673730, "tagTypeIdList": [] }
Retrieve AP list with merchant headquarter account。查詢網關(Access Point)分佈與在線狀態。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| current / size / orders | 是 | int/String[] | 分頁 / 排序 |
| storeCode / storeName | 否 | String | 店舖編碼 / 名稱 |
| macAddress / ipAddr | 否 | String | AP MAC / IP |
| agentId / merchantId | 否 | Long | 經銷商 / 商家 ID |
| createStartDate / createEndDate | 否 | String | AP 創建時間範圍 |
| lastStartDate / lastEndDate | 否 | String | 最後連線時間範圍 |
| customerName / customerCode | 否 | String | 客戶名稱 / 編碼 |
回應字段(data.records[])
| 字段 | 說明 |
|---|---|
| coorId | AP ID(pushTagByCoor 用) |
| coorName / macAddress / ipAddr / ver | AP 名稱 / MAC / IP / 固件版本 |
| coorTime | 最後心跳時間 |
| coorState / coorStateDesc | 901 連接正常 / 902 正在連接(見附錄 III cateId 9) |
| storeId / storeName / storeCode | 所屬店舖 |
| isLegal / legalDesc | 801 合法 / 802 非法 |
| bindTags | 下掛標籤數(字符串) |
| upgradeState / upgradeStateDesc | 固件升級狀態 |
| customerName / customerCode / agentId / merchantId | 客戶 / 組織層級 |
Retrieve AP connection record。追蹤 AP 上下線歷史。
請求參數
| 參數 | 必填 | 類型 | 說明 |
|---|---|---|---|
| coorId | 是 | Long | AP ID |
| current / size / orders | 是 | int/String[] | 分頁 / 排序 |
| startDate / endDate | 否 | String | 連線時間範圍 |
| coorState | 否 | Integer | 901 正常 / 902 連線中 |
回應字段(data.records[])
| 字段 | 說明 |
|---|---|
| coorRecordId / coorId / coorName | 記錄 ID / AP ID / 名稱 |
| coorState / coorStateDesc | 901 連接正常 / 902 正在連接 |
| macAddress / ipAddr / port | AP 網絡信息 |
| storeId / storeName / merchantId / agentId | 店舖 / 組織 |
| createTime / createUser | 時間 / 記錄來源(system) |
附錄 I · API 狀態碼
| code | 訊息 | 說明 |
|---|---|---|
| 1 | N/A | 成功 Success |
| 2 | 操作失敗 | 通用失敗錯誤碼 General failure error code |
| 8 | xxx 不能为空或者参数失败 | 必填參數缺失 Required parameter missing |
附錄 II · 通用節點枚舉
| 枚舉 | 類型 | 常量 |
|---|---|---|
| isEffect | Integer | 0: 啟用 enabled · 1: 停用 disabled |
| storeType | Integer | 0: 當前用戶可訪問全部店舖 · 1: 一級下屬店舖 · 2: 當前店舖 · 4: 一級上屬店舖 |
| storeQueryType | Integer | 0: 當前用戶可訪問全部店舖 · 1: 一級下屬店舖 · 2: 當前店舖 |
附錄 III · Code 枚舉列表
cateId 索引| cateId | 分類 | codeId → 含義 |
|---|---|---|
| 1 | Store status 店舖狀態 | 101 未激活 · 102 已激活 · 103 停用 · 104 待續期 |
| 2 | User type 用戶類型 | 201 經銷商 · 202 維護 · 203 總公司 · 204 店舖 · 205 超級管理員 |
| 4 | ESL color 顏色 | 401 黑/白 · 402 黑/白/紅 · 403 黑/白/黃 · 404 黑/白/紅/黃 · 405 黑/白/紅/黃/藍/綠/橙 |
| 5 | Share type 分享類型 | 501 素材 · 502 商品 |
| 6 | Share status 分享狀態 | 601 分享中 · 602 成功 · 603 失敗 |
| 7 | Share strategy | 701 當前店一級下屬 · 702 全部下屬 · 703 指定下屬 |
| 8 | AP legality | 801 合法 · 802 非法 |
| 9 | AP connection status | 901 正常連接 · 902 正在連接 |
| 11 | Task status | 1101 等待 · 1102 已發 · 1103 完成 |
| 12 | Task type 任務類型 | 1201 圖片 · 1202 解綁 · 1203 LED · 1204 切頁 · 1205 NFC · 1206 切布局 · 1207 切模板 · 1208 重推 · 1209 綁定 · 1210 系統 · 1211 盤點 · 1212 切頁模板預發 |
| 14 | Customer status | 1401 啟用 · 1402 停用 |
| 15 | Customer type | 1501 維護 · 1502 經銷商 · 1503 商家總公司 |
| 16 | Sharing method | 1601 新建 · 1602 覆蓋 · 1603 增量 |
| 17 | Operation type | 1701 綁定 · 1702 解綁 |
| 18 | Terminal type | 1801 PC · 1802 iOS · 1803 Android |
| 19 | Task execution status | 1901 初始化 · 1902 掛起 · 1903 執行中 · 1904 部分成功 · 1905 全部成功 · 1906 失敗 |
| 20 | Item sync method 商品同步方式 | 2001 接口 · 2002 本地文件 · 2003 文件導入 · 2004 FTP 文件 · 2005 數據庫 |
| 21 | Expiration time type | 2101 關聯日誌 · 2102 集成日誌 · 2103 任務日誌 |
| 22 | System configuration level | 2201 經銷商 · 2202 維護 · 2203 商家 · 2204 店舖 |
| 23 | Data sync interface type | 2301 文件讀寫 · 2302 視圖讀寫 |
| 24 | Database type | 2401 MySQL · 2402 SqlServer · 2403 Oracle |
| 25 | Item sync file type | 2501 EXCEL · 2502 CSV · 2503 TXT |
| 26 | System message type | 2601 操作訊息 · 2602 錯誤訊息 |
| 27 | FTP mode | 2701 主動 · 2702 被動 |
| 28 | LED blinking color | 2801 紅 · 2802 綠 · 2803 藍 · 2804 黃 · 2805 青 |