guidedFlows

Requires permission products:product:read.

Lists the product finders (guided flows) set up for the storefront or the order pad, optionally only those offered in one app. Requires permission to read products.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query GuidedFlows {
  guidedFlows {
    id
    imageUrl
    label
    surfaces
    openFrom {
      attributeKey
      except
      kind
      mode
      values
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query GuidedFlows {\n  guidedFlows {\n    id\n    imageUrl\n    label\n    surfaces\n    openFrom {\n      attributeKey\n      except\n      kind\n      mode\n      values\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "guidedFlows": [
      {
        "id": "id",
        "imageUrl": "string",
        "label": "string",
        "surfaces": [
          "BUYER"
        ],
        "openFrom": [
          {
            "attributeKey": "string",
            "except": [
              "string"
            ],
            "kind": "ATTRIBUTE",
            "mode": "ALL",
            "values": [
              "string"
            ]
          }
        ]
      }
    ]
  }
}

guidedFlows(
  surface: GuidedFlowSurface
): [GuidedFlow!]!

Arguments

guidedFlows.surface ● GuidedFlowSurface enum

Only return the flows offered in this app. Omit it to return every flow.

Type

GuidedFlow object

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