ccairn

CLI 參考

cairn <resource> <verb>255 命令,依 resource 分組。每條標出對應的 /api/v1 端點;寫入命令對 production target 需 --confirm。按 ⌘K 搜尋。

cairn accrual-ledger

掛帳台帳:四區塊派生、梯次彙總(純讀)

cairn accrual-ledger get

單一期間掛帳台帳四區塊

參數

--period
旗標 · 必填

出團月(格式 YYYY-MM,Asia/Taipei 時區)

--json
旗標 · 選填
對應端點/api/v1/accrual-ledger
範例
cairn accrual-ledger get --period
cairn accrual-ledger departure-summary

梯次彙總區塊(收入/成本/毛利)

參數

--period
旗標 · 必填

出團月(格式 YYYY-MM,Asia/Taipei 時區)

--json
旗標 · 選填
對應端點/api/v1/accrual-ledger/departure-summary
範例
cairn accrual-ledger departure-summary --period

cairn agencies

同業:查詢、明細、指派候選、匯出

cairn agencies list

列出/篩選同業

參數

--status
旗標 · 選填

同業狀態篩選(active 啟用中/archived 已封存;省略為全部)

--owner <userId>
旗標 · 選填

負責業務篩選(傳明確使用者 ID;none=只列尚未指派負責業務者;all 或省略=全部)

--has-tax-id
旗標 · 選填

是否有統一編號篩選(yes 僅列有統編者/no 僅列無統編者)

--json
旗標 · 選填
對應端點/api/v1/agencies
範例
cairn agencies list
cairn agencies get

單一同業完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/agencies/:param
範例
cairn agencies get <id>
cairn agencies assignable-staff

負責業務指派候選清單

參數

--json
旗標 · 選填
對應端點/api/v1/agencies/assignable-staff
範例
cairn agencies assignable-staff
cairn agencies export

匯出同業名單(當前篩選視圖)

參數

--status
旗標 · 選填

同業狀態篩選(active 啟用中/archived 已封存;省略為全部)

--owner <userId>
旗標 · 選填

負責業務篩選(傳明確使用者 ID;none=只列尚未指派負責業務者;all 或省略=全部)

--has-tax-id
旗標 · 選填

是否有統一編號篩選(yes 僅列有統編者/no 僅列無統編者)

--json
旗標 · 選填
對應端點/api/v1/agencies/export
範例
cairn agencies export
cairn agencies create

新增同業(鏡射 createAgency;agency.manage)

參數

--name <name>
旗標 · 必填

同業公司名稱(B2B 旅行社或個人團主名稱)

--tax-id
旗標 · 選填

統一編號(選填)

--contact-name
旗標 · 選填

主要聯絡人姓名(選填)

--phone
旗標 · 選填

聯絡電話(選填)

--email
旗標 · 選填

聯絡 Email(選填;留空字串視為未填)

--address
旗標 · 選填

公司地址(選填)

--payment-term
旗標 · 選填

付款條件/帳期約定(選填,如月結 30 天)

--owner <userId>
旗標 · 選填

負責業務篩選(傳明確使用者 ID;none=只列尚未指派負責業務者;all 或省略=全部)

--status
旗標 · 選填

同業狀態篩選(active 啟用中/archived 已封存;省略為全部)

--note
旗標 · 選填

內部備註(選填)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/agencies
範例
cairn agencies create --name <name>
cairn agencies update

更新同業(真 partial;鏡射 updateAgency;agency.manage)

參數

<id>位置參數 · 必填
--name
旗標 · 選填

同業公司名稱(省略則不更動)

--tax-id
旗標 · 選填

統一編號(省略則不更動)

--contact-name
旗標 · 選填

主要聯絡人姓名(省略則不更動)

--phone
旗標 · 選填

聯絡電話(省略則不更動)

--email
旗標 · 選填

聯絡 Email(省略則不更動;空字串視為清空)

--address
旗標 · 選填

公司地址(省略則不更動)

--payment-term
旗標 · 選填

付款條件/帳期約定(省略則不更動)

--owner <userId>
旗標 · 選填
--status
旗標 · 選填

同業狀態(active 啟用中/archived 已封存;省略則不更動)

--note
旗標 · 選填

內部備註(省略則不更動)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/agencies/:param
範例
cairn agencies update <id>
cairn agencies archive

下架同業(鏡射 setAgencyStatus archived;agency.manage)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/agencies/:param/status
範例
cairn agencies archive <id>
cairn agencies restore

上架同業(鏡射 setAgencyStatus active;agency.manage)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/agencies/:param/status
範例
cairn agencies restore <id>

cairn audit

稽核日誌:查詢、統計(唯讀)

cairn audit list

列出/篩選稽核紀錄

參數

--action
旗標 · 選填

動作代碼篩選,例如 order.update(比對稽核事件的動作)

--actor
旗標 · 選填

操作者篩選,比對執行該動作的使用者 ID

--entity
旗標 · 選填

目標實體篩選,比對被操作對象的類型或 ID

--from
旗標 · 選填

起始時間(ISO 8601),僅回傳此時間之後的事件

--to
旗標 · 選填

結束時間(ISO 8601),僅回傳此時間之前的事件

--limit
旗標 · 選填

回傳筆數上限,最多 1000 筆

--json
旗標 · 選填
對應端點/api/v1/audit/log
範例
cairn audit list
cairn audit stats

稽核 KPI 統計

參數

--actor
旗標 · 選填

操作者使用者 ID,指定時將統計數據限縮至該操作者

--json
旗標 · 選填
對應端點/api/v1/audit/stats
範例
cairn audit stats

cairn control

團控:梯次列表、名單、驗證、分房、財務、報表

cairn control departures

近期梯次主列表(團控面板)

參數

--range
旗標 · 選填

時間視窗:future_60(未來 60 天)/ this_month(本月)/ next_month(下個月),預設不限

--trip
旗標 · 選填

行程 ID,只看該行程的梯次

--status
旗標 · 選填

梯次狀態篩選(如 open / closed)

--attention
旗標 · 選填

設為 true 時只回傳付款或同意書有異常、需要關注的梯次

--json
旗標 · 選填
對應端點/api/v1/departures/control
範例
cairn control departures
cairn control manifest

梯次旅客名單

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/manifest
範例
cairn control manifest <depId>
cairn control validation

梯次旅客資料驗證摘要

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/validation-summary
範例
cairn control validation <depId>
cairn control lottery-orders

梯次抽籤訂單清單

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/lottery-orders
範例
cairn control lottery-orders <depId>
cairn control rooms

梯次分房檢視

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/rooms
範例
cairn control rooms <depId>
cairn control room-stats

多梯次分房進度統計

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/room-stats
範例
cairn control room-stats <depId>
cairn control finance

梯次財務摘要(唯讀)

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/finance-summary
範例
cairn control finance <depId>
cairn control template-costs

梯次成本範本列

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/template-costs
範例
cairn control template-costs <depId>
cairn control manifest-export

梯次旅客名單匯出(csv|json)

參數

<depId>位置參數 · 必填
--format
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/manifest
範例
cairn control manifest-export <depId>
cairn control rooming-export

分房表匯出(csv|json)

參數

<depId>位置參數 · 必填
--format
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/rooming-export
範例
cairn control rooming-export <depId>
cairn control cost-add

登記梯次成本(現場作業)

參數

<depId>位置參數 · 必填
--category <c>
旗標 · 必填

成本科目類別,決定歸入哪個分類帳

--amount <twd>
旗標 · 必填
--vendor
旗標 · 選填
--desc
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/costs
範例
cairn control cost-add <depId> --category <c> --amount <twd>
cairn control cost-update

編輯梯次成本(會計)

參數

<depId>位置參數 · 必填
--cost <costId>
旗標 · 必填
--category <c>
旗標 · 必填

成本科目類別,決定歸入哪個分類帳

--amount <twd>
旗標 · 必填
--vendor
旗標 · 選填
--desc
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/costs/:param
範例
cairn control cost-update <depId> --cost <costId> --category <c> --amount <twd>
cairn control cost-rm

刪除梯次成本(會計)

參數

<depId>位置參數 · 必填
--cost <costId>
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/costs/:param
範例
cairn control cost-rm <depId> --cost <costId>
cairn control template-apply

套用行程綁定範本到本梯次(冪等)

參數

<depId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/template-costs/apply
範例
cairn control template-apply <depId>
cairn control template-override

手改某範本成本列金額(停自動重算)

參數

<depId>位置參數 · 必填
--id <costId>
旗標 · 必填

範本成本列 ID

--amount <twd>
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/template-costs/:param/override
範例
cairn control template-override <depId> --id <costId> --amount <twd>
cairn control template-clear-override

重設範本成本列為範本算法(清手改鎖)

參數

<depId>位置參數 · 必填
--id <costId>
旗標 · 必填

範本成本列 ID

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/template-costs/:param/clear-override
範例
cairn control template-clear-override <depId> --id <costId>
cairn control cost-to-payable

成本轉請款(建立 payable)

參數

<depId>位置參數 · 必填
--cost-ids <a,b>
旗標 · 必填

要轉成請款單的成本列 ID 清單,至少一筆

--payee-type <supplier|guide|staff_commission|other>
旗標 · 必填

受款人類型:supplier(供應商)/ guide(領隊)/ staff_commission(員工佣金)/ other(其他)

--payee-name <n>
旗標 · 必填

受款人姓名/戶名(必填)

--bank-account
旗標 · 選填
--bank-name
旗標 · 選填
--tax-id
旗標 · 選填
--submit
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/payables
範例
cairn control cost-to-payable <depId> --cost-ids <a,b> --payee-type <supplier|guide|staff_commission|other> --payee-name <n>
cairn control room-add

建立梯次房間

參數

<depId>位置參數 · 必填
--label <l>
旗標 · 必填
--type <t>
旗標 · 必填
--beds <n>
旗標 · 必填
--base-cost
旗標 · 選填
--upgrade-fee
旗標 · 選填
--notes
旗標 · 選填

房間備註

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/rooms
範例
cairn control room-add <depId> --label <l> --type <t> --beds <n>
cairn control room-update

編輯房間

參數

<depId>位置參數 · 必填
--room <roomId>
旗標 · 必填
--label
旗標 · 選填
--type
旗標 · 選填
--beds
旗標 · 選填
--notes
旗標 · 選填

房間備註;給 null 清空、未給則不變

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/rooms/:param
範例
cairn control room-update <depId> --room <roomId>
cairn control room-rm

刪除房間

參數

<depId>位置參數 · 必填
--room <roomId>
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/rooms/:param
範例
cairn control room-rm <depId> --room <roomId>
cairn control room-assign

指派旅客進房

參數

--room <roomId>
旗標 · 必填
--traveler <travelerId>
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/rooms/:param/travelers
範例
cairn control room-assign --room <roomId> --traveler <travelerId>
cairn control room-unassign

把旅客移出房間

參數

--traveler <travelerId>
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/rooms/travelers/:param
範例
cairn control room-unassign --traveler <travelerId>
cairn control room-auto-pair-preview

auto-pair 建議分組預覽(純讀取;供 apply 取 travelerIds)

參數

<depId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/departures/:param/rooms/auto-pair-preview
範例
cairn control room-auto-pair-preview <depId>
cairn control room-auto-pair-apply

套用 auto-pair 建議分組(單一交易建房+整組指派)

參數

<depId>位置參數 · 必填
--travelers <a,b,c>
旗標 · 必填
--type
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/rooms/auto-pair-apply
範例
cairn control room-auto-pair-apply <depId> --travelers <a,b,c>
cairn control lottery-resolve

抽籤手動裁決(won|lost)

參數

<orderId>位置參數 · 必填
--outcome <won|lost>
旗標 · 必填

抽籤裁決結果:won 中籤確認、lost 未中籤(啟動備案或取消)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/lottery/resolve
範例
cairn control lottery-resolve <orderId> --outcome <won|lost>
cairn control lottery-set-mode

設定梯次分配模式(fcfs|lottery)

參數

<depId>位置參數 · 必填
--mode <fcfs|lottery>
旗標 · 必填

分配模式:fcfs(先到先得)或 lottery(抽籤)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/allocation-mode
範例
cairn control lottery-set-mode <depId> --mode <fcfs|lottery>
cairn control prep-checklist

設定行前總檢查項勾選

參數

<depId>位置參數 · 必填
--item <key>
旗標 · 必填
--checked <true|false>
旗標 · 必填

該檢查項目是否已完成勾選

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/checklist
範例
cairn control prep-checklist <depId> --item <key> --checked <true|false>
cairn control prep-document

upsert 證件追蹤狀態

參數

<depId>位置參數 · 必填
--type <docType>
旗標 · 必填
--apply-status
旗標 · 選填

申辦狀態:todo(待辦)/ applying(申請中)/ approved(已核准)

--file-ready
旗標 · 選填

文件檔案是否已備妥

--note
旗標 · 選填

備註;給 null 清空

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/documents
範例
cairn control prep-document <depId> --type <docType>
cairn control prep-deadlines

設定梯次期限警戒(登山專屬;全量取代,空值=清除)

參數

<depId>位置參數 · 必填
--permit-apply
旗標 · 選填

入山申請截止日(ISO 日期);傳空字串或省略則清除此期限

--permit-download
旗標 · 選填

入山證下載截止日(ISO 日期);傳空字串或省略則清除此期限

--climbing-insurance
旗標 · 選填

登山險送保截止日(ISO 日期);傳空字串或省略則清除此期限

--liability-insurance
旗標 · 選填

旅責險送保截止日(ISO 日期);傳空字串或省略則清除此期限

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/deadlines
範例
cairn control prep-deadlines <depId>
cairn control prep-equipment-need

upsert 裝備需求數

參數

<depId>位置參數 · 必填
--item <equipmentItemId>
旗標 · 必填
--qty <n>
旗標 · 必填
--note
旗標 · 選填

需求備註;給 null 清空

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/equipment-needs
範例
cairn control prep-equipment-need <depId> --item <equipmentItemId> --qty <n>
cairn control prep-equipment-need-rm

刪除裝備需求列

參數

<depId>位置參數 · 必填
--id <needId>
旗標 · 必填

裝備需求列 ID

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/equipment-needs/:param
範例
cairn control prep-equipment-need-rm <depId> --id <needId>
cairn control prep-guide-assign

指派領隊到梯次

參數

<depId>位置參數 · 必填
--guide <guideId>
旗標 · 必填
--role <leader|assistant>
旗標 · 必填

指派角色:leader(領隊)或 assistant(隨隊/助理)

--status
旗標 · 選填

指派狀態:tentative(暫定)或 confirmed(已確認)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/guides
範例
cairn control prep-guide-assign <depId> --guide <guideId> --role <leader|assistant>
cairn control prep-rental

從裝備需求開租借單(含金流接入)

參數

<depId>位置參數 · 必填
--order <orderId>
旗標 · 必填
--lines <itemId:qty,itemId:qty>
旗標 · 必填

租借品項明細(品項 + 數量),數量需大於 0 才計入

--renter
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/rentals
範例
cairn control prep-rental <depId> --order <orderId> --lines <itemId:qty,itemId:qty>
cairn control prep-insurance-add

新增投保紀錄

參數

<depId>位置參數 · 必填
--kind <k>
旗標 · 必填

保險種類(如登山險、旅責險)

--insurer
旗標 · 選填

保險公司名稱

--policy-no
旗標 · 選填

保單號碼

--status
旗標 · 選填

投保狀態,預設 pending

--note
旗標 · 選填

備註;給 null 清空

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/insurance
範例
cairn control prep-insurance-add <depId> --kind <k>
cairn control prep-insurance-update

更新投保紀錄

參數

<depId>位置參數 · 必填
--id <insId>
旗標 · 必填

投保紀錄 ID

--insurer
旗標 · 選填

保險公司名稱

--policy-no
旗標 · 選填

保單號碼

--status
旗標 · 選填

投保狀態

--note
旗標 · 選填

備註;給 null 清空

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/insurance/:param
範例
cairn control prep-insurance-update <depId> --id <insId>
cairn control prep-insurance-rm

刪除投保紀錄

參數

<depId>位置參數 · 必填
--id <insId>
旗標 · 必填

投保紀錄 ID

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/insurance/:param
範例
cairn control prep-insurance-rm <depId> --id <insId>
cairn control prep-transport-add

新增派車紀錄

參數

<depId>位置參數 · 必填
--desc
旗標 · 選填
--driver
旗標 · 選填
--vehicle
旗標 · 選填
--fare-note
旗標 · 選填

車資備註

--status
旗標 · 選填

派車狀態,預設 pending

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/transport
範例
cairn control prep-transport-add <depId>
cairn control prep-transport-update

更新派車紀錄

參數

<depId>位置參數 · 必填
--id <tId>
旗標 · 必填

派車紀錄 ID

--desc
旗標 · 選填
--driver
旗標 · 選填
--vehicle
旗標 · 選填
--fare-note
旗標 · 選填

車資備註

--status
旗標 · 選填

派車狀態

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/transport/:param
範例
cairn control prep-transport-update <depId> --id <tId>
cairn control prep-transport-rm

刪除派車紀錄

參數

<depId>位置參數 · 必填
--id <tId>
旗標 · 必填

派車紀錄 ID

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/transport/:param
範例
cairn control prep-transport-rm <depId> --id <tId>
cairn control prep-catering-add

新增餐食紀錄

參數

<depId>位置參數 · 必填
--supplier
旗標 · 選填

餐食供應商名稱

--meal-plan
旗標 · 選填

餐食安排說明(如餐數、菜色)

--headcount-note
旗標 · 選填

人數備註(如素食、特殊餐需求)

--status
旗標 · 選填

餐食安排狀態,預設 pending

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/catering
範例
cairn control prep-catering-add <depId>
cairn control prep-catering-update

更新餐食紀錄

參數

<depId>位置參數 · 必填
--id <cId>
旗標 · 必填

餐食紀錄 ID

--supplier
旗標 · 選填

餐食供應商名稱

--meal-plan
旗標 · 選填

餐食安排說明(如餐數、菜色)

--headcount-note
旗標 · 選填

人數備註(如素食、特殊餐需求)

--status
旗標 · 選填

餐食安排狀態

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/catering/:param
範例
cairn control prep-catering-update <depId> --id <cId>
cairn control prep-catering-rm

刪除餐食紀錄

參數

<depId>位置參數 · 必填
--id <cId>
旗標 · 必填

餐食紀錄 ID

--confirm
對 production target 寫入時必帶
對應端點/api/v1/departures/:param/prep/catering/:param
範例
cairn control prep-catering-rm <depId> --id <cId>

cairn cost-templates

成本範本:查詢、明細

cairn cost-templates list

列出成本範本(--active 只回啟用中精簡清單)

參數

--status
旗標 · 選填

依狀態篩選:active 啟用、archived 已封存

--active
旗標 · 選填

啟用時只回傳輕量的 { id, name } 綁定挑選清單(行程設定的成本範本下拉用)

--json
旗標 · 選填
對應端點/api/v1/cost-templates
範例
cairn cost-templates list
cairn cost-templates get

單一成本範本完整明細(含成本行)

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/cost-templates/:param
範例
cairn cost-templates get <id>
cairn cost-templates create

建立成本範本

參數

--name <名稱>
旗標 · 必填

成本範本名稱

--description <說明>
旗標 · 選填

成本範本說明

--json
旗標 · 選填
對應端點/api/v1/cost-templates
範例
cairn cost-templates create --name <名稱>
cairn cost-templates update

更新成本範本(名稱/說明/狀態)

參數

<id>位置參數 · 必填
--name <名稱>
旗標 · 必填

成本範本名稱

--status
旗標 · 必填

範本狀態:active 啟用、archived 已封存

--description <說明>
旗標 · 選填

成本範本說明

--json
旗標 · 選填
對應端點/api/v1/cost-templates/:param
範例
cairn cost-templates update <id> --name <名稱> --status
cairn cost-templates add-line

新增成本行(--line 為 JSON:{category,unitPriceTwd,quantityMode,...})

參數

<templateId>位置參數 · 必填
--line
旗標 · 必填

成本明細列:含 category 科目、vendorName 廠商、unitPriceTwd 單價、quantityMode 計量方式(fixed 固定/headcount 人數)與對應數量/人數組成、isDeclarable 是否可報帳等欄位

--json
旗標 · 選填
對應端點/api/v1/cost-templates/:param/lines
範例
cairn cost-templates add-line <templateId> --line
cairn cost-templates update-line

更新成本行(--line 為 JSON)

參數

<lineId>位置參數 · 必填
--line
旗標 · 必填

成本明細列更新內容:含 category 科目、vendorName 廠商、unitPriceTwd 單價、quantityMode 計量方式(fixed 固定/headcount 人數)與對應數量/人數組成、isDeclarable 是否可報帳等欄位

--json
旗標 · 選填
對應端點/api/v1/cost-templates/lines/:param
範例
cairn cost-templates update-line <lineId> --line
cairn cost-templates delete-line

刪除成本行

參數

<lineId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/cost-templates/lines/:param
範例
cairn cost-templates delete-line <lineId>

cairn discount-codes

折扣碼:列表、明細、預覽試算、兌換報表

cairn discount-codes list

列出所有折扣碼

參數

--json
旗標 · 選填
對應端點/api/v1/discount-codes
範例
cairn discount-codes list
cairn discount-codes get

單一折扣碼完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/discount-codes/:param
範例
cairn discount-codes get <id>
cairn discount-codes preview

預覽試算折抵(唯讀,不消耗名額)

參數

--code <CODE>
旗標 · 必填

欲試算的折扣碼字串

--kind
旗標 · 必填

產品種類:tour 行程或 lodging 住宿

--trip-id
旗標 · 選填

行程 id(kind=tour 時必填)

--total <twd>
旗標 · 必填

試算用原始金額(TWD,未折扣前)

--price-channel
旗標 · 選填

價格渠道(direct / agency / promo),用於折扣碼資格判定

--customer-type
旗標 · 選填

客戶類型(direct / agency_contact),用於折扣碼資格判定

--user-id
旗標 · 選填

客戶 user id,用於每客戶使用次數限制判定

--json
旗標 · 選填
對應端點/api/v1/discount-codes/preview
範例
cairn discount-codes preview --code <CODE> --kind --total <twd>
cairn discount-codes redemptions

折扣碼兌換 / 分潤報表

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/discount-codes/:param/redemptions
範例
cairn discount-codes redemptions <id>
cairn discount-codes create

建立折扣碼

參數

--code <C>
旗標 · 必填

折扣碼字串(前台結帳輸入,不分大小寫須唯一)

--label <t>
旗標 · 必填

折扣碼顯示名稱(後台與報表辨識用)

--discount-type
旗標 · 必填

折抵方式:fixed 固定金額(TWD)或 percentage 百分比

--discount-value <n>
旗標 · 必填

折抵數值;fixed 為折抵金額(TWD),percentage 為百分比(1–100)

--profit-share-type
旗標 · 選填

分潤方式:fixed 固定金額或 percentage 百分比;null 為不分潤

--profit-share-value
旗標 · 選填

分潤數值;搭配 profitShareType,percentage 須 1–100,null 為不分潤

--profit-share-payee
旗標 · 選填

分潤對象名稱(如合作推廣者),供出款對帳辨識

--active
旗標 · 選填
--valid-from
旗標 · 選填

生效起日(YYYY-MM-DD);留空為不限起日

--valid-until
旗標 · 選填

生效迄日(YYYY-MM-DD);留空為不限迄日

--max-redemptions
旗標 · 選填

全碼可使用總次數上限;null 為不限

--min-order
旗標 · 選填
--applies-to-all
旗標 · 選填

是否適用全部行程;true 時忽略 tripIds

--trip-ids
旗標 · 選填

指定可套用的行程 id 清單(appliesToAll=false 時生效)

--max-per-customer
旗標 · 選填
--price-channels
旗標 · 選填
--customer-types
旗標 · 選填
--stackable
旗標 · 選填

是否可與其他折扣碼疊加使用

--notes
旗標 · 選填

內部備註(不對外顯示)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/discount-codes
範例
cairn discount-codes create --code <C> --label <t> --discount-type --discount-value <n>
cairn discount-codes update

更新折扣碼(送出完整欄位,未帶旗標的欄位沿用表單預設)

參數

<id>位置參數 · 必填
--code <C>
旗標 · 必填

折扣碼字串(前台結帳輸入,不分大小寫須唯一)

--label <t>
旗標 · 必填

折扣碼顯示名稱(後台與報表辨識用)

--discount-type
旗標 · 必填

折抵方式:fixed 固定金額(TWD)或 percentage 百分比

--discount-value <n>
旗標 · 必填

折抵數值;fixed 為折抵金額(TWD),percentage 為百分比(1–100)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/discount-codes/:param
範例
cairn discount-codes update <id> --code <C> --label <t> --discount-type --discount-value <n>
cairn discount-codes set-active

啟用 / 停用折扣碼

參數

<id>位置參數 · 必填
--active
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/discount-codes/:param/set-active
範例
cairn discount-codes set-active <id> --active

cairn equipment

裝備租借:品項主檔、租借單查詢

cairn equipment items

裝備品項主檔:list / get / create / update

參數

<id>位置參數 · 必填
--active-only
旗標 · 選填
--name <n>
旗標 · 選填
--total
旗標 · 選填
--rent-price
旗標 · 選填
--active
旗標 · 選填
範例
cairn equipment items <id>
cairn equipment rentals

租借單:list / get / order-options / create / return / mark-overdue

參數

<id>位置參數 · 必填
<rentalId>位置參數 · 必填
--return-state
旗標 · 選填
--recon-state
旗標 · 選填
--order-id <id>
旗標 · 選填
--limit
旗標 · 選填
--line <itemId>
旗標 · 必填
--damage-cost
旗標 · 選填
範例
cairn equipment rentals <id> <rentalId> --line <itemId>

cairn exchange-rates

牌告匯率:列出、解析

cairn exchange-rates list

列出牌告匯率(台銀 bot + manual 覆蓋)

參數

--currency
旗標 · 選填

幣別篩選(ISO 4217 三碼,如 JPY / USD);省略則回傳所有幣別

--month-from
旗標 · 選填

起始月份(YYYY-MM,含當月);省略則不設下界

--month-to
旗標 · 選填

結束月份(YYYY-MM,含當月);省略則不設上界

--json
旗標 · 選填
對應端點/api/v1/exchange-rates
範例
cairn exchange-rates list
cairn exchange-rates resolve

解析某幣別某日報價(manual 優先 + carry-forward)

參數

--currency
旗標 · 必填

要換算的外幣幣別(ISO 4217 三碼,如 JPY / USD)

--date
旗標 · 必填

換算基準日期(YYYY-MM-DD),套用手動優先 + 往前承接的解析規則

--quote
旗標 · 選填

報價類型:cash_buy 現金買入、cash_sell 現金賣出、spot_buy 即期買入、spot_sell 即期賣出;省略預設 spot_sell

--json
旗標 · 選填
對應端點/api/v1/exchange-rates/resolve
範例
cairn exchange-rates resolve --currency --date
cairn exchange-rates set-manual

手動覆蓋某日某幣別匯率(source=manual,可重存覆蓋)

參數

--date
旗標 · 必填
--currency
旗標 · 必填

幣別(ISO 4217 三碼大寫,如 JPY / USD)

--cash-buy
旗標 · 選填

現金買入匯率(正數最多 6 位小數,以字串表達);四種報價至少填一個,留空傳 null

--cash-sell
旗標 · 選填

現金賣出匯率(正數最多 6 位小數,以字串表達);四種報價至少填一個,留空傳 null

--spot-buy
旗標 · 選填

即期買入匯率(正數最多 6 位小數,以字串表達);四種報價至少填一個,留空傳 null

--spot-sell
旗標 · 選填

即期賣出匯率(正數最多 6 位小數,以字串表達);四種報價至少填一個,留空傳 null

--confirm
對 production target 寫入時必帶
對應端點/api/v1/exchange-rates/manual
範例
cairn exchange-rates set-manual --date --currency

cairn group-codes

團號:碼表(地區/航空)與團號反查

cairn group-codes regions

地區碼對照表

參數

--active-only
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/group-codes/regions:param
範例
cairn group-codes regions
cairn group-codes airlines

航空碼對照表

參數

--active-only
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/group-codes/airlines:param
範例
cairn group-codes airlines
cairn group-codes lookup

精確團號反查單一梯次

參數

<groupCode>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/group-codes/departures/:param
範例
cairn group-codes lookup <groupCode>
cairn group-codes region-create

新增地區碼

參數

<code>位置參數 · 必填
--name <>
旗標 · 必填

碼的顯示名稱(如地區或航空公司全名)

--order
旗標 · 選填
--inactive
旗標 · 選填
對應端點/api/v1/group-codes/regions
範例
cairn group-codes region-create <code> --name <名>
cairn group-codes region-update

更新地區碼(name / 啟用 / 排序,不改碼)

參數

<code>位置參數 · 必填
--name <>
旗標 · 必填

碼的顯示名稱(如地區或航空公司全名)

--order
旗標 · 選填
--inactive
旗標 · 選填
對應端點/api/v1/group-codes/regions
範例
cairn group-codes region-update <code> --name <名>
cairn group-codes airline-create

新增航空碼

參數

<code>位置參數 · 必填
--name <>
旗標 · 必填

碼的顯示名稱(如地區或航空公司全名)

--order
旗標 · 選填
--inactive
旗標 · 選填
對應端點/api/v1/group-codes/airlines
範例
cairn group-codes airline-create <code> --name <名>
cairn group-codes airline-update

更新航空碼(name / 啟用 / 排序,不改碼)

參數

<code>位置參數 · 必填
--name <>
旗標 · 必填

碼的顯示名稱(如地區或航空公司全名)

--order
旗標 · 選填
--inactive
旗標 · 選填
對應端點/api/v1/group-codes/airlines
範例
cairn group-codes airline-update <code> --name <名>

cairn guide-roster

帶團排班:名冊載量、月梯次、檔期衝突

cairn guide-roster guides

名冊 + 該月帶團載量

參數

--month <YYYY-MM>
旗標 · 必填

查詢月份(YYYY-MM 格式)

--include-inactive
旗標 · 選填

是否一併列出已停用的嚮導(預設不列出)

--json
旗標 · 選填
對應端點/api/v1/guide-roster/guides
範例
cairn guide-roster guides --month <YYYY-MM>
cairn guide-roster departures

該月梯次 + 已排指派

參數

--month <YYYY-MM>
旗標 · 必填

查詢月份(YYYY-MM 格式)

--include-cancelled
旗標 · 選填

是否一併納入已取消的梯次(預設不納入)

--json
旗標 · 選填
對應端點/api/v1/guide-roster/departures
範例
cairn guide-roster departures --month <YYYY-MM>
cairn guide-roster conflicts

該月檔期衝突偵測

參數

--month <YYYY-MM>
旗標 · 必填

查詢月份(YYYY-MM 格式)

--json
旗標 · 選填
對應端點/api/v1/guide-roster/conflicts
範例
cairn guide-roster conflicts --month <YYYY-MM>
cairn guide-roster check-conflict

撞期預檢(指定梯次×領隊)

參數

--departure <id>
旗標 · 必填
--guide <id>
旗標 · 必填
--json
旗標 · 選填
對應端點/api/v1/guide-roster/conflict-check
範例
cairn guide-roster check-conflict --departure <id> --guide <id>
cairn guide-roster assign

指派 / 重派領隊到梯次(upsert)

參數

--departure <id>
旗標 · 必填
--guide <id>
旗標 · 必填
--role <leader|assistant>
旗標 · 必填

指派角色(leader 領隊/assistant 隨隊助理)

--status <tentative|confirmed>
旗標 · 必填

指派狀態(tentative 預塞暫定/confirmed 正式確認)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/guide-roster/assignments
範例
cairn guide-roster assign --departure <id> --guide <id> --role <leader|assistant> --status <tentative|confirmed>
cairn guide-roster confirm

正式確認某筆指派

參數

<assignmentId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/guide-roster/assignments/:param/confirm
範例
cairn guide-roster confirm <assignmentId>
cairn guide-roster remove

移除某筆指派

參數

<assignmentId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/guide-roster/assignments/:param
範例
cairn guide-roster remove <assignmentId>
cairn guide-roster change-leader

換領隊(升任新領隊為 confirmed leader)

參數

--departure <id>
旗標 · 必填
--to <guideId>
旗標 · 必填
--reason <t>
旗標 · 必填

換領隊的原因(必填,記入稽核)

--from <guideId>
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/guide-roster/change-leader
範例
cairn guide-roster change-leader --departure <id> --to <guideId> --reason <t>

cairn guides

嚮導:查詢、明細

cairn guides list

列出/搜尋嚮導

參數

--status
旗標 · 選填

嚮導狀態篩選(all 全部/active 啟用/inactive 停用)

--q
旗標 · 選填

關鍵字搜尋(比對嚮導姓名等欄位)

--page
旗標 · 選填

頁碼(從 1 起算)

--page-size
旗標 · 選填

每頁筆數(上限 200)

--json
旗標 · 選填
對應端點/api/v1/guides
範例
cairn guides list
cairn guides get

單一嚮導明細(依 id 或 --slug)

參數

<id>位置參數 · 必填
--slug <slug>
旗標 · 必填

公開頁網址代稱(小寫英數與連字號;省略則不更動)

--json
旗標 · 選填
對應端點/api/v1/guides/:param/api/v1/guides
範例
cairn guides get <id> --slug <slug>
cairn guides create

建立嚮導(建檔)

參數

--name <name>
旗標 · 必填

嚮導/領隊姓名

--slug
旗標 · 選填

依嚮導公開頁網址代稱(slug)精確查單筆(選填)

--bio
旗標 · 選填

嚮導簡介/經歷(選填)

--avatar-url
旗標 · 選填

大頭照圖片網址(選填,http/https)

--specialties
旗標 · 選填

專長領域(選填,以逗號分隔多項)

--years-experience
旗標 · 選填

帶團年資(年數,0~80;選填)

--contact-phone
旗標 · 選填

聯絡電話(選填)

--contact-email
旗標 · 選填

聯絡 Email(選填)

--status
旗標 · 選填

嚮導狀態篩選(all 全部/active 啟用/inactive 停用)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/guides
範例
cairn guides create --name <name>
cairn guides update

更新嚮導(建檔編輯;只送有帶的欄位)

參數

<id>位置參數 · 必填
--name
旗標 · 選填

嚮導/領隊姓名(省略則不更動)

--slug
旗標 · 選填

公開頁網址代稱(小寫英數與連字號;省略則不更動)

--bio
旗標 · 選填

嚮導簡介/經歷(省略則不更動)

--avatar-url
旗標 · 選填

大頭照圖片網址(http/https;省略則不更動)

--specialties
旗標 · 選填

專長領域(以逗號分隔多項;省略則不更動)

--years-experience
旗標 · 選填

帶團年資(年數,0~80;省略則不更動)

--contact-phone
旗標 · 選填

聯絡電話(省略則不更動)

--contact-email
旗標 · 選填

聯絡 Email(省略則不更動)

--status
旗標 · 選填

嚮導狀態(active 啟用/inactive 停用;省略則不更動)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/guides/:param
範例
cairn guides update <id>
cairn guides archive

封存嚮導(status→inactive;重啟用請用 guides update --status active)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/guides/:param/archive
範例
cairn guides archive <id>
cairn guides invite-account

開通嚮導 portal 登入帳號(回傳一次性暫時密碼,僅此一次)

參數

<id>位置參數 · 必填
--email <e>
旗標 · 必填

嚮導 portal 登入帳號的 Email

--name <n>
旗標 · 必填

嚮導帳號的顯示姓名

--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/guides/:param/invite-account
範例
cairn guides invite-account <id> --email <e> --name <n>

cairn holidays

國定假日 / 補班表:查詢、年度統計

cairn holidays list

列出假日 / 補班(可依年度篩選)

參數

--year
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/holidays${qs.toString()
範例
cairn holidays list
cairn holidays stats

某年度假日 / 補班計數

參數

--year
旗標 · 必填

要統計的西元年份(1000..9999,必填)

--json
旗標 · 選填
對應端點/api/v1/holidays/stats
範例
cairn holidays stats --year
cairn holidays upsert

新增 / 覆寫一筆假日或補班(date 為自然鍵)

參數

--date
旗標 · 必填

假日 / 補班日的日期(YYYY-MM-DD,路徑參數),作為該筆紀錄的自然鍵

--name
旗標 · 必填

假日 / 補班日名稱(如「春節」「補行上班」)

--makeup
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/holidays/:param
範例
cairn holidays upsert --date --name
cairn holidays delete

刪除一筆假日 / 補班

參數

--date
旗標 · 必填

假日 / 補班日的日期(YYYY-MM-DD,路徑參數),作為該筆紀錄的自然鍵

--confirm
對 production target 寫入時必帶
對應端點/api/v1/holidays/:param
範例
cairn holidays delete --date

cairn images

圖片庫:查詢圖片、行程選單

cairn images list

列出/搜尋行程圖片

參數

--trip-id
旗標 · 選填

行程 ID 篩選,僅回傳掛在該行程的圖片

--q
旗標 · 選填

關鍵字,模糊比對行程標題、slug、圖說或網址

--page
旗標 · 選填

分頁頁碼,從 1 起算,預設第 1 頁

--page-size
旗標 · 選填

每頁筆數,上限 200,預設由後端決定

--json
旗標 · 選填
對應端點/api/v1/images
範例
cairn images list
cairn images trips

可掛圖的行程選單(draft + published)

參數

--json
旗標 · 選填
對應端點/api/v1/images/trips
範例
cairn images trips
cairn images create

掛圖到行程(以網址)

參數

--trip-id <id>
旗標 · 必填

行程 ID 篩選,僅回傳掛在該行程的圖片

--url <https://…>
旗標 · 必填

圖片網址(http 或 https),以引用方式掛載,非檔案上傳

--caption
旗標 · 選填

圖片說明文字,選填

--display-order
旗標 · 選填

排序權重,數字越小越前面,預設 0

--confirm
對 production target 寫入時必帶
對應端點/api/v1/images
範例
cairn images create --trip-id <id> --url <https://…>
cairn images delete

刪除行程圖片

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/images/:param
範例
cairn images delete <id>

cairn journal

嚮導手記:查詢、明細、作者選項

cairn journal list

列出/搜尋手記

參數

--status
旗標 · 選填

依狀態篩選:all 全部、draft 草稿、published 已發佈、archived 已封存

--q
旗標 · 選填

關鍵字搜尋(標題/內容)

--page
旗標 · 選填

頁碼(從 1 起)

--page-size
旗標 · 選填

每頁筆數(上限 200)

--json
旗標 · 選填
對應端點/api/v1/journal
範例
cairn journal list
cairn journal get

單一手記完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/journal/:param
範例
cairn journal get <id>
cairn journal authors

可選作者(active 嚮導)清單

參數

--json
旗標 · 選填
對應端點/api/v1/journal/authors
範例
cairn journal authors
cairn journal create

建立手記

參數

--title <t>
旗標 · 必填

手記標題,顯示於前台與後台列表

--content-mdx <md>
旗標 · 必填

內文(MDX 格式)

--slug <s>
旗標 · 選填

網址代稱(slug);僅小寫英數與連字號,省略時由系統依標題產生

--excerpt <e>
旗標 · 選填

摘要,列表與分享預覽用;null 清除

--cover-image-url <url>
旗標 · 選填

封面圖網址(http/https);null 清除

--author-guide-id <id>
旗標 · 選填

作者嚮導 ID;null 表示無指定作者

--seo-title <t>
旗標 · 選填

SEO 標題,省略時用 title;null 清除

--seo-description <d>
旗標 · 選填

SEO 描述(meta description);null 清除

--og-image-url <url>
旗標 · 選填

Open Graph 分享圖網址(http/https);null 清除

--status
旗標 · 選填

依狀態篩選:all 全部、draft 草稿、published 已發佈、archived 已封存

--json
旗標 · 選填
對應端點/api/v1/journal
範例
cairn journal create --title <t> --content-mdx <md>
cairn journal update

更新手記(整體取代,欄位比照建立)

參數

<id>位置參數 · 必填
--title <t>
旗標 · 必填

手記標題,顯示於前台與後台列表

--content-mdx <md>
旗標 · 必填

內文(MDX 格式)

--slug <s>
旗標 · 選填

網址代稱(slug);僅小寫英數與連字號,省略時由系統依標題產生

--excerpt <e>
旗標 · 選填

摘要,列表與分享預覽用;null 清除

--cover-image-url <url>
旗標 · 選填

封面圖網址(http/https);null 清除

--author-guide-id <id>
旗標 · 選填

作者嚮導 ID;null 表示無指定作者

--seo-title <t>
旗標 · 選填

SEO 標題,省略時用 title;null 清除

--seo-description <d>
旗標 · 選填

SEO 描述(meta description);null 清除

--og-image-url <url>
旗標 · 選填

Open Graph 分享圖網址(http/https);null 清除

--status
旗標 · 選填

發佈狀態:draft 草稿、published 已發佈、archived 已封存

--json
旗標 · 選填
對應端點/api/v1/journal/:param
範例
cairn journal update <id> --title <t> --content-mdx <md>
cairn journal archive

封存手記

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/journal/:param/archive
範例
cairn journal archive <id>

cairn leaderboard

業績排行:每位業務成交應收業績、待派發 KPI(admin-only)

cairn leaderboard list

全公司業務業績排行

參數

--period
旗標 · 選填

業績統計區間:當月、當季、當年或全部,預設 month

--json
旗標 · 選填
對應端點/api/v1/leaderboard
範例
cairn leaderboard list
cairn leaderboard review-stats

待派發訂單 KPI

參數

--json
旗標 · 選填
對應端點/api/v1/leaderboard/review-stats
範例
cairn leaderboard review-stats

cairn ledger

內外帳:梯次毛利、逐筆成本、支出證明單、待覆核申報

cairn ledger list

列出各梯次內外帳摘要(毛利 / 可申報 / pending 證明單)

參數

--period
旗標 · 選填
--trip <id>
旗標 · 選填
--window-days
旗標 · 選填
--json
旗標 · 選填
範例
cairn ledger list
cairn ledger get

單一梯次內外帳派生明細

參數

<departureId>位置參數 · 必填
--json
旗標 · 選填
範例
cairn ledger get <departureId>
cairn ledger costs

列出某梯次逐筆成本登記

參數

<departureId>位置參數 · 必填
--created-by <userId>
旗標 · 選填
--json
旗標 · 選填
範例
cairn ledger costs <departureId>
cairn ledger proofs

列出某梯次支出證明單

參數

<departureId>位置參數 · 必填
--json
旗標 · 選填
範例
cairn ledger proofs <departureId>
cairn ledger declarations

列出跨梯次待覆核的嚮導申報成本

參數

--json
旗標 · 選填
範例
cairn ledger declarations
cairn ledger cost-create

登記一筆成本(ledger.manage)

參數

<departureId>位置參數 · 必填
--category <類別>
旗標 · 必填
--amount <twd>
旗標 · 必填
--vendor
旗標 · 選填
--description
旗標 · 選填
--no-receipt
旗標 · 選填
--invoice-amount
旗標 · 選填
--currency <fx_account|published|manual>
旗標 · 選填
--confirm
對 production target 寫入時必帶
範例
cairn ledger cost-create <departureId> --category <類別> --amount <twd>
cairn ledger cost-update

更新一筆成本(ledger.manage)

參數

<costId>位置參數 · 必填
--category <類別>
旗標 · 必填
--amount
旗標 · 選填
--vendor
旗標 · 選填
--description
旗標 · 選填
--no-receipt
旗標 · 選填
--invoice-amount
旗標 · 選填
--currency
旗標 · 選填
--confirm
對 production target 寫入時必帶
範例
cairn ledger cost-update <costId> --category <類別>
cairn ledger cost-delete

刪除一筆未轉請款的成本(ledger.manage)

參數

<costId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
範例
cairn ledger cost-delete <costId>
cairn ledger approve-proof

核准支出證明單(ledger.approve;責任分離)

參數

<proofId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
範例
cairn ledger approve-proof <proofId>
cairn ledger approve-declaration

覆核嚮導自報待覆核成本(ledger.approve;責任分離)

參數

<costId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
範例
cairn ledger approve-declaration <costId>
cairn ledger convert-to-payable

成本轉請款核簽(ledger.manage 且 payable.create)

參數

<departureId>位置參數 · 必填
--costs <id1,id2,...>
旗標 · 必填
--payee-name
旗標 · 必填
--payee-type <supplier|guide|staff_commission|other>
旗標 · 選填
--bank-account
旗標 · 選填
--bank-name
旗標 · 選填
--bank-branch
旗標 · 選填
--tax-id
旗標 · 選填
--tax-amount
旗標 · 選填
--submit
旗標 · 選填
--confirm
對 production target 寫入時必帶
範例
cairn ledger convert-to-payable <departureId> --costs <id1,id2,...> --payee-name

cairn lodging

旅宿:物件、房型、可用量、訂房、統計

cairn lodging properties

列出旅宿物件

參數

--json
旗標 · 選填
對應端點/api/v1/lodging/properties
範例
cairn lodging properties
cairn lodging property

單一旅宿物件

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/lodging/properties/:param
範例
cairn lodging property <id>
cairn lodging room-types

列出某物件的房型

參數

--property <propertyId>
旗標 · 必填
--json
旗標 · 選填
對應端點/api/v1/lodging/properties/:param/room-types
範例
cairn lodging room-types --property <propertyId>
cairn lodging room-type

單一房型

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/lodging/room-types/:param
範例
cairn lodging room-type <id>
cairn lodging availability

房型逐夜可用量+價格 [check-in, check-out)

參數

--room-type <id>
旗標 · 必填
--check-in <date>
旗標 · 必填

入住日(YYYY-MM-DD,含此晚)

--check-out <date>
旗標 · 必填

退房日(YYYY-MM-DD,不含此晚)

--json
旗標 · 選填
對應端點/api/v1/lodging/room-types/:param/availability
範例
cairn lodging availability --room-type <id> --check-in <date> --check-out <date>
cairn lodging breakdown

逐夜已訂量(直訂 vs 套裝)[from, to)

參數

--room-type <id>
旗標 · 必填
--from <date>
旗標 · 必填

起始日(YYYY-MM-DD,含此晚)

--to <date>
旗標 · 必填

結束日(YYYY-MM-DD,不含此晚)

--json
旗標 · 選填
對應端點/api/v1/lodging/room-types/:param/availability/breakdown
範例
cairn lodging breakdown --room-type <id> --from <date> --to <date>
cairn lodging images

列出物件或房型的圖片

參數

<id>位置參數 · 必填
--room-type <id>
旗標 · 必填
--json
旗標 · 選填
對應端點/api/v1/lodging/properties/:param/images/api/v1/lodging/room-types/:param/images
範例
cairn lodging images <id> --room-type <id>
cairn lodging bookings

列出旅宿訂房(代訂)

參數

--q
旗標 · 選填

自由文字關鍵字(訂房人、旅宿等)

--status
旗標 · 選填

依訂單狀態篩選(省略則回全部)

--json
旗標 · 選填
對應端點/api/v1/lodging/bookings
範例
cairn lodging bookings
cairn lodging booking

單一旅宿訂房明細

參數

<orderId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/lodging/bookings/:param
範例
cairn lodging booking <orderId>
cairn lodging stats

旅宿 KPI 統計

參數

--json
旗標 · 選填
對應端點/api/v1/lodging/stats
範例
cairn lodging stats
cairn lodging property-create

新增旅宿物件

參數

--slug <s>
旗標 · 必填

旅宿代稱(小寫英數與連字號,2-63 字,租戶內唯一,用於網址)

--name <n>
旗標 · 必填

旅宿名稱(對外顯示)

--kind
旗標 · 選填

旅宿類型:camp 營地/hotel 旅館,預設 hotel

--overseas
旗標 · 選填
--location
旗標 · 選填

所在地點概述(如縣市、區域)

--description
旗標 · 選填

旅宿介紹文字

--usage-hint
旗標 · 選填

銷售用途:direct 僅直接訂房/package 僅併入套裝行程/both 兩者皆可,預設 both

--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/lodging/properties
範例
cairn lodging property-create --slug <s> --name <n>
cairn lodging property-update

更新旅宿物件(patch 語意;只送有帶的欄位)

參數

<id>位置參數 · 必填
--name
旗標 · 選填

旅宿名稱(對外顯示)

--location
旗標 · 選填

所在地點概述(如縣市、區域)

--description
旗標 · 選填

旅宿介紹文字

--usage-hint
旗標 · 選填

銷售用途:direct 僅直接訂房/package 僅併入套裝行程/both 兩者皆可

--facilities
旗標 · 選填

設施代碼陣列(須為合法 amenity key;送空陣列代表清空)

--pets
旗標 · 選填
--smoking
旗標 · 選填
--seo-title
旗標 · 選填

SEO 標題(送空字串代表清空,退回預設)

--seo-description
旗標 · 選填

SEO 描述(送空字串代表清空,退回預設)

--og-image-url
旗標 · 選填

社群分享圖 URL(須為 http/https,送空字串代表清空)

--phone
旗標 · 選填

聯絡電話

--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/lodging/properties/:param
範例
cairn lodging property-update <id>
cairn lodging property-archive

封存旅宿物件(status→inactive)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/lodging/properties/:param/archive
範例
cairn lodging property-archive <id>
cairn lodging room-type-create

新增房型

參數

--property <id>
旗標 · 必填
--name <n>
旗標 · 必填

房型名稱(如標準雙人房)

--units-total <n>
旗標 · 必填

此房型可售總單元數(房數或床位數)

--base-price <twd>
旗標 · 必填
--inventory-unit
旗標 · 選填

庫存單位:room 以房計/bed 以床位計,預設 room

--capacity-per-unit <n>
旗標 · 選填

每單元可容納人數,預設 1

--bed-type
旗標 · 選填

床型代碼(須為合法 bed type,搭配 bedCount 才生效)

--floor-size <sqm>
旗標 · 選填
--facilities
旗標 · 選填

房型設施代碼陣列(須為合法 amenity key)

--description
旗標 · 選填

房型介紹文字

--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/lodging/properties/:param/room-types
範例
cairn lodging room-type-create --property <id> --name <n> --units-total <n> --base-price <twd>
cairn lodging room-type-update

更新房型(patch;送 --facilities= 空字串可清空)

參數

<id>位置參數 · 必填
--name
旗標 · 選填

房型名稱(如標準雙人房)

--units-total
旗標 · 選填

此房型可售總單元數(房數或床位數)

--base-price
旗標 · 選填
--inventory-unit
旗標 · 選填

庫存單位:room 以房計/bed 以床位計

--capacity-per-unit
旗標 · 選填

每單元可容納人數

--bed-type
旗標 · 選填

床型代碼(須為合法 bed type,搭配 bedCount 才生效)

--floor-size
旗標 · 選填
--facilities
旗標 · 選填

房型設施代碼陣列(須為合法 amenity key;送空陣列代表清空)

--description
旗標 · 選填

房型介紹文字

--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/lodging/room-types/:param
範例
cairn lodging room-type-update <id>
cairn lodging room-type-archive

封存房型(status→inactive)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/lodging/room-types/:param/archive
範例
cairn lodging room-type-archive <id>
cairn lodging nights-override

批次覆寫房型一段區間每晚的價/容量/封房 [from, to](inclusive)

參數

--room-type <id>
旗標 · 必填
--from <date>
旗標 · 必填

套用起始日(YYYY-MM-DD,含此日)

--to <date>
旗標 · 必填

套用結束日(YYYY-MM-DD,含此日;須不早於起始日)

--price <twd>
旗標 · 選填
--capacity <n>
旗標 · 選填

覆寫的每晚可售單元數,若低於已訂數量會回 409 衝突

--status
旗標 · 選填

每晚開關房狀態:open 開放/closed 封房

--confirm
對 production target 寫入時必帶
對應端點/api/v1/lodging/room-types/:param/nights/override
範例
cairn lodging nights-override --room-type <id> --from <date> --to <date>
cairn lodging booking-cancel

取消旅宿訂房(釋回保留夜;owner-scope)

參數

<orderId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/lodging/bookings/:param/cancel
範例
cairn lodging booking-cancel <orderId>
cairn lodging book

代客建立旅宿訂房(訂房人須為既有會員)

參數

--property <id>
旗標 · 必填
--room-type <id>
旗標 · 必填
--check-in <date>
旗標 · 必填

入住日(YYYY-MM-DD,含此晚)

--check-out <date>
旗標 · 必填

退房日(YYYY-MM-DD,不含此晚,須晚於入住日)

--units <n>
旗標 · 必填

預訂單元數(房數或床位數,1-50)

--guests <n>
旗標 · 必填
--email <e>
旗標 · 必填
--payment-method <cash|atm|manual>
旗標 · 必填

付款方式:cash 現金/atm 轉帳/manual 其他人工

--receiving-account
旗標 · 選填
--notes
旗標 · 選填

代訂備註

--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/lodging/bookings
範例
cairn lodging book --property <id> --room-type <id> --check-in <date> --check-out <date> --units <n> --guests <n> --email <e> --payment-method <cash|atm|manual>
cairn lodging image-add

新增物件或房型圖片

參數

<id>位置參數 · 必填
--room-type <id>
旗標 · 必填
--url <u>
旗標 · 必填

圖片網址

--caption
旗標 · 選填

圖片說明文字(可省略)

--order
旗標 · 選填
--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/lodging/properties/:param/images/api/v1/lodging/room-types/:param/images
範例
cairn lodging image-add <id> --room-type <id> --url <u>
cairn lodging image-delete

刪除物件或房型圖片

參數

<imageId>位置參數 · 必填
--room-type
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/lodging/images/:param
範例
cairn lodging image-delete <imageId> --room-type

cairn members

會員(客戶):查詢、明細、統計

cairn members list

列出/搜尋會員

參數

--q
旗標 · 選填

關鍵字,模糊比對會員姓名、Email 或電話

--county
旗標 · 選填

縣市篩選,僅回傳通訊地址在該縣市的會員

--year
旗標 · 選填

加入年份(西元四位數),僅回傳該年註冊的會員

--page
旗標 · 選填

分頁頁碼,從 1 起算,預設第 1 頁

--page-size
旗標 · 選填

每頁筆數,上限 200,預設由後端決定

--json
旗標 · 選填
對應端點/api/v1/members
範例
cairn members list
cairn members get

單一會員完整明細(含訂單/同意紀錄)

參數

<userId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/members/:param
範例
cairn members get <userId>
cairn members stats

會員 KPI 統計

參數

--json
旗標 · 選填
對應端點/api/v1/members/stats
範例
cairn members stats
cairn members expiry-flags

標記護照即將到期的會員(給定 userId 批次)

參數

--ids
旗標 · 必填

以逗號分隔的會員使用者 ID 批次,上限 200 個,回傳其中護照即將到期者

--json
旗標 · 選填
對應端點/api/v1/members/expiry-warnings
範例
cairn members expiry-flags --ids
cairn members anonymize

PDPA 匿名化會員(不可逆:抹除 PII + 封鎖登入 + 撤銷憑證)

參數

<userId>位置參數 · 必填
--reason
旗標 · 選填

匿名化原因,記入稽核紀錄備查

--confirm
對 production target 寫入時必帶
對應端點/api/v1/members/:param/anonymize
範例
cairn members anonymize <userId>

cairn message-templates

罐頭訊息範本:查詢、明細

cairn message-templates list

列出訊息範本(可依通道過濾)

參數

--channel
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/message-templates${query
範例
cairn message-templates list
cairn message-templates get

單一訊息範本完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/message-templates/:param
範例
cairn message-templates get <id>
cairn message-templates create

新增訊息範本

參數

--stage <stage>
旗標 · 必填

訊息對應的 SOP 階段

--channel <line|email>
旗標 · 必填

依發送管道篩選範本(line 或 email)

--title <t>
旗標 · 必填

範本標題(供後台辨識)

--body-single <b>
旗標 · 必填

單人版訊息內文

--key <K>
旗標 · 選填

範本識別碼,2–64 碼大寫英數 / _ / -(用於程式化引用,選填,自動轉大寫)

--body-multi <b>
旗標 · 選填

多人版訊息內文(留空表示沿用單人版;選填)

--inactive
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/message-templates
範例
cairn message-templates create --stage <stage> --channel <line|email> --title <t> --body-single <b>
cairn message-templates update

更新訊息範本(全量覆寫)

參數

<id>位置參數 · 必填
--stage <stage>
旗標 · 必填

訊息對應的 SOP 階段

--channel <line|email>
旗標 · 必填

發送管道(line 或 email)

--title <t>
旗標 · 必填

範本標題(供後台辨識)

--body-single <b>
旗標 · 必填

單人版訊息內文

--key <K>
旗標 · 選填

範本識別碼,2–64 碼大寫英數 / _ / -(用於程式化引用,選填,自動轉大寫)

--body-multi <b>
旗標 · 選填

多人版訊息內文(留空表示沿用單人版;選填)

--inactive
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/message-templates/:param
範例
cairn message-templates update <id> --stage <stage> --channel <line|email> --title <t> --body-single <b>
cairn message-templates set-active

啟用 / 停用訊息範本

參數

<id>位置參數 · 必填
--active
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/message-templates/:param/active
範例
cairn message-templates set-active <id> --active
cairn message-templates delete

刪除訊息範本(硬刪,清除草稿)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/message-templates/:param
範例
cairn message-templates delete <id>

cairn orders

訂單:查詢、明細、統計

cairn orders list

列出/搜尋訂單

參數

--status
旗標 · 選填

依訂單顯示狀態篩選(如 pending、paid、cancelled)

--q
旗標 · 選填

關鍵字搜尋(訂單編號、訂購人姓名或 Email 等)

--date-from
旗標 · 選填

出發日期區間起(格式 YYYY-MM-DD,含當日)

--date-to
旗標 · 選填

出發日期區間迄(格式 YYYY-MM-DD,含當日)

--page
旗標 · 選填

頁碼,從 1 起算,預設第 1 頁

--json
旗標 · 選填
對應端點/api/v1/orders
範例
cairn orders list
cairn orders get

單一訂單完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/orders/:param
範例
cairn orders get <id>
cairn orders reveal

顯示旅客證號/護照全碼(owner-scope;寫 traveler.decrypt 稽核)

參數

<orderId>位置參數 · 必填
<travelerId>位置參數 · 必填
--field <idNumber|passportNo>
旗標 · 必填

欲顯示全碼的個資欄位:idNumber 身分證字號、passportNo 護照號碼

--json
旗標 · 選填
對應端點/api/v1/orders/:param/travelers/:param/reveal
範例
cairn orders reveal <orderId> <travelerId> --field <idNumber|passportNo>
cairn orders create

代客 K 單(手動建立 tour 訂單;訂購人須為既有會員)

參數

--trip <id>
旗標 · 必填
--departure <id>
旗標 · 必填
--email <e>
旗標 · 必填
--party-size <n>
旗標 · 必填

報名人數,決定佔位數,須為 1 至 20 之間整數

--payment-method <cash|atm|manual>
旗標 · 必填

收款方式:cash 現金、atm 轉帳、manual 人工

--travelers <json>
旗標 · 必填

旅客名單,筆數須與報名人數一致

--customer-type
旗標 · 選填

客戶類型:direct 直客、agency 同業,預設直客

--payment-plan
旗標 · 選填

付款方案:full 全額、deposit 訂金,預設全額

--receiving-account
旗標 · 選填
--notes
旗標 · 選填

訂單備註

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders
範例
cairn orders create --trip <id> --departure <id> --email <e> --party-size <n> --payment-method <cash|atm|manual> --travelers <json>
cairn orders mark-paid

手動入帳標記訂單已付(idempotent)

參數

<id>位置參數 · 必填
--note
旗標 · 選填

對帳備註,記錄人工核款說明

--receiving-account
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/mark-paid
範例
cairn orders mark-paid <id>
cairn orders cancel

取消訂單(釋回席次,不自動退款)

參數

<id>位置參數 · 必填
--reason
旗標 · 選填

取消事由說明

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/cancel
範例
cairn orders cancel <id>
cairn orders adjust

掛帳:加收 / 折讓(append charge line + 重算金流)

參數

<id>位置參數 · 必填
--kind <surcharge|allowance>
旗標 · 必填

調整類型:surcharge 加收、allowance 減免

--amount <twd>
旗標 · 必填
--description <t>
旗標 · 必填

調整事由說明

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/adjust
範例
cairn orders adjust <id> --kind <surcharge|allowance> --amount <twd> --description <t>
cairn orders reverse

沖正既有應收項目(append reversal line)

參數

<id>位置參數 · 必填
--charge-line <id>
旗標 · 必填
--description <t>
旗標 · 必填

沖正事由說明

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/reverse
範例
cairn orders reverse <id> --charge-line <id> --description <t>
cairn orders refund-create

建立並送審客戶退款(draft→submitted)

參數

<orderId>位置參數 · 必填
--amount <twd>
旗標 · 必填
--reason <t>
旗標 · 必填

退款事由說明

--kind <receivable_reduction|overpayment_return>
旗標 · 必填
--execution-method
旗標 · 選填

退款執行方式:chargeback 原路退刷、remit 銀行匯款

--origin-account
旗標 · 選填
--admin-fee
旗標 · 選填
--remit-fee
旗標 · 選填
--payee-name
旗標 · 選填
--payee-bank
旗標 · 選填
--payee-account
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/refunds
範例
cairn orders refund-create <orderId> --amount <twd> --reason <t> --kind <receivable_reduction|overpayment_return>
cairn orders refund-approve

核准退款(責任分離:非建單人)

參數

<orderId>位置參數 · 必填
--refund <refundId>
旗標 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/refunds/:param/approve
範例
cairn orders refund-approve <orderId> --refund <refundId>
cairn orders refund-reject

退件退款(submitted→cancelled)

參數

<orderId>位置參數 · 必填
--refund <refundId>
旗標 · 必填
--reason
旗標 · 選填

退件事由說明

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/refunds/:param/reject
範例
cairn orders refund-reject <orderId> --refund <refundId>
cairn orders refund-paid

標記退款已付(approved→paid,現金整合點)

參數

<orderId>位置參數 · 必填
--refund <refundId>
旗標 · 必填
--bank-ref
旗標 · 選填
--receiving-account
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/refunds/:param/mark-paid
範例
cairn orders refund-paid <orderId> --refund <refundId>
cairn orders assign

指派訂單給承辦業務(首派;pending_review→assigned)

參數

<id>位置參數 · 必填
--assignee <userId>
旗標 · 必填
--reason
旗標 · 選填

派發事由說明(上限 500 字)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/assign
範例
cairn orders assign <id> --assignee <userId>
cairn orders reassign

重新指派已派發訂單(admin-only;→reassigned)

參數

<id>位置參數 · 必填
--assignee <userId>
旗標 · 必填
--reason
旗標 · 選填

重派事由說明(上限 500 字)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/reassign
範例
cairn orders reassign <id> --assignee <userId>
cairn orders bulk-assign

批次把多張訂單派給同一位業務(all-or-nothing)

參數

--assignee <userId>
旗標 · 必填
--orders <id,id,...>
旗標 · 必填
--reason
旗標 · 選填

派發事由說明(上限 500 字)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/bulk-assign
範例
cairn orders bulk-assign --assignee <userId> --orders <id,id,...>
cairn orders review-screening

人工核可/駁回登山資格審核(駁回不自動退單)

參數

<id>位置參數 · 必填
--decision <approve|reject>
旗標 · 必填

登山資格審核裁決:approve 核可、reject 駁回

--note
旗標 · 選填

審核註記說明(上限 500 字)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/review-screening
範例
cairn orders review-screening <id> --decision <approve|reject>
cairn orders traveler-add

新增旅客到訂單(owner-scope;出發前 7 天凍結)

參數

<orderId>位置參數 · 必填
--full-name <n>
旗標 · 必填

旅客全名,須與證件一致;新增旅客時必填,更新時可省略

--phone
旗標 · 選填

旅客聯絡電話

--email
旗標 · 選填

旅客電子郵件

--birth-date
旗標 · 選填

旅客出生日期(格式 YYYY-MM-DD)

--gender
旗標 · 選填

旅客性別:male 男、female 女、other 其他

--id-number
旗標 · 選填

身分證字號,屬個資將加密保存

--passport
旗標 · 選填
--room-pref
旗標 · 選填
--roommate-pref
旗標 · 選填

指定同住室友(用於分房作業)

--emergency-name
旗標 · 選填
--emergency-phone
旗標 · 選填
--address
旗標 · 選填

旅客通訊地址

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/travelers
範例
cairn orders traveler-add <orderId> --full-name <n>
cairn orders traveler-update

更新旅客資料(owner-scope;出發前 7 天凍結)

參數

<orderId>位置參數 · 必填
<travelerId>位置參數 · 必填
--full-name
旗標 · 選填

旅客全名,須與證件一致;新增旅客時必填,更新時可省略

--phone
旗標 · 選填

旅客聯絡電話

--email
旗標 · 選填

旅客電子郵件

--birth-date
旗標 · 選填

旅客出生日期(格式 YYYY-MM-DD)

--gender
旗標 · 選填

旅客性別:male 男、female 女、other 其他

--id-number
旗標 · 選填

身分證字號,屬個資將加密保存

--passport
旗標 · 選填
--room-pref
旗標 · 選填
--roommate-pref
旗標 · 選填

指定同住室友(用於分房作業)

--emergency-name
旗標 · 選填
--emergency-phone
旗標 · 選填
--address
旗標 · 選填

旅客通訊地址

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/travelers/:param
範例
cairn orders traveler-update <orderId> <travelerId>
cairn orders traveler-remove

移除旅客(owner-scope;至少保留一位、不可移主要聯絡人)

參數

<orderId>位置參數 · 必填
<travelerId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/travelers/:param
範例
cairn orders traveler-remove <orderId> <travelerId>
cairn orders rooming-pref

更新旅客分房需求(房型偏好/指定室友;owner-scope)

參數

<orderId>位置參數 · 必填
<travelerId>位置參數 · 必填
--room-pref
旗標 · 選填
--roommate-pref
旗標 · 選填

指定同住室友(用於分房作業)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/orders/:param/travelers/:param/rooming
範例
cairn orders rooming-pref <orderId> <travelerId>
cairn orders stats

訂單 KPI 統計

參數

--json
旗標 · 選填
對應端點/api/v1/orders/stats
範例
cairn orders stats
cairn orders export

匯出訂單為 CSV/JSON(同 list 篩選 + owner-scope;取全頁)

參數

--status
旗標 · 選填

依訂單顯示狀態篩選(如 pending、paid、cancelled)

--date-from
旗標 · 選填

出發日期區間起(格式 YYYY-MM-DD,含當日)

--date-to
旗標 · 選填

出發日期區間迄(格式 YYYY-MM-DD,含當日)

--q
旗標 · 選填

關鍵字搜尋(訂單編號、訂購人姓名或 Email 等)

--assignment
旗標 · 選填

依派發狀態篩選(如 unassigned、assigned)

--rooming
旗標 · 選填

依分房狀態篩選

--agency-id
旗標 · 選填

依合作旅行社 ID 篩選(同業單)

--format
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/orders/export
範例
cairn orders export

cairn payment-requests

對外應付請款單:查詢、明細、統計、廠商建議

cairn payment-requests list

列出/搜尋對外應付請款單

參數

--status
旗標 · 選填

依狀態篩選(draft 草稿 / submitted 已送審 / approved 已核准 / paid 已付款 / rejected 已退件 / cancelled 已取消 / all 全部)

--payee-type
旗標 · 選填

依收款對象類型篩選(supplier 供應商 / guide 領隊嚮導 / staff_commission 員工獎金 / other 其他 / all 全部)

--departure
旗標 · 選填
--created-by
旗標 · 選填
--q
旗標 · 選填

關鍵字搜尋(請款單號、收款對象名稱等)

--page
旗標 · 選填

頁碼(從 1 起算)

--page-size
旗標 · 選填

每頁筆數(上限 200)

--json
旗標 · 選填
對應端點/api/v1/payment-requests
範例
cairn payment-requests list
cairn payment-requests get

單一請款單完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/payment-requests/:param
範例
cairn payment-requests get <id>
cairn payment-requests stats

對外應付請款單 KPI 統計

參數

--json
旗標 · 選填
對應端點/api/v1/payment-requests/stats
範例
cairn payment-requests stats
cairn payment-requests suggest-items

由梯次住宿成本推導供應商請款細項建議

參數

--departure <id>
旗標 · 必填
--json
旗標 · 選填
對應端點/api/v1/payment-requests/supplier-suggestions
範例
cairn payment-requests suggest-items --departure <id>
cairn payment-requests create

建立對外應付請款單(draft,或 --submit 同步送審)

參數

<cat:desc:qty:price[:notes]>位置參數 · 必填
--payee-type <supplier|guide|staff_commission|other>
旗標 · 必填

依收款對象類型篩選(supplier 供應商 / guide 領隊嚮導 / staff_commission 員工獎金 / other 其他 / all 全部)

--payee-name <n>
旗標 · 必填

收款對象名稱

--description <d>
旗標 · 必填

請款單摘要說明

--tax
旗標 · 選填
--departure
旗標 · 選填
--bank-account
旗標 · 選填
--bank-name
旗標 · 選填
--bank-branch
旗標 · 選填
--tax-id
旗標 · 選填
--submit
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests
範例
cairn payment-requests create <cat:desc:qty:price[:notes]> --payee-type <supplier|guide|staff_commission|other> --payee-name <n> --description <d>
cairn payment-requests approve

核可請款單(submitted→approved;責任分離,需 payable.approve)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/approve
範例
cairn payment-requests approve <id>
cairn payment-requests submit

送審請款單(draft→submitted)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/submit
範例
cairn payment-requests submit <id>
cairn payment-requests reject

退件請款單(submitted→draft)

參數

<id>位置參數 · 必填
--reason <text>
旗標 · 必填

退件原因(必填,回饋給建單人)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/reject
範例
cairn payment-requests reject <id> --reason <text>
cairn payment-requests mark-paid

標記請款單已付(approved→paid)

參數

<id>位置參數 · 必填
--bank-reference <ref>
旗標 · 必填

網銀交易序號 / 轉帳憑證號(必填)

--receiving-account
旗標 · 選填
--paper-signed-by
旗標 · 選填

紙本簽核人姓名

--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/mark-paid
範例
cairn payment-requests mark-paid <id> --bank-reference <ref>
cairn payment-requests cancel

取消請款單(非 paid;僅建單人或 admin)

參數

<id>位置參數 · 必填
--reason
旗標 · 選填

取消原因;留空預設為「使用者取消」(上限 200 字)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/cancel
範例
cairn payment-requests cancel <id>
cairn payment-requests mark-signed

記錄紙本簽核人

參數

<id>位置參數 · 必填
--signed-by <name>
旗標 · 必填

紙本簽核人姓名(必填)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/mark-signed
範例
cairn payment-requests mark-signed <id> --signed-by <name>
cairn payment-requests mark-printed

標記 PDF/紙本已產生(idempotent)

參數

<id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/payment-requests/:param/mark-printed
範例
cairn payment-requests mark-printed <id>

cairn payments

收款流水帳:查詢、統計

cairn payments list

列出/搜尋收款流水

參數

--status
旗標 · 選填

依金流狀態篩選(如 paid 已收款 / pending 待付 / failed 失敗 / refunded 已退款)

--method
旗標 · 選填

依付款方式篩選(如信用卡、ATM 轉帳)

--q
旗標 · 選填

關鍵字搜尋(訂單編號、客戶名稱等)

--date-from
旗標 · 選填

收款日期區間起日(YYYY-MM-DD)

--date-to
旗標 · 選填

收款日期區間迄日(YYYY-MM-DD)

--page
旗標 · 選填

頁碼(從 1 起算)

--json
旗標 · 選填
對應端點/api/v1/payments
範例
cairn payments list
cairn payments stats

收款 KPI 統計

參數

--json
旗標 · 選填
對應端點/api/v1/payments/stats
範例
cairn payments stats
cairn payments export

匯出金流分類帳為 CSV/JSON(同 list 篩選;取全頁)

參數

--status
旗標 · 選填

依金流狀態篩選(如 paid 已收款 / pending 待付 / failed 失敗 / refunded 已退款)

--method
旗標 · 選填

依付款方式篩選(如信用卡、ATM 轉帳)

--date-from
旗標 · 選填

收款日期區間起日(YYYY-MM-DD)

--date-to
旗標 · 選填

收款日期區間迄日(YYYY-MM-DD)

--q
旗標 · 選填

關鍵字搜尋(訂單編號、客戶名稱等)

--format
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/payments/export
範例
cairn payments export

cairn payouts

出款批次:彙整 preview、出帳帳戶、批次轉帳檔

cairn payouts aggregate

建批前彙整 preview(當月已核准未付 payable 依收款對象 group)

參數

--period <YYYY-MM>
旗標 · 必填

出款月份(YYYY-MM),彙整該月已核准未付的應付

--scope <guide|supplier|staff>
旗標 · 必填

收款對象範圍(guide 領隊嚮導 / supplier 供應商 / staff 員工)

--json
旗標 · 選填
對應端點/api/v1/payouts/aggregate
範例
cairn payouts aggregate --period <YYYY-MM> --scope <guide|supplier|staff>
cairn payouts remit-accounts

出帳帳戶選項(收款帳戶目錄)

參數

--json
旗標 · 選填
對應端點/api/v1/payouts/remit-accounts
範例
cairn payouts remit-accounts
cairn payouts transfer-file

出款批次標準四欄批次轉帳檔

參數

<pob_id>位置參數 · 必填
--format
旗標 · 選填

輸出格式:json 完整匯出(預設)或 csv 僅回傳轉帳檔字串

--json
旗標 · 選填
對應端點/api/v1/payouts/batches/:param/transfer-file
範例
cairn payouts transfer-file <pob_id>
cairn payouts create-batch

建立出款批次草稿(gross + 通用扣款項 → draft,不 mark paid)

參數

--period <YYYY-MM>
旗標 · 必填

出款月份(YYYY-MM)

--scope <guide|supplier|staff>
旗標 · 必填
--account <acct_id>
旗標 · 選填
--lines <json|@file>
旗標 · 必填

納入批次的出款列(至少一列)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/payouts/batches
範例
cairn payouts create-batch --period <YYYY-MM> --scope <guide|supplier|staff> --lines <json|@file>
cairn payouts confirm-batch

確認出款批次(draft → confirmed:mark paid + 記出帳)

參數

<pob_id>位置參數 · 必填
--bank-ref <ref>
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/payouts/batches/:param/confirm
範例
cairn payouts confirm-batch <pob_id>
cairn payouts issue-confirm-token

為供應商批次列簽發廠商自助確認 token(idempotent,回 token)

參數

<pobl_id>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/payouts/lines/:param/confirm-token
範例
cairn payouts issue-confirm-token <pobl_id>

cairn pnl

公司損益:營業費用台帳、費用科目、月損益表

cairn pnl expenses

列出公司營業費用(list)

參數

--period
旗標 · 選填

歸屬月(格式 YYYY-MM);只列出該月的費用

--kind
旗標 · 選填

費用大類:opex 營業費用、tax 稅、platform_fee 平台手續費、special 特殊損益

--category
旗標 · 選填

費用類別 ID;只列出該類別的費用

--json
旗標 · 選填
對應端點/api/v1/pnl/expenses
範例
cairn pnl expenses
cairn pnl expense-categories

列出費用科目目錄(list)

參數

--active-only
旗標 · 選填

是否只回傳啟用中的費用類別;預設含停用列

--json
旗標 · 選填
對應端點/api/v1/pnl/expense-categories
範例
cairn pnl expense-categories
cairn pnl expense-create

登錄一筆公司營業費用(與梯次無關;歸屬月供月損益彙整)

參數

--category <id>
旗標 · 必填

費用類別 ID;只列出該類別的費用

--period <YYYY-MM>
旗標 · 必填

歸屬月(格式 YYYY-MM);只列出該月的費用

--description <t>
旗標 · 必填

費用摘要

--amount <twd>
旗標 · 必填
--paid-from
旗標 · 選填
--fronted-by
旗標 · 選填
--incurred-on
旗標 · 選填

費用發生日期(格式 YYYY-MM-DD)

--note
旗標 · 選填

備註

--recurring
旗標 · 選填

是否為週期性費用

--confirm
對 production target 寫入時必帶
對應端點/api/v1/pnl/expenses
範例
cairn pnl expense-create --category <id> --period <YYYY-MM> --description <t> --amount <twd>
cairn pnl expense-update

更正一筆公司營業費用(整列覆寫;payable 連結須帶回)

參數

<id>位置參數 · 必填
--category <id>
旗標 · 必填
--period <YYYY-MM>
旗標 · 必填

歸屬月(格式 YYYY-MM),供月損益表彙整

--description <t>
旗標 · 必填

費用摘要

--amount <twd>
旗標 · 必填
--paid-from
旗標 · 選填
--fronted-by
旗標 · 選填
--incurred-on
旗標 · 選填

費用發生日期(格式 YYYY-MM-DD)

--note
旗標 · 選填

備註

--payable-id
旗標 · 選填

關聯的請款核簽 ID;整列覆寫時須原樣帶回,省略則清為 null

--recurring
旗標 · 選填

是否為週期性費用

--confirm
對 production target 寫入時必帶
對應端點/api/v1/pnl/expenses/:param
範例
cairn pnl expense-update <id> --category <id> --period <YYYY-MM> --description <t> --amount <twd>
cairn pnl statement

公司月損益表(各區毛利→公司淨利)

參數

--period
旗標 · 必填

損益表結算月(格式 YYYY-MM)

--extra-income
旗標 · 選填

額外收入(台幣非負整數),併入公司淨利計算;預設 0

--json
旗標 · 選填
對應端點/api/v1/pnl/statement
範例
cairn pnl statement --period

cairn reconciliation

收款帳戶對帳 + 帳戶結算(讀取 / 報表)

cairn reconciliation accounts

逐收款帳戶現金進出對帳

參數

--date-from
旗標 · 選填

對帳期間起日(YYYY-MM-DD,含當日),以 Asia/Taipei 牆鐘日界計;省略則不設下界

--date-to
旗標 · 選填

對帳期間迄日(YYYY-MM-DD,含整日),以 Asia/Taipei 牆鐘日界計;省略則不設上界

--json
旗標 · 選填
對應端點/api/v1/reconciliation/accounts
範例
cairn reconciliation accounts
cairn reconciliation list-accounts

收款帳戶目錄

參數

--active-only
旗標 · 選填

是否只回傳啟用中的收款帳戶(true/false);省略則含停用

--json
旗標 · 選填
對應端點/api/v1/reconciliation/receiving-accounts
範例
cairn reconciliation list-accounts
cairn reconciliation settlement-overview

月結互抵派生總覽

參數

--period
旗標 · 必填

要查詢月結互抵總覽的結算期(YYYY-MM)

--json
旗標 · 選填
對應端點/api/v1/reconciliation/settlement-overview
範例
cairn reconciliation settlement-overview --period
cairn reconciliation transfers

帳戶間移轉統一分類帳

參數

--kind
旗標 · 選填

移轉類型篩選(fx_conversion 換匯 / replenishment 補款 / advance 代墊 / backfill 回填 / refund_payout 退款匯出 / reversal 沖正);省略則含全部

--account
旗標 · 選填

帳戶 ID 篩選,回傳該帳戶為出帳或進帳方的移轉;省略則不限帳戶

--date-from
旗標 · 選填

移轉日期起日(YYYY-MM-DD,含當日);省略則不設下界

--date-to
旗標 · 選填

移轉日期迄日(YYYY-MM-DD,含當日);省略則不設上界

--settlement-period
旗標 · 選填

對應月結期間(YYYY-MM)篩選;省略則不限月結

--obligation
旗標 · 選填

掛帳 ID 篩選,回傳沖減該筆掛帳的移轉;省略則不限掛帳

--json
旗標 · 選填
對應端點/api/v1/reconciliation/transfers
範例
cairn reconciliation transfers
cairn reconciliation obligations

未結掛帳追蹤

參數

--period
旗標 · 選填

月結來源期間(YYYY-MM),篩選由該期月結互抵推導出的掛帳;省略則不限期間

--reason
旗標 · 選填

掛帳原因代碼,篩選特定成因的掛帳;省略則不限原因

--status
旗標 · 選填

掛帳狀態(如未結清 / 已結清),篩選特定結清狀態;省略則含全部

--json
旗標 · 選填
對應端點/api/v1/reconciliation/obligations
範例
cairn reconciliation obligations
cairn reconciliation refund-execs

退款執行清單(approved + paid)

參數

--status
旗標 · 選填

退款狀態篩選:approved 待執行(已核准)、paid 已執行(已出款);省略則合併回傳兩者

--json
旗標 · 選填
對應端點/api/v1/reconciliation/refund-executions
範例
cairn reconciliation refund-execs
cairn reconciliation settlement-report

月結互抵矩陣報表(同 settlement-overview 資料源)

參數

--period
旗標 · 必填

要查詢月結互抵總覽的結算期(YYYY-MM)

--json
旗標 · 選填
對應端點/api/v1/reconciliation/settlement-overview
範例
cairn reconciliation settlement-report --period
cairn reconciliation compute-settlement

重跑當期月結互抵派生 + upsert 掛帳(冪等)

參數

--period
旗標 · 必填

要計算月結互抵的結算期(YYYY-MM),可重跑且冪等(不回退已結額)

--json
旗標 · 選填
對應端點/api/v1/reconciliation/settlement/compute
範例
cairn reconciliation compute-settlement --period
cairn reconciliation create-transfer

登錄帳戶間移轉(補款/代墊/回填/退款匯出/換匯/沖正;可選沖減掛帳)

參數

--kind <fx_conversion|replenishment|advance|backfill|refund_payout|reversal>
旗標 · 必填

移轉類型篩選(fx_conversion 換匯 / replenishment 補款 / advance 代墊 / backfill 回填 / refund_payout 退款匯出 / reversal 沖正);省略則含全部

--amount <twd>
旗標 · 必填
--occurred-at <YYYY-MM-DD>
旗標 · 必填

移轉發生日期(YYYY-MM-DD)

--from
旗標 · 選填
--to
旗標 · 選填
--fee
旗標 · 選填
--settlement-period
旗標 · 選填

對應月結期間(YYYY-MM)篩選;省略則不限月結

--currency
旗標 · 選填

換匯外幣幣別(ISO 4217 三碼);非換匯傳 null

--foreign-amount
旗標 · 選填

換匯外幣金額(整數最小單位,須大於 0);非換匯傳 null

--gross-rate
旗標 · 選填

換匯牌價(正數,最多 6 位小數,以字串表達避免精度遺失);非換匯傳 null

--obligation
旗標 · 選填

掛帳 ID 篩選,回傳沖減該筆掛帳的移轉;省略則不限掛帳

--confirm
對 production target 寫入時必帶
對應端點/api/v1/reconciliation/transfers
範例
cairn reconciliation create-transfer --kind <fx_conversion|replenishment|advance|backfill|refund_payout|reversal> --amount <twd> --occurred-at <YYYY-MM-DD>

cairn reports

財務報表:月結摘要(實收現金口徑,tour-scoped)

cairn reports monthly

月結財務摘要(KPI + 行程排行 + 金流商分布)

參數

--year <YYYY>
旗標 · 必填

報表年份(西元四位數),月界以台北時區計

--month <1-12>
旗標 · 必填

報表月份,1 至 12

--json
旗標 · 選填
對應端點/api/v1/reports/monthly
範例
cairn reports monthly --year <YYYY> --month <1-12>

cairn roles

RBAC 角色:列表、明細、權限目錄

cairn roles list

列出所有角色(內建 + 自訂)

參數

--system
旗標 · 選填
--custom
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/roles:param
範例
cairn roles list
cairn roles get

單一角色 + 完整權限矩陣

參數

<roleId>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/roles/:param
範例
cairn roles get <roleId>
cairn roles catalog

列出權限目錄(每個 resource 的可授權 action)

參數

--json
旗標 · 選填
對應端點/api/v1/roles/catalog
範例
cairn roles catalog
cairn roles create

新增自訂角色(name + label + 權限)

參數

--name <code>
旗標 · 必填

角色代碼,小寫英數與底線、2–32 字且須以字母開頭,建立後不可改

--label <顯示名>
旗標 · 必填

角色顯示名稱,呈現於後台角色清單

--permissions
旗標 · 選填

此角色授予的權限清單,每筆為一組資源與動作

--confirm
對 production target 寫入時必帶
對應端點/api/v1/roles
範例
cairn roles create --name <code> --label <顯示名>
cairn roles update

更新自訂角色顯示名與權限(整組覆寫)

參數

<roleId>位置參數 · 必填
--label <顯示名>
旗標 · 必填

角色顯示名稱,呈現於後台角色清單

--permissions
旗標 · 選填

完整取代後的權限清單,會整批覆寫此角色現有權限

--confirm
對 production target 寫入時必帶
對應端點/api/v1/roles/:param
範例
cairn roles update <roleId> --label <顯示名>
cairn roles delete

刪除自訂角色(仍有成員使用時拒絕)

參數

<roleId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/roles/:param
範例
cairn roles delete <roleId>

cairn settings

租戶設定:公司檔 / 收款帳戶 / 費用類別 / 模組 / 寄件網域

cairn settings get

租戶設定單例(公司檔 / 指派模式 / SEO / 寄件網域;ECPay 憑證一律遮罩)

參數

--json
旗標 · 選填
對應端點/api/v1/settings
範例
cairn settings get
cairn settings accounts

收款帳戶目錄

參數

--active-only
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/settings/receiving-accounts:param
範例
cairn settings accounts
cairn settings fee-routes

費用類別 → 收款帳戶路由表

參數

--json
旗標 · 選填
對應端點/api/v1/settings/fee-category-routes
範例
cairn settings fee-routes
cairn settings expense-categories

公司營業費用類別目錄

參數

--active-only
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/settings/expense-categories:param
範例
cairn settings expense-categories
cairn settings modules

租戶啟用的方案模組(唯讀;供應由平台 CLI 管)

參數

--json
旗標 · 選填
對應端點/api/v1/settings/modules
範例
cairn settings modules
cairn settings assignable-staff

可被指派訂單的員工名單

參數

--json
旗標 · 選填
對應端點/api/v1/settings/assignable-staff
範例
cairn settings assignable-staff
cairn settings sending-domain

寄件網域狀態(含 DNS record;網域未設定時 records 為空)

參數

--json
旗標 · 選填
對應端點/api/v1/settings/sending-domain
範例
cairn settings sending-domain
cairn settings update

更新公司檔 / 寄件身分(只送有帶的欄;空字串=清空)

參數

--company-name
旗標 · 選填

公司全名,顯示於發票、合約與對外信件抬頭;傳 null 或空字串清除

--tax-id
旗標 · 選填

公司統一編號(8 位數字),用於開立發票;傳 null 或空字串清除

--company-phone
旗標 · 選填

公司聯絡電話,顯示於對外文件;傳 null 或空字串清除

--company-address
旗標 · 選填

公司登記地址,顯示於對外文件;傳 null 或空字串清除

--logo-url
旗標 · 選填

公司 Logo 圖片網址(http/https),用於後台與對外頁面品牌呈現;傳 null 或空字串清除

--email-reply-to
旗標 · 選填

系統寄信時的回覆收件信箱,客戶回信會寄到此處;傳 null 或空字串清除

--sender-local-part
旗標 · 選填

寄件人信箱的帳號部分(@ 前段),與寄件網域組成完整寄件地址;傳 null 或空字串清除

--passport-expiry-warning-days
旗標 · 選填

護照到期前提早幾天提醒(1 至 3650 天),用於行前護照效期預警

--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings
範例
cairn settings update
cairn settings seo

更新 SEO 預設(tagline / description / og 圖;空字串=清空)

參數

--tagline
旗標 · 選填
--description
旗標 · 選填
--og-image-url
旗標 · 選填

社群分享預設縮圖(Open Graph image)網址(http/https);空字串清除

--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/seo
範例
cairn settings seo
cairn settings ledger-fees

更新內外帳試算費率(bps 0..10000;空=不變)

參數

--ecpay-bps
旗標 · 選填
--fongshou-bps
旗標 · 選填
--profit-tax-bps
旗標 · 選填

淨利稅率,單位 basis points(0..10000,10000=100%),用於內外帳淨利試算;留空不變更

--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/ledger-fees
範例
cairn settings ledger-fees
cairn settings assignment

設定訂單指派模式 + 預設指派人

參數

--mode <auto_round_robin|auto_customer_choice|manual_review>
旗標 · 必填
--default-assignee
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/assignment
範例
cairn settings assignment --mode <auto_round_robin|auto_customer_choice|manual_review>
cairn settings ecpay

ECPay 憑證(set 三欄一起寫 / clear 解除綁定;write-only)

參數

--merchant-id
旗標 · 必填

綠界 ECPay 特店編號(MerchantID),用於金流請款與簽章

--hash-key
旗標 · 必填

綠界 ECPay HashKey,CheckMacValue 簽章用密鑰;寫入後即 KMS 加密儲存且永不回傳

--hash-iv
旗標 · 必填

綠界 ECPay HashIV,CheckMacValue 簽章用初始向量;寫入後即 KMS 加密儲存且永不回傳

--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/ecpay-credentials
範例
cairn settings ecpay --merchant-id --hash-key --hash-iv
cairn settings sending-domain-manage

寄件網域:啟用 / 驗證 / 停用

參數

<enable|verify|disable>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/sending-domain/:param
範例
cairn settings sending-domain-manage <enable|verify|disable>
cairn settings accounts-write

收款帳戶寫入:create / update

參數

<id>位置參數 · 必填
--code
旗標 · 必填

收款帳戶代號,建立後不可變更,作為帳戶的穩定識別

--name
旗標 · 選填
--kind <bank|cash|gateway>
旗標 · 必填

帳戶種類:bank 銀行帳戶、cash 現金、gateway 金流閘道

--currency
旗標 · 選填

帳戶幣別,ISO 4217 三碼(如 TWD / JPY / IDR);空字串預設 TWD,非 TWD 即為外幣池

--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/receiving-accounts/api/v1/settings/receiving-accounts/:param
範例
cairn settings accounts-write <id> --code --kind <bank|cash|gateway>
cairn settings fee-routes-write

費用類型路由:upsert / set-active

參數

<id>位置參數 · 必填
--category
旗標 · 必填
--name
旗標 · 必填
--final-account
旗標 · 必填
--active <true|false>
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/settings/fee-category-routes/api/v1/settings/fee-category-routes/:param/active
範例
cairn settings fee-routes-write <id> --category --name --final-account
cairn settings expense-categories-write

費用類別:create / update / set-active

參數

<id>位置參數 · 必填
--code
旗標 · 必填

費用類別代碼(小寫英數與底線),建立後不可變更,作為類別的穩定識別

--name
旗標 · 必填
--kind <opex|tax|platform_fee|special>
旗標 · 必填

費用類別種類:opex 營業費用、tax 稅務、platform_fee 平台手續費、special 特殊,影響損益表歸類

--confirm
對 production target 寫入時必帶
--active <true|false>
旗標 · 必填
對應端點/api/v1/settings/expense-categories/api/v1/settings/expense-categories/:param/api/v1/settings/expense-categories/:param/active
範例
cairn settings expense-categories-write <id> --code --name --kind <opex|tax|platform_fee|special> --active <true|false>

cairn staff

員工:查詢租戶內部員工名單

cairn staff list

列出租戶所有員工

參數

--json
旗標 · 選填
對應端點/api/v1/staff
範例
cairn staff list
cairn staff invite

建立新員工帳號(指定角色);回一次性暫時密碼

參數

--email <e>
旗標 · 必填

受邀員工的登入 Email,作為帳號識別

--name <n>
旗標 · 必填

員工顯示姓名

--role <admin|sales|op|accountant>
旗標 · 必填

指派的員工角色(admin/sales/op/accountant),決定權限範圍

--confirm
對 production target 寫入時必帶
對應端點/api/v1/staff/invite
範例
cairn staff invite --email <e> --name <n> --role <admin|sales|op|accountant>
cairn staff set-role

變更員工角色(admin|sales|op|accountant)

參數

<userId>位置參數 · 必填
--role <admin|sales|op|accountant>
旗標 · 必填

變更後的員工角色(admin/sales/op/accountant),決定權限範圍

--confirm
對 production target 寫入時必帶
對應端點/api/v1/staff/:param/role
範例
cairn staff set-role <userId> --role <admin|sales|op|accountant>
cairn staff remove

移除員工(降為 customer,保留 user 紀錄)

參數

<userId>位置參數 · 必填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/staff/:param
範例
cairn staff remove <userId>

cairn suppliers

廠商目錄:查詢、明細

cairn suppliers list

列出/搜尋廠商目錄

參數

--status
旗標 · 選填

依狀態篩選(active 啟用 / inactive 停用 / all 全部,預設 active)

--q
旗標 · 選填

關鍵字搜尋(廠商名稱或類別)

--json
旗標 · 選填
對應端點/api/v1/suppliers
範例
cairn suppliers list
cairn suppliers get

單一廠商明細(含遮罩收款資料)

參數

<sup_id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/suppliers/:param
範例
cairn suppliers get <sup_id>
cairn suppliers create

新增廠商(出款對象主檔;進階會計模組)

參數

--name <n>
旗標 · 必填

廠商名稱(出款對象顯示名)

--category
旗標 · 選填
--payee-name
旗標 · 選填
--bank-code
旗標 · 選填
--account-number
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/suppliers
範例
cairn suppliers create --name <n>
cairn suppliers update

編輯廠商(partial:省略=保留;帳號 write-only,留空不變更)

參數

<sup_id>位置參數 · 必填
--name
旗標 · 選填

廠商名稱(出款對象顯示名)

--category
旗標 · 選填
--payee-name
旗標 · 選填
--bank-code
旗標 · 選填
--account-number
旗標 · 選填
--confirm
對 production target 寫入時必帶
對應端點/api/v1/suppliers/:param
範例
cairn suppliers update <sup_id>

cairn trips

行程:查詢、明細、團號梯次、成本範本

cairn trips list

列出/搜尋行程

參數

--status
旗標 · 選填

依行程狀態篩選(draft 草稿/published 上架/archived 封存)

--q
旗標 · 選填

自由文字搜尋(行程標題/代稱/目的地)

--group-code
旗標 · 選填

依團號篩選,列出含該團號梯次的行程

--json
旗標 · 選填
對應端點/api/v1/trips
範例
cairn trips list
cairn trips get

單一行程完整明細

參數

<id>位置參數 · 必填
--json
旗標 · 選填
對應端點/api/v1/trips/:param
範例
cairn trips get <id>
cairn trips departures

梯次:查詢(find/search)、建立、編輯、狀態、團號

參數

<tripId>位置參數 · 必填
<departureId>位置參數 · 必填
--group-code <code>
旗標 · 必填

完整團號,格式為 YY+地區+航空+MMDD+序號(如 26EGTK1010A,自動轉大寫)

--group-code-prefix <prefix>
旗標 · 必填

團號前綴,前綴比對列出多個梯次

--status <s>
旗標 · 必填

梯次狀態(selling 銷售中/closed 關閉/cancelled 取消/completed 完成)

--region <c>
旗標 · 必填
--airline <c>
旗標 · 必填
--departure-date <d>
旗標 · 必填

出發日期(YYYY-MM-DD)

對應端點/api/v1/trips/:param/departures/api/v1/trips/departures/:param/api/v1/trips/departures/:param/status/api/v1/trips/departures/:param/group-code/generate/api/v1/trips/departures/:param/group-code/api/v1/trips/departures/api/v1/trips/:param/departures/:param/lodging/api/v1/trips/:param/lodging/:param
範例
cairn trips departures <tripId> <departureId> --group-code <code> --group-code-prefix <prefix> --status <s> --region <c> --airline <c> --departure-date <d>
cairn trips create

建立行程

參數

--slug <s>
旗標 · 必填

行程網址代稱(slug),用於前台路徑與後台識別,只能小寫英數與連字號

--title <t>
旗標 · 必填

行程標題,顯示於前台與訂單

--destination <d>
旗標 · 必填

目的地名稱

--duration-days <n>
旗標 · 必填

行程天數

--price-from-twd <n>
旗標 · 必填

起價(新台幣),前台「OOO 元起」顯示用

--summary
旗標 · 選填

行程摘要,前台列表卡片用的一句話簡介

--status
旗標 · 選填

依行程狀態篩選(draft 草稿/published 上架/archived 封存)

--confirm
對 production target 寫入時必帶
對應端點/api/v1/trips
範例
cairn trips create --slug <s> --title <t> --destination <d> --duration-days <n> --price-from-twd <n>
cairn trips update

更新行程(null = 清空、未帶 = 不動)

參數

<id>位置參數 · 必填
--title
旗標 · 選填

行程標題,顯示於前台與訂單

--slug
旗標 · 選填

行程網址代稱(slug),用於前台路徑與後台識別,只能小寫英數與連字號

--status
旗標 · 選填

行程狀態(draft 草稿/published 上架/archived 封存)

--price-from-twd
旗標 · 選填

起價(新台幣),前台「OOO 元起」顯示用

--confirm
對 production target 寫入時必帶
對應端點/api/v1/trips/:param
範例
cairn trips update <id>
cairn trips set-cost-template

綁定 / 解綁行程的成本範本

參數

<tripId>位置參數 · 必填
--template-id <id>
旗標 · 選填

要綁定的成本範本 ID;null 或省略表示解除綁定

--confirm
對 production target 寫入時必帶
對應端點/api/v1/trips/:param/cost-template
範例
cairn trips set-cost-template <tripId>
cairn trips cost-templates

列出可綁定的 active 成本範本

參數

--json
旗標 · 選填
對應端點/api/v1/trips/cost-templates
範例
cairn trips cost-templates
cairn trips import

批次匯入行程(.xlsx/.csv;預設 dry-run,--commit 才建檔)

參數

--file <path.xlsx>
旗標 · 必填
--commit
旗標 · 選填
--confirm
對 production target 寫入時必帶
--json
旗標 · 選填
對應端點/api/v1/trips/import/api/v1/trips/import/validate
範例
cairn trips import --file <path.xlsx>
cairn trips export

匯出行程為 CSV/JSON(同 list 篩選)

參數

--status
旗標 · 選填

依行程狀態篩選(draft 草稿/published 上架/archived 封存)

--q
旗標 · 選填

自由文字搜尋(行程標題/代稱/目的地)

--group-code
旗標 · 選填

依團號篩選,匯出含該團號梯次的行程

--format
旗標 · 選填
--json
旗標 · 選填
對應端點/api/v1/trips/export
範例
cairn trips export

Command Palette

Search for a command to run...