ERP/SCM External API

讓產品、庫存、供應鏈與訂單追蹤可以被外部系統安全查詢。

此教學頁依 ERP/SCM 原始碼路由整理。對外 API 聚焦產品目錄、庫存狀態與訂單追蹤；完整採購、銷售、倉儲、財務與工作流 API 屬內部管理面，需要正式授權。

產品目錄查詢產品、SKU、分類與對外顯示資料。

庫存狀態查詢庫存、可用量、低庫存與倉別摘要。

訂單追蹤依 orderId 取得履約與物流狀態。

內部 API採購、銷售、倉儲、財務、工作流與 AI 分析需登入授權。

對外 API Endpoint

方法	路徑	用途	參數
GET	`/health`	API 健康狀態與版本資訊。	-
GET	`/catalog`	列出可對外串接的資源與端點。	-
GET	`/products`	產品清單查詢。	`keyword`, `page`, `pageSize`
GET	`/inventory`	庫存明細查詢。	`warehouseId`, `lowStock`, `page`, `pageSize`
GET	`/inventory/summary`	庫存總覽與低庫存摘要。	`warehouseId`
GET	`/order-tracking/{orderId}`	查詢訂單履約、出貨與交付狀態。	`orderId`

快速測試

curl -sS "https://erp-scm.sun-bd.com/api/external/v1/health" \
  -H "X-API-Key: YOUR_API_KEY"

curl -sS "https://erp-scm.sun-bd.com/api/external/v1/products?keyword=pump&page=1&pageSize=20" \
  -H "X-API-Key: YOUR_API_KEY"

庫存查詢

curl -sS "https://erp-scm.sun-bd.com/api/external/v1/inventory?lowStock=true" \
  -H "X-API-Key: YOUR_API_KEY"

curl -sS "https://erp-scm.sun-bd.com/api/external/v1/order-tracking/SO-2026-0001" \
  -H "X-API-Key: YOUR_API_KEY"

內部管理 API 群組

以下 API 在程式碼中存在，但屬於 ERP/SCM 管理系統內部功能，需要正式登入、租戶與權限控制，不建議作為匿名對外教學入口：

/api/v1/products, /api/v1/customers, /api/v1/suppliers, /api/v1/warehouses
/api/v1/purchase-requests, /api/v1/purchase-orders, /api/v1/goods-receipts
/api/v1/sales-orders, /api/v1/shipments, /api/v1/return-orders
/api/v1/inventory, /api/v1/analytics, /api/v1/finance, /api/v1/workflows

安全與串接建議

API key 僅放在後端服務，不放在瀏覽器、App 或靜態頁。
外部系統先串 /health 與 /catalog，再串正式資料查詢。
會員登入請使用集中會員 API；付款與點數請使用 Payment Points API。