HomeCard

This page was printed on Feb 15, 2019. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/interface/homecard.

Base information for all card layouts.

Show definition 

# Base information for all card layouts.
interface HomeCard {
  # Specifies which badge applies to the card.
  badge: HomeBadge
  # A list of buttons displayed on the card.
  buttons: [HomeButton!]!
  # Specifies a time window that the contents of the card applies to.
  dateRange: FormattedString
  # A message displayed when the user dismisses the card.
  dismissMessage: String!
  # A title displayed when the user dismisses the card.
  dismissTitle: String!
  # Specifies if this card should be considered to be featured inside of the feed theme header.
  featured: Boolean!
  # A list of predefined messages and intents the user can select from when
  # sending feedback about the card. Intent can be used to pre-filter feedback
  # messages by their tone.
  feedback: [HomeCardFeedback!]!
  # A list of predefined messages the user can select from when sending feedback about the card.
  feedbackOptions: [String!]!
  # ID of the card.
  id: ID!
  # An image displayed on the card.
  image(
    # Converts image file type from SVG to PNG, or leaves as original SVG.
    contentType: HomeContentType = PNG
    # Image height in pixels between 1 and 2048. This argument is deprecated: Use
    # maxHeight on Image.transformedSrc instead.
    maxHeight: Int
    # Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.
    maxWidth: Int
  ): Image
  # Specifies a view template to use when rendering the card.
  layout: HomeCardLayout!
  # A more detailed description of the card, typically containing the actual messaging to the merchant.
  message: FormattedString
  # Specifies if this card can be voted on.
  showVote: Boolean!
  # Specifies if this card can be pulled up into a priority container on top of the feed.
  spotlight: Boolean!
  # Text for the header of the card.
  title: FormattedString!
}

Possible types

Fields

badge   (HomeBadge)

Specifies which badge applies to the card.

buttons   ([HomeButton!]!)

A list of buttons displayed on the card.

dateRange   (FormattedString)

Specifies a time window that the contents of the card applies to.

dismissMessage   (String!)

A message displayed when the user dismisses the card.

dismissTitle   (String!)

A title displayed when the user dismisses the card.

Specifies if this card should be considered to be featured inside of the feed theme header.

feedback   ([HomeCardFeedback!]!)

A list of predefined messages and intents the user can select from when sending feedback about the card. Intent can be used to pre-filter feedback messages by their tone.

id   (ID!)

ID of the card.

image   (Image)

An image displayed on the card.

Argument Type Default Description
contentType

 HomeContentType

PNG

Converts image file type from SVG to PNG, or leaves as original SVG.
maxHeight

 Int

Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.
maxWidth

 Int

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

layout   (HomeCardLayout!)

Specifies a view template to use when rendering the card.

message   (FormattedString)

A more detailed description of the card, typically containing the actual messaging to the merchant.

showVote   (Boolean!)

Specifies if this card can be voted on.

spotlight   (Boolean!)

Specifies if this card can be pulled up into a priority container on top of the feed.

title   (FormattedString!)

Text for the header of the card.

Deprecated fields

Show/Hide

feedbackOptions   ([String!]!)

deprecated

A list of predefined messages the user can select from when sending feedback about the card.

Deprecation warning

Use feedback instead

Sign up for a Partner account to get started.

Sign up