GuidedSellingFlow

BETA: guided selling can still change in ways that break existing integrations. Backwards compatibility is not guaranteed while it is in beta.

A guided selling flow, for management. Content lives in versions; the storefront needs only guidedSellingStep and the flow's id.

type GuidedSellingFlow {
  id: ID!
  name: String!
  active: Boolean!
  version: Int
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  createdBy: Int
  lastModifiedBy: Int
  stats(createdAt: DateSearchInput): GuidedSellingFlowStats!
}

Fields

GuidedSellingFlow.id ● ID! non-null scalar

Unique identifier of the guided selling flow (UUID v7).

GuidedSellingFlow.name ● String! non-null scalar

Display name of the flow, for management screens, 1 to 255 characters. Customers never see it.

GuidedSellingFlow.active ● Boolean! non-null scalar

An inactive flow refuses guidedSellingStep from storefronts (GUIDED_SELLING_FLOW_INACTIVE_ERROR). Users and keys with configuration.EDITOR or OWNER can still run it, to test it.

GuidedSellingFlow.version ● Int scalar

The published version: the one new conversations start on. Null while none is. Not a step's version pin, nor the version a step result carries.

GuidedSellingFlow.createdAt ● DateTime! non-null scalar

Moment the flow was created.

GuidedSellingFlow.lastModifiedAt ● DateTime! non-null scalar

Moment the flow, its key or its published version last changed.

GuidedSellingFlow.createdBy ● Int scalar

Unique identifier of the user who created this flow. Null when it was created with an API key.

GuidedSellingFlow.lastModifiedBy ● Int scalar

Unique identifier of the user who last changed this flow. Null when that was done with an API key.

GuidedSellingFlow.stats ● GuidedSellingFlowStats! non-null object

This flow's conversion, counted like guidedSellingFlowStats over all versions. Selected on a list of flows, every flow's figures come from one count.

GuidedSellingFlow.stats.createdAt ● DateSearchInput input

Only conversations whose first step falls in this window. All of them when left out.

Returned By

guidedSellingFlow query ● guidedSellingFlowCreate mutation ● guidedSellingFlowUpdate mutation

Member Of

GuidedSellingFlowResponse object