跳轉到

代碼一覽表

代碼也可透過 API 取得:標準交易型態、其他標準代碼。

交易型態(transaction-types)

code 中文 is_revenue amount_sign 說明
SALE 銷售 true +1 一般銷售
RETURN 退貨 true -1 退回商品(含退款)
REFUND 退款 true -1 僅退款、不退貨
EXCHANGE 換貨 true ±1(API 回傳 null) 同一張單退回舊品、換成新品,見記錄規則
VOID 作廢 false 0 結帳前或同日作廢,不計營收
GIFT_CARD_SALE 禮物卡售出 false +1 屬預收,不計營收
GIFT_CARD_REDEEM 禮物卡兌換 true +1 以禮物卡付款的銷售
DEPOSIT 訂金 false +1 預收款
PAID_IN 錢櫃收入 false +1 非銷售現金收入
PAID_OUT 錢櫃支出 false -1 非銷售現金支出
NO_SALE 開錢櫃未交易 false 0 稽核用
TRAINING 訓練交易 false 0 不計入任何報表
OTHER 其他 false 0 須人工確認

訂單類型(order-types)

須使用下列值。

code 中文
DINE_IN 內用
TO_GO 外帶
PICK_UP 自取
DELIVERY 外送
ONLINE 線上
KIOSK 自助機
THIRD_PARTY 第三方平台

Note

order_type 建議填取餐方式(DINE_IN、TO_GO、PICK_UP、DELIVERY);下單管道請以 order_source 表示。見記錄規則。

下單管道(order-sources)

建議代碼表:能對應時請用下列代碼,對應不到時可送自家原始值(自由字串,最長 50 字元)。

code 中文 說明
POS 櫃台 POS 店員在 POS 上點單
KIOSK 自助點餐機 顧客在店內自助機點單
QR_ORDER 掃碼點餐 顧客掃桌邊/店內 QR Code 用手機點單
WEB 品牌官網 品牌自有網站線上訂單
APP 品牌 App 品牌自有 App 訂單
PHONE 電話訂餐 電話訂單,由店員輸入
DELIVERY_PLATFORM 第三方平台 Uber Eats、DoorDash、foodpanda 等,平台名稱放 order_source_detail
CATERING 團體/企業訂餐 大量訂購、企業團膳
OTHER 其他 已知但不屬於上述的管道
  • 不在表內的值照收、不報錯。
  • 未送(null 或省略)視為未知,不會預設為 POS。

付款工具(payment-methods)

須使用下列值。

code 中文
CASH 現金
CREDIT_CARD 信用卡
DEBIT_CARD 簽帳金融卡
GIFT_CARD 禮物卡
MOBILE_WALLET 行動支付
BANK_TRANSFER 銀行轉帳
THIRD_PARTY 第三方支付
VOUCHER 票券
LOYALTY_POINTS 會員點數
OTHER 其他

收付款性質(payment-types)

建議代碼表:能對應時請用下列代碼,對應不到時可送自家原始值(自由字串,最長 50 字元)。SALE 與 REFUND 為所有合作夥伴必須支援的基本值。

code 中文 方向 必要 說明
SALE 銷貨收款 +1 Y 一般銷售收款
REFUND 銷貨退回/退款 -1 Y 退貨或退款付出的金額;original_payment_id 指向原付款
VOID 付款作廢 -1 結帳後、日結前取消的付款(如當日取消刷卡);original_payment_id 指向原付款
DEPOSIT 暫收/訂金 +1 預收款,不計營收(例:預訂蛋糕先收訂金)
DEPOSIT_APPLIED 暫收沖銷 +1 以先前收的訂金/暫收折抵本次消費,沒有新的現金流入;original_payment_id 指向當初的 DEPOSIT
DEPOSIT_REFUND 暫收退還 -1 退還訂金/暫收款
TIP_ADJUST 小費調整 +1 刷卡後追加或修改小費
ADJUSTMENT 調整 ±1 手動更正、尾差調整;方向以 amount 前加負號表示(本類例外允許負數)
OTHER 其他 — 已知但不屬於上述的性質
  • 付款 amount 一律填正數,方向依上表(ADJUSTMENT 例外)。
  • 使用自由字串時,請事先告知總部其意義與收付方向。

稅別(tax-categories)

code 中文
STANDARD 標準稅率
REDUCED 減免稅率
ZERO 零稅率
EXEMPT 免稅

其他列舉值

欄位 值
Store.status、Product.status ACTIVE、INACTIVE
Product.product_type、TradeItem.product_type SINGLE(單點)、COMBO(套餐)、SIDE(附餐)、DRINK(飲料)、MODIFIER(加購選項)
TradeRecord.status OPEN、COMPLETED、VOIDED、REFUNDED、PARTIALLY_REFUNDED
對帳 status NOT_RECEIVED、RECEIVED、MATCHED、MISMATCHED
寫入回應 status ACCEPTED、ALREADY_RECEIVED