Skip to main content

GuidedStepOption

One choice offered in a guided step.

type GuidedStepOption {
  available: Boolean!
  imageUrl: String
  label: String!
  matchingVariantCount: Int!
  productId: ID
  value: String!
  variantId: ID
  variantIds: [ID!]!
}

Fields​

GuidedStepOption.available ● Boolean! non-null scalar​

True when something matching the choice is available.

GuidedStepOption.imageUrl ● String scalar​

The URL of an image for the choice.

GuidedStepOption.label ● String! non-null scalar​

The text to show.

GuidedStepOption.matchingVariantCount ● Int! non-null scalar​

How many variants match the choice.

GuidedStepOption.productId ● ID scalar​

Product and variant steps: the product the choice is.

GuidedStepOption.value ● String! non-null scalar​

The value sent back when it is chosen.

GuidedStepOption.variantId ● ID scalar​

Variant steps: the variant itself. Product steps: the variant to open the product on.

GuidedStepOption.variantIds ● [ID!]! non-null scalar​

Product and variant steps: every variant the choice matches so far. Empty for other steps.

Member Of​

GuidedStepResult object