Get Staff

Function

To retrieve a specific staff by id
以 id 獲取指定的員工資訊

URL

GET <<api_domain>>/v1/staffs/:staff_id

Request Parameters

Parameter	Type	Description	Example
staff_id	`String`	Staff ID 員工 ID	`61235e00800162002de61919`

Response Fields

Field	Type	Description	Example
id	`String`	Staff ID 員工 ID	61236c9a6ed8bb001ef6877b
user_id	`String`	User ID 用戶 ID	5afaa3b0d2a93e03a1000020
created_at	`Date`	Created Time 建立時間	2018-05-15T09:09:04.497Z
merchant_ids	`Array`	Merchant IDs 擁有的所有商家 ID	`["5afaa3b0e38809312d00002e"]`
organization_ids	`Array`	Organization IDs 擁有的所有組織 ID	`["5afaa3b0e38809312d00002e"]`
email	`String`	Staff Email 員工電子郵件地址	[email protected]
name	`String`	Staff Name 員工名稱	shopline
locale_code	`String`	Locale Code 地區代碼	zh-hant
role_keys	`Array`
profile_image_url	`String`	Profile Image URL 個人照片網址
owned_merchants	`Array`	Owned Merchants 擁有的商家資訊	`[ { "_id": "5afaa3b0e38809312d00002e", "name": "shopline", "handle": "shopline", "logo_media_id": "637475f5e03d430036032bbb", "base_country_code": "TW", "custom_domain": "" } ],`
employed_merchants	`Array`	Employed Merchants 受雇的商家資訊	`[ { "_id": "5afaa3b0e38809312d00002e", "name": "shopline", "handle": "shopline", "logo_media_id": "637475f5e03d430036032bbb", "base_country_code": "TW", "custom_domain": "" } ],`
channel_ids	`Array`	Channel IDs 所有頻道 ID	`["606ed59eb230660044e8ef7a"]`
permissions	`Array`	Permission List if permission_scopes is not provided, this field will return null 權限列表如果沒有permission_scopes，返回null

Response Example

{
    "id": "5b728d18e388094d52cf28a2",
    "_id": "5b728d18e388094d52cf28a2",
    "user_id": "5afaa3b0d2a93e03a1000020",
    "created_at": "2018-05-15T09:09:04.497Z",
    "merchant_ids": [
        "5afaa3b0e38809312d00002e"
    ],
    "organization_ids": [],
    "email": "[email protected]",
    "name": "shopline",
    "locale_code": "zh-hant",
    "role_keys": [],
    "profile_image_url": "https://shoplineimg.com/assets/misc/placeholder-user-default.png",
    "owned_merchants": [
        {
            "_id": "5afaa3b0e38809312d00002e",
            "name": "shopline",
            "handle": "shopline",
            "logo_media_id": "637475f5e03d430036032bbb",
            "base_country_code": "TW",
            "custom_domain": ""
        }
    ],
    "employed_merchants": [
        {
            "_id": "5afa5eabe38809312d000006",
            "name": "shopline",
            "handle": "shopline",
            "logo_media_id": null,
            "base_country_code": "TW",
            "custom_domain": null
        }
    ],
    "channel_ids": [
        "606ed59eb230660044e8ef7a"
    ],
    "permissions": null
}