跳至主要内容

班表資料

依組別與日期範圍查詢班表,並區分原排班與實際出勤調整。

使用端點

GET /v1/shifts/{squadId}?from=2026-09-01&to=2026-09-07
參數必填說明
squadId可存取的組別 ID
from起始日期,包含當日;預設為今天
to結束日期,包含當日;需與 from 一起使用,預設等於 from
  • 不帶 fromto:查詢今天。
  • 只帶 from:查詢 from 指定的當天。
  • 同時帶 fromto:查詢包含起訖日在內的日期範圍。
  • 請勿只帶 to

班表模型

每筆班表包含組員、組別、商家、班表日期與建立/更新資訊。排班內容分成:

  • planned:原本安排的班表。
  • actual:經過當天調整後的實際班表。

兩者都可能包含是否休假、假別、工作時段與崗位,以及計算後的 workingMinutes。若當日沒有後續調整,plannedactual 可能相同。

建議流程

  1. 先以 GET /v1/squads 取得 squadId 與該組別所屬的商家 ID。
  2. GET /v1/merchants 取得該商家的 timezone
  3. 依實際同步區間帶入 fromto
  4. 以商家的 timezone 解讀班表日期。
  5. 以班表 id 作為同步識別,並保留 updatedTime 供後續比對。

回應物件的完整欄位請參考 Query accessible shifts