標準交易型態¶

GET /reference/transaction-types

取得總部標準交易型態清單。合作夥伴依此清單建立自家交易代碼的對照表。

權限¶

API 金鑰（x-functions-key）

Request¶

Header	必填	說明
x-functions-key	Y	`{api_key}`

Response¶

200 OK

欄位	型別	說明
version	string	代碼表版本（日期），代碼有異動時會變
data	array	交易型態清單
data[].code	string	標準代碼
data[].name	localized text	多語系名稱
data[].is_revenue	boolean	是否計入營收
data[].amount_sign	integer \| null	金額方向：`1`、`-1`、`0`；`EXCHANGE` 依品項正負，回傳 `null`
data[].description	string	說明

{
  "version": "2026-10-15",
  "data": [
    { "code": "SALE",   "name": { "en-US": "Sale",   "zh-TW": "銷售" }, "is_revenue": true, "amount_sign": 1,  "description": "Normal sale" },
    { "code": "REFUND", "name": { "en-US": "Refund", "zh-TW": "退款" }, "is_revenue": true, "amount_sign": -1, "description": "Refund without returning goods" }
  ]
}

完整代碼清單見代碼一覽表。

錯誤¶

HTTP	code	情況
401	UNAUTHORIZED	未帶 API 金鑰或金鑰錯誤

注意事項¶

Note

請在上線前取得一次。總部更新代碼時會另行通知，屆時請重新取得並檢查 version，必要時更新對照表。