StaffMemberPrivateData

Version 2019-04 (latest)

Data used to customize the Shopify admin for a logged-in staff member.

Show definition

"""
Data used to customize the Shopify admin for a logged-in staff member.
"""
type StaffMemberPrivateData {
  """
  URL to the user's account settings page.
  """
  accountSettingsUrl: URL!
  """
  Paginated list of activities.
  """
  activityFeed(
    """
    Number of activities to return ordered by date descending.
    """
    first: Int!
  ): ActivityConnection!
  """
  Information on Capital updated on a regular schedule.
  """
  capital: HomeCapitalSummary
  """
  A list of cards that can be shown to the staff member on the Shopify Home.
  """
  cards(
    """
    Show only home cards with a specified action to the staff member.
    """
    acceptAction: [HomeCardAction!]
    """
    Show only home cards with a specified layout to the staff member.
    """
    acceptLayout: [HomeCardLayout!]
  ): [HomeCard!]!
  """
  The date when the user was created.
  """
  createdAt: DateTime!
  """
  Home Feed Theme holding more information about the list of Home Cards.
  """
  feedTheme: HomeFeedTheme
  """
  Home greeting messages localized to the client time.
  """
  greeting(
    """
    The date and time in the staff member's locale.
    """
    clientDatetime: DateTime!
  ): HomeGreeting!
  """
  Notifications that will be shown to the staff member on the Shopify Home.
  """
  notifications: [HomeNotification!]!
  """
  Access permisions for the staff member.
  """
  permissions: [StaffMemberPermission!]!
  """
  List of merchant tasks requiring action.
  """
  tasks: [HomeTask!]!
}

Connections

activityFeed (ActivityConnection!)

Paginated list of activities.

first ( Int! ) required

Number of activities to return ordered by date descending.

Fields

accountSettingsUrl (URL!)

URL to the user's account settings page.

capital (HomeCapitalSummary)

Information on Capital updated on a regular schedule.

cards ([HomeCard!]!)

A list of cards that can be shown to the staff member on the Shopify Home.

acceptAction ( [HomeCardAction!] )

Show only home cards with a specified action to the staff member.

acceptLayout ( [HomeCardLayout!] )

Show only home cards with a specified layout to the staff member.

createdAt (DateTime!)

The date when the user was created.

feedTheme (HomeFeedTheme)

Home Feed Theme holding more information about the list of Home Cards.

greeting (HomeGreeting!)

Home greeting messages localized to the client time.

clientDatetime ( DateTime! ) required

The date and time in the staff member's locale.

notifications ([HomeNotification!]!)

Notifications that will be shown to the staff member on the Shopify Home.

permissions ([StaffMemberPermission!]!)

Access permisions for the staff member.

tasks ([HomeTask!]!)

List of merchant tasks requiring action.

Sign up for a Partner account to get started.

Sign up