Skip to main content

GuidedStepResult

The next step of a guided flow, or its final result.

type GuidedStepResult {
  contextCategory: GuidedContextCategory
  display: GuidedStepDisplay
  entry: GuidedStepEntry
  flowId: ID!
  kind: GuidedStepResultKind!
  label: String
  opensProduct: Boolean!
  options: [GuidedStepOption!]!
  rows: [GuidedVariantRow!]!
  search: Boolean!
  stepKey: String
  truncated: Boolean!
}

Fields

`GuidedStepResult.contextCategory` ● `GuidedContextCategory` object

The category a 'View all' link opens: a CATEGORY step's current parent, else the entry category

`GuidedStepResult.display` ● `GuidedStepDisplay` enum

How to show the options.

`GuidedStepResult.entry` ● `GuidedStepEntry` object

The entry in effect; null when none was given or it was ignored

`GuidedStepResult.flowId` ● `ID!` non-null scalar

The ID of the flow.

`GuidedStepResult.kind` ● `GuidedStepResultKind!` non-null enum

Whether this is a step to answer or the final list of variants.

`GuidedStepResult.label` ● `String` scalar

The question or title to show.

`GuidedStepResult.opensProduct` ● `Boolean!` non-null scalar

True for a product or variant step: it ends the journey, showing its variants as the product list does, and a choice opens the product page.

`GuidedStepResult.options` ● `[GuidedStepOption!]!` non-null object

The choices of the step.

`GuidedStepResult.rows` ● `[GuidedVariantRow!]!` non-null object

The matching variants, at the end of the flow.

`GuidedStepResult.search` ● `Boolean!` non-null scalar

True when the step offers a search box.

`GuidedStepResult.stepKey` ● `String` scalar

The key of the step.

`GuidedStepResult.truncated` ● `Boolean!` non-null scalar

True when more rows matched than were returned

Returned By

customerGuidedStep query ● guidedFlowPreview query

Fields
Returned By