Skip to main content
POST
Queue Product Enrichment

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
productIds
string[]
required

Existing Omni product IDs. Trimmed and deduplicated in requested order; at most 1,000 entries.

Required array length: 1 - 1000 elements
Required string length: 1 - 255
organizationId
string

Required for session auth; derived from the credential for bearer auth.

Required string length: 1 - 255
selectedFields
enum<string>[]

Fields to enrich. Omit for all content fields. Weight and dimensions are always included by the enrichment service. Exclude name to preserve the product title.

Required array length: 1 - 7 elements
Available options:
name,
description,
highlights,
seoTitle,
seoDescription,
weight,
dimensions
instructions
string
Maximum string length: 2000
title
string
Maximum string length: 120
autoApplyHighConfidence
boolean
default:false
enrichmentAutoApplyThreshold
number

Confidence threshold for automatic application when enabled. Omit to use the organization's threshold.

Required range: 0.62 <= x <= 1

Response

Jobs accepted for background processing.

ok
boolean
required
status
enum<string>
required
Available options:
accepted
jobId
string
required
data
object
required
apiVersion
string
operationId
string
warnings
string[]
recommendations
string[]