| 合作夥伴(partner) |
使用本 API 推送資料的各國合作夥伴或其 POS 廠商。每個合作夥伴有一個 partner_id,由總部指派,並由 API 金鑰自動識別,不需在請求中帶入。 |
partner_id |
合作夥伴代碼,例 NCMD001。 |
store_id |
門市代碼,由合作夥伴自訂,合作夥伴內唯一。合作夥伴只能推送/查詢總部登記給它的門市。 |
營業日(business_date) |
交易所屬的營業日期,格式 YYYY-MM-DD,以門市當地日期為準,並依 workday_start 切日。 |
workday_start |
門市營業日的切日時間(門市當地時間 HH:mm)。例如 04:00 表示凌晨 4 點前的交易算前一營業日。 |
| 批次(batch) |
一次寫入請求送出的一組資料,最多 500 筆。 |
batch_id |
每個寫入請求的唯一識別碼(UUID),用於冪等:同一 batch_id 重送不會重複寫入。見冪等與重試。 |
batch_seq |
同一門市同一營業日的交易批次序號,從 1 開始。 |
version |
交易或商品的版本號,正整數,每次異動 +1。總部以 version 最大者為準。 |
| 標準代碼(standard code) |
總部定義的統一代碼,例如交易型態 SALE、REFUND。 |
| 來源代碼(source code) |
合作夥伴 POS 原本使用的代碼,例如 Refund。透過交易型態對照轉成標準代碼。 |
| decimal string |
以字串表示的十進位數,例 "1234.50"。所有金額、數量、稅率都用這種格式,以避免浮點數誤差。 |
| 多語系文字(localized text) |
以 BCP 47 語系為 key 的物件,例 {"en-US":"Fries","zh-TW":"薯條"}。 |
| 套餐(combo) |
由多個品項組成、以套餐價販售的商品(product_type = COMBO)。 |
| 選項群組(modifier group) |
商品可選的口味、加料或升級選項,例如「選擇口味」「加購調味粉」。 |
| 日結(daily close) |
門市一個營業日的結束。合作夥伴送完該日所有交易後,送出日結與控制總數。 |
| 控制總數(control totals) |
日結時合作夥伴自行計算的筆數與金額合計,供總部比對。 |
| 對帳(reconciliation) |
總部以收到的交易重新計算控制總數,與日結送來的數字比對,結果可用查詢對帳結果取得。 |