班表資料
依組別與日期範圍查詢班表,並區分原排班與實際出勤調整。
使用端點
GET /v1/shifts/{squadId}?from=2026-09-01&to=2026-09-07
| 參數 | 必填 | 說明 |
|---|---|---|
squadId | 是 | 可存取的組別 ID |
from | 否 | 起始日期,包含當日;預設為今天 |
to | 否 | 結束日期,包含當日;需與 from 一起使用,預設等於 from |
- 不帶
from與to:查詢今天。 - 只帶
from:查詢from指定的當天。 - 同時帶
from與to:查詢包含起訖日在內的日期範圍。 - 請勿只帶
to。
班表模型
每筆班表包含組員、組別、商家、班表日期與建立/更新資訊。排班內容分成:
planned:原本安排的班表。actual:經過當天調整後的實際班表。
兩者都可能包含是否休假、假別、工作時段與崗位,以及計算後的 workingMinutes。若當日沒有後續調整,planned 與 actual 可能相同。
建議流程
- 先以
GET /v1/squads取得squadId與該組別所屬的商家 ID。 - 以
GET /v1/merchants取得該商家的timezone。 - 依實際同步區間帶入
from與to。 - 以商家的
timezone解讀班表日期。 - 以班表
id作為同步識別,並保留updatedTime供後續比對。
回應物件的完整欄位請參考 Query accessible shifts。