組員資料
以 enrollment 管理商家的組員資料、組別歸屬、身份別與停權狀態。
可用操作
| Method | Path | 用途 |
|---|---|---|
GET | /v1/enrollments | 查詢 Service Account 可管理的組員 |
POST | /v1/enrollments/{merchantId} | 在指定商家建立組員 |
PUT | /v1/enrollment/{enrollmentId}/profile | 替換組員基本資料 |
PUT | /v1/enrollment/{enrollmentId}/squads | 完整更新組別歸屬與問卷開放設定 |
PUT | /v1/enrollment/{enrollmentId}/suspension | 建立或修改停權期間 |
GET | /v1/identity-tags/{merchantId} | 取得商家可用的身份別 |
查詢組員
GET /v1/enrollments 可使用 merchantId、phone 或 externalId 查找組員。同時帶入多個條件時,只會回傳全部條件都符合的資料;例如同時帶入 merchantId 與 phone,必須是指定商家內電話相符的組員才會出現。
建立與更新
建立組員至少需要 phone、name、alias 與 parttime。parttime 為布林值:true 代表兼職,false 代表非兼職。可另外帶入外部系統識別 externalId、啟用時間、身份別與初始組別。
更新前先取得現有資料
PUT 不支援只傳送想修改的欄位。更新 profile 前,建議先查詢組員現有資料,修改指定欄位後,再將 API 要求的欄位完整送回。
更新 squads 時,本次送出的組別清單會取代原有清單;未帶入的原有組別會被移除。每個組別都要帶入 squadId、shiftSurveyEligible 與 dayOffSurveyEligible。shiftSurveyEligible 表示是否開放該組員的排班問卷,dayOffSurveyEligible 表示是否開放休假問卷。請先保留現有設定,再修改需要調整的值。
更新前,請確認目標商家在 Service Account 的授權範圍內;若 API 回傳 403,代表目前憑證無法執行該操作。
完整 request/response schema 請參考 Enrollment API。