customerGuidedVariantFacts

Requires a customer (portal or buyer app) session.

Returns the display facts of the given product variants that guided flows show on their option cards.

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 CustomerGuidedVariantFacts($variantIds: [ID!]!) {
  customerGuidedVariantFacts(variantIds: $variantIds) {
    attributes
    brandId
    categoryIds
    productId
    tags
    variantId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerGuidedVariantFacts($variantIds: [ID!]!) {\n  customerGuidedVariantFacts(variantIds: $variantIds) {\n    attributes\n    brandId\n    categoryIds\n    productId\n    tags\n    variantId\n  }\n}",
  "variables": {
    "variantIds": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "variantIds": [
    "id"
  ]
}

Response:

{
  "data": {
    "customerGuidedVariantFacts": [
      {
        "attributes": {},
        "brandId": "id",
        "categoryIds": [
          "id"
        ],
        "productId": "id",
        "tags": [
          "string"
        ],
        "variantId": "id"
      }
    ]
  }
}

customerGuidedVariantFacts(
  variantIds: [ID!]!
): [GuidedVariantFacts!]!

Arguments

customerGuidedVariantFacts.variantIds ● [ID!]! non-null scalar

The IDs of the variants to return facts for.

Type

GuidedVariantFacts object

Facts about a variant used by a guided flow.