enrichProduct

DEPRECATED

Blocks the request for ~140s and exceeds the client HTTP timeout. Use startProductEnrichment + productEnrichmentJob.

Requires permission products:product:update.

DEPRECATED synchronous enrichment. Kept for backward compatibility; prefer the async startProductEnrichment / productEnrichmentJob pair. Needs the products update permission.

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

mutation EnrichProduct($productId: ID!) {
  enrichProduct(productId: $productId) {
    balanceDisplay
    balanceDollars
    costDisplay
    creditsUsed
    description
    notes
    attributes {
      name
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation EnrichProduct($productId: ID!) {\n  enrichProduct(productId: $productId) {\n    balanceDisplay\n    balanceDollars\n    costDisplay\n    creditsUsed\n    description\n    notes\n    attributes {\n      name\n      value\n    }\n  }\n}",
  "variables": {
    "productId": "id"
  }
}
EOF

Variables:

{
  "productId": "id"
}

Response:

{
  "data": {
    "enrichProduct": {
      "balanceDisplay": "string",
      "balanceDollars": "string",
      "costDisplay": "string",
      "creditsUsed": 0,
      "description": "string",
      "notes": "string",
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  }
}

enrichProduct(
  productId: ID!
): ProductEnrichmentSuggestion! @deprecated

Arguments

enrichProduct.productId ● ID! non-null scalar

The ID of the product.

Type

ProductEnrichmentSuggestion object

AI-generated suggestions for a product. Suggestion-only: nothing is written to the catalog until the user approves and saves through the normal product update path.