Skip to main content

GuidedSellingAdviceItem

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

One advised item, by identifier: a plain product or a configured cluster. The storefront fetches names, prices, stock and media itself.

type GuidedSellingAdviceItem {
  productId: Int!
  reason: String!
  clusterId: Int
  options: [GuidedSellingAdviceOption!]
  addOns: [GuidedSellingAdviceAddOn!]!
}

Fields​

GuidedSellingAdviceItem.productId ● Int! non-null scalar​

Propeller product identifier: the product to show and to add to the cart. For a configured cluster, the chosen variant.

GuidedSellingAdviceItem.reason ● String! non-null scalar​

One sentence, grounded in the customer's answers, in the language of the request.

GuidedSellingAdviceItem.clusterId ● Int scalar​

Set when the item is a configured cluster: the cluster the variant and the options belong to.

GuidedSellingAdviceItem.options ● [GuidedSellingAdviceOption!] list object​

The cluster's chosen option products, in the cluster's option order. Null for a plain product, empty for a cluster without options; test clusterId to tell them apart.

GuidedSellingAdviceItem.addOns ● [GuidedSellingAdviceAddOn!]! non-null object​

Products to offer with this item, as the flow's instruction says. Empty when none fits.

Member Of​

GuidedSellingAdvice object