Skip to main content

GuidedSellingStepInput

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

The full conversation state: every answer so far, in order. Send everything, every call; the runtime keeps no session.

input GuidedSellingStepInput {
  flowId: ID!
  version: Int
  language: String
  conversationId: ID!
  answers: [GuidedSellingAnswerInput!]!
}

Fields​

GuidedSellingStepInput.flowId ● ID! non-null scalar​

Identifier of the flow the conversation runs on (UUID).

GuidedSellingStepInput.version ● Int scalar​

Leave empty in a storefront. A new conversation starts on the published version and a running one stays on the version it started on, because question ids carry their version. configuration.EDITOR or OWNER only: play a draft or an older version, sent on the first call only; from a storefront any version but the published one is refused.

GuidedSellingStepInput.language ● String scalar​

One of the flow's languages, two letters in any case, e.g. EN. Send the same one on every call: changing it means starting over. Leave it out for the flow's authored language.

GuidedSellingStepInput.conversationId ● ID! non-null scalar​

A new random UUID per conversation, generated by the storefront, 1 to 128 characters, never reused across flows. Groups its steps in the history; it carries no meaning, so put no customer data in it. An id sent again continues that conversation; an id that belongs to another flow is refused with GUIDED_SELLING_INPUT_INVALID_ERROR.

GuidedSellingStepInput.answers ● [GuidedSellingAnswerInput!]! non-null input​

Everything the customer answered so far, oldest first, picked and typed answers in the order they happened. Send the full list every call. Each entry counts as one exchange against the flow's question budget, so the list holds at most the flow's maxQuestions entries, and never more than 20.

Member Of​

guidedSellingStep mutation