首頁 / 開發者 API 文檔
DEVELOPERS

開發者 API:完整接口文檔

想點就點把商家端接口全面開放:你可以只接一個場景(例如把訂單同步進自家 ERP),亦可以全量自建前端。以下為全部端點,支持搜索;字段以實際返回為準。

通用約定

所有接口均為 HTTPS POST,請求體 application/json(部分表單接口兼容 application/x-www-form-urlencoded)。

統一返回結構:{"code": 200, "msg": "成功", "data": {...}}。code 200 為成功,其餘為業務錯誤;HTTP 狀態碼正常時恆為 200。

金額一律為字符串、兩位小數(如 "88.00"),幣種跟隨門店設置。時間格式 YYYY-MM-DD HH:mm:ss,歸屬日以完單時間為準。

code含義
200成功
100參數缺失或不合法
101未登入或 token 過期(請重新登入)
102無權限執行該操作
429請求過於頻繁,請稍後重試
500服務異常(請附 out_trade_no/時間反饋給我們)
認證方式

登入接口成功後,服務端以 Cookie: token(JWT)下發憑證,有效期 30 天、每次請求自動續期;後續請求需攜帶該 Cookie(瀏覽器自動處理;後端對接方請自行保存並回傳)。

顧客端使用微信授權或手機驗證碼登入;商家後台/POS 使用員工帳號登入。兩類 token 權限互不相通。路徑前綴為 /api/login、/api/payment、/api/banner、/api/menu、/api/store、/api/cart 的公開讀取接口可匿名訪問,其餘接口未登入返回 code 101。

測試環境:https://orderstaging.teamotto.net(示範店 Pizza King Mong Kok,store_id=13,演示帳號向我們申請)。

訂單狀態速查
status含義
0等待付款
1 / 10 / 11 / 21已確認,準備中(11 堂食、21 外賣)
22外賣待取餐(含取餐號 number_pick_up)
12 / 23 / 24 / 25已完成(堂食清枱/外賣核銷)
41 / 42已取消/已作廢

支付渠道編碼:1 微信支付、2 QFPay、91 現金、92 八達通、93 FPS、94 信用卡。顧客下單後以 out_trade_no 輪詢 Order/getInfoByOutTradeNo(建議 4 秒間隔)獲取狀態推進。

登入認證Authentication

無需登入/api/Login/postLoginForWeChat顧客微信授權登入(小程序 code 換 openid)。
參數
code

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Login/postLoginForPhone顧客手機驗證碼登入。
參數
phone_codephone_number

請求:HTTPS POST;返回統一結構 {code, msg, data}。

顧客登入/api/Login/postLogout登出並清除 token。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Login/postLoginForTest測試環境登入(僅測試庫可用)。
參數
user_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Login/postLoginForStaff員工/商家後台登入。成功後以 Cookie(token)下發 JWT,有效期 30 天並自動續期。
參數
usernamepasswordbrand

請求:HTTPS POST;返回統一結構 {code, msg, data}。

門店與枱位Stores & Tables

無需登入/api/Store/getBrandByHostForClient按域名反查品牌資料(顧客端進入用)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Store/getInfoForStaff讀取當前員工所屬門店資料。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Store/postEditForStaff更新門店資料(營業狀態、公告、外賣設置等)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Store/getInfoById讀取指定門店公開資料。
參數
store_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Store/getListForPage門店列表(支持經緯度排序與搜索),供連鎖總覽與顧客端選店。
參數
pagerowskeywordbrand_idlatitudelongitudesort_type

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Store/getLocation讀取門店定位資料。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Store/getSeatListForPageForStaff枱位分頁列表。
參數
pagerowskeyword

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Store/getSeatListAllForStaff全部枱位(不過濾)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Store/postSeatAddMultipleForStaff批量新增枱位。
參數
array_list

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Store/postSeatDeleteForStaff刪除枱位。
參數
store_seat_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

橫額廣告Banners

無需登入/api/Banner/getListAllByStoreId讀取門店橫額廣告(按位置)。
參數
store_idposition

請求:HTTPS POST;返回統一結構 {code, msg, data}。

菜品Menu Items

無需登入/api/Menu/getInfoById顧客端讀取菜品詳情。
參數
menu_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getInfoByIdForStaff員工端讀取菜品詳情(含成本、庫存設置)。
參數
menu_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getListForPageForStaff菜品分頁搜索(商家後台/POS 用)。
參數
pagerowskeywordmenu_category_idstatus

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Menu/getListAllByMenuCategoryId按分類讀取菜品列表(type:1 堂食 2 自取外賣)。
參數
menu_category_idtype

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/postEditForStaff新增或編輯菜品(含規格 list_spec、選配組 list_attribute、套餐 list_combo;未出現的舊規格/選配組會被移除)。
參數
menu_idlist_attributelist_comboclear_spec

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/postModifyStatusAllForStaff批量上下架菜品。
參數
status

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/postDeleteForStaff刪除菜品。
參數
menu_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getCategoryListAllByStoreId讀取門店全部分類(管理視圖,含僅配組分類)。
參數
store_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Menu/getCategoryListAllWithMenuByStoreId顧客端菜單:分類連菜品一併返回(僅配組分類不出現)。
參數
store_idtype

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getCategoryListAllWithMenuForStaff門店端點餐菜單(分類連菜品)。
參數
type

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getMenuVersionForStaff菜品數據版本戳(POS 緩存增量同步用)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getDailyConfigForStaff讀取當日庫存/特價配置。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/postMenuSupplyForStaff設置菜品當日供應(售罄補貨、每日默認庫存)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Menu/getDailyLogForStaff當日庫存變更日誌。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

菜品分類Menu Categories

員工登入/api/MenuCategory/getInfoByIdForStaff分類詳情。
參數
menu_category_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/MenuCategory/getListForPageForStaff分類分頁列表。
參數
pagerowskeywordstatusdeleted

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/MenuCategory/postEditForStaff新增/編輯分類(含 supply 時段、茶位費、僅配組標誌)。
參數
menu_category_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/MenuCategory/postDeleteForStaff刪除分類(軟刪)。
參數
menu_category_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/MenuCategory/postSetTimeBatchForStaff批量設置分類供應時段。
參數
start_timeend_time

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/MenuCategory/getDeletedListForStaff已刪除分類列表(回收站)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/MenuCategory/postRestoreForStaff還原已刪除分類。
參數
menu_category_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

購物車Cart

無需登入/api/Cart/getListAll按門店+枱位讀取購物車。
參數
store_idnumber_seat

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Cart/postEdit新增/修改購物車條目。
參數
cart_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Cart/postDelete刪除購物車條目。
參數
cart_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Cart/postDeleteAll清空購物車。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

訂單Orders

無需登入/api/Order/getInfoByOutTradeNo按商戶單號查訂單(顧客端輪詢狀態)。
參數
out_trade_no

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getInfoForStatisticForStaff營業統計總覽(按日)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getInfoForStatisticTwoForStaff營業統計(餐段/渠道維度)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getInfoForStatisticThreeForStaff營業統計(熱銷菜品維度)。
參數
date

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getInfoForStatisticChartForStaff統計圖表數據(指定範圍與渠道)。
參數
rangechanneldate

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getInfoByOutTradeNoForStaff員工端按商戶單號查訂單詳情。
參數
out_trade_no

請求:HTTPS POST;返回統一結構 {code, msg, data}。

無需登入/api/Order/getListForPage訂單分頁列表(顧客端「我的訂單」)。
參數
pagerowskeywordstore_idtypestatusis_pending

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getListForPageForStaff門店訂單分頁(狀態、餐段、時間範圍過濾)。
參數
pagerowskeywordtypestatusis_pendingstart_timeend_time

請求:HTTPS POST;返回統一結構 {code, msg, data}。

顧客登入/api/Order/postAddForUser顧客下單(堂食或自取外賣;返回 out_trade_no 供收銀台使用)。
參數
array_item

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postAddForStaff門店端代客落單(POS/平板)。
參數
array_item

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postSyncOfflineForStaff(說明整理中)
參數
client_uuidplaced_atpayment_methodpaid_amountarray_item

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postModifyForPaidForStaff標記訂單已付款(現金/八達通/FPS 等離線支付方式)。
參數
out_trade_nopayment_methodpaid_amount

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getTodayLiveForStaff今日實時營業動態(門店大屏/儀表盤)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/getAiInsightForStaffAI 營業洞察摘要。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postModifyForCancelForStaff取消/作廢訂單(附原因)。
參數
out_trade_nocancel_reason

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postModifyForCompletePackForStaff外賣出品完成(進入待取餐,派取餐號)。
參數
out_trade_nonumber_pick_up

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postScanResolveForStaff掃碼解析(出餐碼/取餐核銷碼,支持丟字兜底)。
參數
scan_text

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postPrintForStaff手動補打收據/後廚單。
參數
out_trade_no

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postModifyForItemRefundForStaff單品退菜/退款。
參數
order_item_idquantityrefund_reason

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postModifyForSeatClearedForStaff堂食枱位清理完成(訂單歸入已完成)。
參數
out_trade_no

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Order/postItemModifyForProcessedForStaff單品出品完成(KDS 逐項出餐)。
參數
order_item_idorder_item_combo_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

支付回調Payment Callbacks

平台回調/api/Payment/notifyWeChatPayGlobal微信支付服務端回調(僅支付平台調用,第三方勿接)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

平台回調/api/Payment/notifyQFPayGlobalQFPay 支付回調(僅支付平台調用)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

支付設置Payment Settings

員工登入/api/PaymentConfig/getForStaff讀取門店支付設置(密鑰以掩碼返回)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/PaymentConfig/postForStaff保存門店支付設置(QFPay 商戶參數等)。
參數
qfpay_mchidqfpay_codeqfpay_keyqfpay_currencyqfpay_status

請求:HTTPS POST;返回統一結構 {code, msg, data}。

打印機Printers

員工登入/api/Printer/getInfoByIdForStaff打印機詳情。
參數
printer_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Printer/getListForPageForStaff打印機分頁列表(type:1 前廳收據 2 後廚標籤)。
參數
pagerowskeywordtypestatus

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Printer/postEditForStaff新增/編輯打印機(雲打印參數、綁定菜品)。
參數
printer_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Printer/postDeleteForStaff刪除打印機。
參數
printer_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Printer/getCloudDefaultsForStaff雲打印默認模板與參數。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Printer/getCloudDevicesForStaff查詢雲打印平台在線設備。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Printer/postTestPrintForStaff發送測試頁。
參數
printer_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工Staff

員工登入/api/Staff/getInfoForStaff當前登入員工資料。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Staff/getInfoByIdForStaff按 ID 讀取員工資料。
參數
staff_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Staff/getListForPageForStaff員工分頁列表。
參數
pagerowskeywordstatus

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Staff/postEditForStaff新增/編輯員工(角色、門店歸屬)。
參數
staff_id

請求:HTTPS POST;返回統一結構 {code, msg, data}。

員工登入/api/Staff/postModifyPasswordForStaff(說明整理中)
參數
old_passwordnew_password

請求:HTTPS POST;返回統一結構 {code, msg, data}。

顧客Customers

顧客登入/api/User/getInfo當前顧客資料(積分、標籤)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

顧客登入/api/User/getStoreListForPageForOrder顧客可下單的門店列表。
參數
pagerows

請求:HTTPS POST;返回統一結構 {code, msg, data}。

文件上傳Upload

員工登入/api/Upload/uploadImageForStaff上傳圖片(菜品圖、店鋪圖;自動壓縮並生成縮圖)。
參數
(無顯式參數,登錄態與請求體為準)

請求:HTTPS POST;返回統一結構 {code, msg, data}。

文檔與代碼同源。本頁由生產服務代碼自動整理,每個季度跟版更新。若你對接時發現字段缺失或行為與文檔不符,歡迎告訴我們——這是 bug,我們會修。
INTEGRATION

串接方案半小時講得清

說出你現有的系統與想同步的數據,我們直接給方案(如涉及開發工作量,一併報價)。

預約技術洽談