guidedFlowCatalogShape

Requires permission settings:tenant:update.

Lists the product attributes a product finder can ask about, each with its values and how many active variants carry each. Attribute spellings that differ only by case count as one attribute. Requires permission to update tenant settings.

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 GuidedFlowCatalogShape {
  guidedFlowCatalogShape {
    key
    valuesTruncated
    variantCount
    values {
      value
      variantCount
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query GuidedFlowCatalogShape {\n  guidedFlowCatalogShape {\n    key\n    valuesTruncated\n    variantCount\n    values {\n      value\n      variantCount\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "guidedFlowCatalogShape": [
      {
        "key": "string",
        "valuesTruncated": true,
        "variantCount": 0,
        "values": [
          {
            "value": "string",
            "variantCount": 0
          }
        ]
      }
    ]
  }
}

guidedFlowCatalogShape: [GuidedAttributeKey!]!

Type

GuidedAttributeKey object

One variant attribute of the catalog, as a guided step could use it