跳轉到

POS Ingest API 技術文件

POS Ingest API 是總部提供給各國合作夥伴(或其 POS 廠商)的資料彙總 API。合作夥伴以此 API 推送門市、商品、交易與日結資料給總部,不綁定特定 POS 廠商,各國共用同一套規格。

服務特性

  • 推送模式:由合作夥伴主動呼叫總部 API,每日批次推送,非即時串流。
  • 非同步寫入:資料通過格式驗證即回 202 Accepted;資料正確性以日結對帳結果為準。
  • 冪等設計:每個寫入請求都帶 batch_id,網路中斷後可安全重送,不會重複入帳。
  • 國際化:欄位與代碼一律英文;國家、幣別、時區、語言採 ISO/IANA/BCP 47 標準;金額以門市當地幣別記錄,不做匯率換算。

環境

環境 Base URL
正式 https://func-posingest-dev.azurewebsites.net/pos/v1

端點一覽

Method Path 用途 角色
GET /health 健康檢查 不需金鑰
GET /reference/transaction-types 總部標準交易型態清單 API 金鑰
GET /reference/{code_type} 其他標準代碼 API 金鑰
PUT /mappings/transaction-types 上傳自家交易代碼對照(整份取代) API 金鑰
GET /mappings/transaction-types 查詢目前的對照表 API 金鑰
PUT /stores 門市主檔批次 upsert API 金鑰
PUT /products 商品主檔批次 upsert(只送異動) API 金鑰
POST /trade-records 交易批次推送 API 金鑰
POST /daily-close 日結完成信號+控制總數 API 金鑰
GET /daily-close/{store_id}/{business_date} 查詢對帳結果 API 金鑰

開始串接

  1. 閱讀串接流程,了解推送順序。
  2. 向總部取得帳號資訊與測試門市代碼,見環境與測試。
  3. 向總部取得 API 金鑰,見驗證與授權。
  4. 熟悉共通規範(金額、時間、幣別格式與個資限制)。
  5. 參考範例程式完成一日資料推送與對帳。