Skip to main content

GuidedFlow

A guided flow that helps a buyer find the right variant step by step.

type GuidedFlow {
  id: ID!
  imageUrl: String
  label: String!
  openFrom: [GuidedEntryRule!]!
  options: GuidedFlowOptions!
  rows: GuidedRowsConfig!
  scope: GuidedFlowScope
  steps: [GuidedStep!]!
  surfaces: [GuidedFlowSurface!]!
}

Fields​

GuidedFlow.id ● ID! non-null scalar​

The unique ID of this record.

GuidedFlow.imageUrl ● String scalar​

The URL of an image for the flow.

GuidedFlow.label ● String! non-null scalar​

The name of the flow.

GuidedFlow.openFrom ● [GuidedEntryRule!]! non-null object​

What opens this flow on the buyer app instead of a listing; empty means only links do

GuidedFlow.options ● GuidedFlowOptions! non-null object​

How the flow behaves.

GuidedFlow.rows ● GuidedRowsConfig! non-null object​

How the final variants are listed.

GuidedFlow.scope ● GuidedFlowScope object​

The products the flow covers. Empty means all.

GuidedFlow.steps ● [GuidedStep!]! non-null object​

The steps of the flow.

GuidedFlow.surfaces ● [GuidedFlowSurface!]! non-null enum​

Where the flow is offered.

Returned By​

customerGuidedFlows query ● guidedFlows query ● setGuidedFlows mutation