Skip to main content

GuidedSellingConversation

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

One customer conversation: the steps a storefront sent under the same conversationId.

type GuidedSellingConversation {
  id: ID!
  flowId: ID!
  version: Int!
  language: String!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  turnCount: Int!
  completed: Boolean!
  turns(
    input: GuidedSellingConversationTurnSearchInput
  ): GuidedSellingConversationTurnResponse!
  outcomes: [GuidedSellingOutcome!]!
}

Fields​

GuidedSellingConversation.id ● ID! non-null scalar​

The conversationId the storefront sent with its steps.

GuidedSellingConversation.flowId ● ID! non-null scalar​

The flow the conversation ran on.

GuidedSellingConversation.version ● Int! non-null scalar​

The flow version the conversation ran on.

GuidedSellingConversation.language ● String! non-null scalar​

Language of the conversation, Propeller format (e.g. EN).

GuidedSellingConversation.createdAt ● DateTime! non-null scalar​

Moment of the first step.

GuidedSellingConversation.lastModifiedAt ● DateTime! non-null scalar​

Moment of the latest step.

GuidedSellingConversation.turnCount ● Int! non-null scalar​

Number of steps recorded: the opener, going back and failed steps included. A repeat of the latest step with the same result is not recorded again, and a conversation records at most 100.

GuidedSellingConversation.completed ● Boolean! non-null scalar​

True once the conversation reached an advice.

GuidedSellingConversation.turns ● GuidedSellingConversationTurnResponse! non-null object​

The steps of the conversation, a page at a time, in the order the customer lived them, each with the model calls behind its state. Answers can contain customer-typed text. Selected on a list, every conversation's page comes from one read.

GuidedSellingConversation.turns.input ● GuidedSellingConversationTurnSearchInput input​

GuidedSellingConversation.outcomes ● [GuidedSellingOutcome!]! non-null object​

What the storefront reported, oldest first: at most 50. Selected on a list, every conversation's outcomes come from one read.

Returned By​

guidedSellingConversation query

Member Of​

GuidedSellingConversationResponse object