Submit Proposals

POST /api/enrichment/products/submissions · Scope: catalog:submit

Submit a batch of enrichment proposals. Each item becomes a pending revision for reviewer acceptance. See the guide.

Request body

string

Your own correlation/idempotency handle for the batch. Optional but recommended.

object[]

required

1–1000 submission items.

Show item

string

required

Identity key matching the proposal to a product.

integer

Certainty 0–100. Drives reviewer triage. Optional.

string

Free-text note to the reviewer (reasoning, sources, caveats). Trimmed; truncated at 5000 characters. Optional, not enrichable.

string

Suggested brand name, shown to the reviewer only — never applied to the product. Trimmed; truncated at 255 characters. Optional, not enrichable.

string

Proposed name. Enrichable.

string

Proposed slug. Enrichable.

string

Proposed description, as HTML or Markdown (Markdown is converted to HTML before review). Enrichable.

string[]

Proposed GTINs (EAN/UPC), one per packaging level in order. A lone string is accepted; alias gtins. Trimmed, blanks dropped, de-duplicated. On approval, replaces all of the product’s GTINs. Enrichable.

string[]

Proposed Manufacturer Part Numbers. A lone string is accepted; alias mpns. Trimmed, blanks dropped, de-duplicated. On approval, replaces all of the product’s MPNs. Enrichable.

object[]

Proposed attributes (attribute, detail, templateOption). Each attribute is approved or rejected on its own; approved ones are merged into the product’s existing attributes by name. Enrichable.

string[]

Proposed document references. Enrichable.

object

Proposed ETIM classification as a free-form JSON object, stored verbatim. On approval it replaces the product’s ETIM data wholesale. An empty object is treated as absent. Enrichable.

{
  "externalSubmissionId": "batch-2026-06-22-001",
  "items": [
    {
      "sku": "ABC-123",
      "confidence": 92,
      "comment": "Voltage and torque taken from the manufacturer datasheet (rev. 2025-11).",
      "brand": "Acme Tools",
      "name": "Acme 18V Cordless Impact Driver",
      "description": "A compact 18V brushless impact driver...",
      "gtin": ["5012345678900", "5012345678917"],
      "mpn": ["AC-ID18-BL"],
      "attributes": [
        { "attribute": "Voltage", "detail": "18", "templateOption": { "optionId": 880, "unit": "V", "priority": 1, "dataType": "NUMBER", "showOnWebsite": true } }
      ],
      "etimClass": {
        "version": "9.0",
        "classCode": "EC000123",
        "features": [{ "code": "EF000007", "value": "18" }]
      }
    }
  ]
}

Response `200`

One result per item, in submission order.

string

Echo of the item’s identity, for correlation.

number | null

Matched product id, or null when unmatched.

number | null

Created revision id when status is CREATED.

string

One of:

CREATED — pending revision created.
UNMATCHED — no product matched the identity (or ambiguous).
REJECTED_FIELDS — no whitelisted, non-empty enrichable fields to propose (comment and brand alone don’t count).

string[]

Reserved; currently always empty. Unknown keys in an item are silently dropped, not reported here.

[
  { "sku": "ABC-123", "productId": 90210, "revisionId": 55123, "status": "CREATED", "ignoredFields": [] },
  { "sku": "NOPE-1",  "productId": null,  "revisionId": null,  "status": "UNMATCHED", "ignoredFields": [] }
]

Errors

Status	When
`400`	`items` empty or missing (“Submission must contain at least one item”)
`400`	More than 1000 items (“Submission exceeds the maximum of 1000 items”)
`401`	Missing or invalid API key
`403`	Key lacks `catalog:submit`

Overview

Catalog

Submissions

Request body

Response `200`

Errors

​Request body

​Response 200

​Errors

Request body

Response `200`

Errors