Skip to main content

EnrichmentJob

An async product-enrichment job. Returned immediately by startProductEnrichment; poll productEnrichmentJob(jobId) until status is COMPLETED (read suggestion) or FAILED (read error). Replaces the request-blocking enrichProduct path, which exceeded the client HTTP timeout.

type EnrichmentJob {
  error: String
  jobId: ID!
  status: EnrichmentJobStatus!
  suggestion: ProductEnrichmentSuggestion
}

Fields​

EnrichmentJob.error ● String scalar​

Failure reason. Present only when status is FAILED.

EnrichmentJob.jobId ● ID! non-null scalar​

The ID of the job.

EnrichmentJob.status ● EnrichmentJobStatus! non-null enum​

Where the job stands.

EnrichmentJob.suggestion ● ProductEnrichmentSuggestion object​

The enrichment result. Present only when status is COMPLETED.

Returned By​

productEnrichmentJob query ● startProductEnrichment mutation