Activity

Version 2019-04

Succinct overview of a shop activity.

Required access

read_home access scope

Show definition
"""
Succinct overview of a shop activity.
"""
type Activity {
  """
  True if the message already contains the author name.
  """
  attributed: Boolean!
  """
  Event author name. This may be a user name, app name or `Shopify`.
  """
  author: String!
  """
  When the activity event occured.
  """
  createdAt: DateTime!
  """
  An array of formatted messages, each providing detail about the activity. Typically only a single message is present.
  """
  messages: [FormattedString!]!
  """
  The topic of the activity, used to display an appropriate icon.
  """
  topic: ActivityTopic!
}

Fields

attributed (Boolean!)

True if the message already contains the author name.

author (String!)

Event author name. This may be a user name, app name or Shopify.

createdAt (DateTime!)

When the activity event occured.

messages ([FormattedString!]!)

An array of formatted messages, each providing detail about the activity. Typically only a single message is present.

topic (ActivityTopic!)

The topic of the activity, used to display an appropriate icon.

Version 2019-07

Succinct overview of a shop activity.

Required access

read_home access scope

Show definition
"""
Succinct overview of a shop activity.
"""
type Activity {
  """
  True if the message already contains the author name.
  """
  attributed: Boolean!
  """
  Event author name. This may be a user name, app name or `Shopify`.
  """
  author: String!
  """
  When the activity event occured.
  """
  createdAt: DateTime!
  """
  An array of formatted messages, each providing detail about the activity. Typically only a single message is present.
  """
  messages: [FormattedString!]!
  """
  The topic of the activity, used to display an appropriate icon.
  """
  topic: ActivityTopic!
}

Fields

attributed (Boolean!)

True if the message already contains the author name.

author (String!)

Event author name. This may be a user name, app name or Shopify.

createdAt (DateTime!)

When the activity event occured.

messages ([FormattedString!]!)

An array of formatted messages, each providing detail about the activity. Typically only a single message is present.

topic (ActivityTopic!)

The topic of the activity, used to display an appropriate icon.

Version 2019-10 (Latest)

Succinct overview of a shop activity.

Required access

read_home access scope

Show definition
"""
Succinct overview of a shop activity.
"""
type Activity {
  """
  True if the message already contains the author name.
  """
  attributed: Boolean!
  """
  Event author name. This may be a user name, app name or `Shopify`.
  """
  author: String!
  """
  When the activity event occured.
  """
  createdAt: DateTime!
  """
  An array of formatted messages, each providing detail about the activity. Typically only a single message is present.
  """
  messages: [FormattedString!]!
  """
  The topic of the activity, used to display an appropriate icon.
  """
  topic: ActivityTopic!
}

Fields

attributed (Boolean!)

True if the message already contains the author name.

author (String!)

Event author name. This may be a user name, app name or Shopify.

createdAt (DateTime!)

When the activity event occured.

messages ([FormattedString!]!)

An array of formatted messages, each providing detail about the activity. Typically only a single message is present.

topic (ActivityTopic!)

The topic of the activity, used to display an appropriate icon.

Version 2020-01 (Release candidate)

Succinct overview of a shop activity.

Required access

read_home access scope

Show definition
"""
Succinct overview of a shop activity.
"""
type Activity {
  """
  True if the message already contains the author name.
  """
  attributed: Boolean!
  """
  Event author name. This may be a user name, app name or `Shopify`.
  """
  author: String!
  """
  When the activity event occured.
  """
  createdAt: DateTime!
  """
  An array of formatted messages, each providing detail about the activity. Typically only a single message is present.
  """
  messages: [FormattedString!]!
  """
  The topic of the activity, used to display an appropriate icon.
  """
  topic: ActivityTopic!
}

Fields

attributed (Boolean!)

True if the message already contains the author name.

author (String!)

Event author name. This may be a user name, app name or Shopify.

createdAt (DateTime!)

When the activity event occured.

messages ([FormattedString!]!)

An array of formatted messages, each providing detail about the activity. Typically only a single message is present.

topic (ActivityTopic!)

The topic of the activity, used to display an appropriate icon.

Sign up for a Partner account to get started.

Sign up