stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > StaffMember

AdminTypes.StaffMember interface

Represents the data about a staff member’s Shopify account. Merchants can use staff member data to get more information about the staff members in their store.

Signature:

export interface StaffMember extends Node 

Extends: Node

Properties

Property Modifiers Type Description
active   Scalars[‘Boolean’][‘output’] Whether the staff member is active.
avatar   Image The image used as the staff member’s avatar in the Shopify admin.
email   Scalars[‘String’][‘output’] The staff member’s email address.
exists   Scalars[‘Boolean’][‘output’] Whether the staff member’s account exists.
firstName?   Maybe<Scalars[‘String’][‘output’]> (Optional) The staff member’s first name.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
initials?   Maybe<Array<Scalars[‘String’][‘output’]>> (Optional) The staff member’s initials, if available.
isShopOwner   Scalars[‘Boolean’][‘output’] Whether the staff member is the shop owner.
lastName?   Maybe<Scalars[‘String’][‘output’]> (Optional) The staff member’s last name.
locale   Scalars[‘String’][‘output’] The staff member’s preferred locale. Locale values use the format language or language-COUNTRY, where language is a two-letter language code, and COUNTRY is a two-letter country code. For example: en or en-US
name   Scalars[‘String’][‘output’] The staff member’s full name.
phone?   Maybe<Scalars[‘String’][‘output’]> (Optional) The staff member’s phone number.
privateData   StaffMemberPrivateData The data used to customize the Shopify admin experience for the staff member.