Product Data Enrichment API Reference
ENRIVAQ supports API-based product intake in configured deployments. This page defines the public integration boundary; the exact technical contract is supplied for the project being implemented.
Endpoint paths, authentication, request/response schemas, status names, limits and optional event delivery are not invented here. They are documented when a concrete integration is configured.
Submit + read
AUTHDEPLOYMENT CONTRACTSUBMITAPI INPUT SUPPORTEDSTATUSDEPLOYMENT CONTRACTImplemented API contract
↔VERIFIED ONLY↔VERIFIED ONLY↔VERIFIED ONLY↔VERIFIED ONLYTruth before convenience
EXAMPLESVALID ONLYEVENT DELIVERYWHEN CONFIGUREDCLIENTSSTANDARD HTTP / PROJECT TOOLSCredentials, transport and revocation
Authentication is defined by the implemented integration contract: credential issuance, transport, rotation and revocation are documented for that deployment.
Credentials are never shown in examples, logged, or included in error responses.
Authentication: PROVIDED IN DEPLOYMENT CONTRACTContent-Type: application/jsonOrganized around the product-data workflow
API-based intake is supported, but there is no single universal public route set claimed across deployments. The project reference lists only the routes implemented for that integration.
AUTHCredential useExact transport mechanism.SUBMITStart enrichmentEndpoint path supplied in the implemented project contract.STATUSRead processing stateState / response behavior supplied in the implemented project contract.RESULTRetrieve outputStructured product result.OPTIONALBatch / webhookOnly when the project implementation includes it.product_referencestringPROJECT-DEFINEDmanufacturerstringAVAILABLE CONTEXTmpn / oemstringIDENTITY CONTEXTcategorystringAVAILABLE CONTEXTknown_attributesobjectEXISTING PRODUCT FACTS{ "product_reference": "AC820825", "manufacturer": "Kverneland", "mpn": "AC820825", "known_attributes": { ... }}Identifying a product and supplying context
A project contract defines required identification and optional context. Typical inputs include product reference, manufacturer/brand, MPN/OEM, category and known attributes.
EXACT FIELD NAMES, TYPES AND CONSTRAINTS ARE SUPPLIED WITH THE IMPLEMENTED DEPLOYMENT CONTRACT.
Starting enrichment and what comes back immediately
API intake sends product data into the configured enrichment workflow. Whether the deployment responds synchronously, returns a processing reference or uses another contract is documented per implementation.
Do not publish an invented API enum
If an implementation exposes asynchronous processing state, its exact names and transitions are part of that project contract. The public site does not invent a universal enum.
DEPLOYMENT CONTRACT DEFINES ANY EXPOSED PROCESSING STATES
receivedConcept: input accepted by the integration.processingConcept: enrichment workflow is running.exception / holdConcept: a record contains unresolved evidence or integration error.result_availableConcept: the configured result can be handed downstream.integration_failureConcept: transport or processing failed according to the project contract.{ "integration_reference": "PROJECT_DEFINED_IF_EXPOSED", "status": "PROJECT_DEFINED", "product": { "accepted_fields": "..." }, "validation": { "state": "PROJECT_DEFINED" }}What a completed product returns
The result distinguishes the original input from the enriched fields, and carries the validation state separately. Value/source provenance is a product capability; the exact fields exposed by an external API are defined by the project contract.
Error behavior belongs to the implemented API contract
The public site distinguishes request/access failures, processing failures and product-data exceptions. Exact HTTP status codes, machine-readable error names and retry behavior are specified by the project API contract.
CONTRACT_FAILUREInput does not match the implemented schema.Correct the request using the project reference.AUTHENTICATION_FAILURECredential or permission handling failed.Follow the implemented access contract.PRODUCT_EXCEPTIONIdentity, evidence or validation prevented a field from continuing.Review the product-data reason.WORKFLOW_FAILUREThe configured processing path did not complete.Use the project error details to retry or escalate.DEPLOYMENT_CONSTRAINTAny request/concurrency limit is deployment-specific.Use the values from the project contract.PROJECT_BEHAVIORRetry/backoff semantics are not claimed universally.Follow the implemented integration guide.Documented only where supported
ENRIVAQ processes catalog work in jobs/batches internally, but an external API batch or list contract is not claimed universally. Pagination, batch submission and partial-failure behavior are documented only when the project exposes them.
Pagination contract
DEPLOYMENT CONTRACTDEPLOYMENT CONTRACTDEPLOYMENT CONTRACTSubmission envelope
DEPLOYMENT CONTRACTDEPLOYMENT CONTRACTDEPLOYMENT CONTRACTRecord-level result
DEPLOYMENT CONTRACTDEPLOYMENT CONTRACTDEPLOYMENT CONTRACTDeployment constraints are supplied with the integration contract
Routing does not rely on a universal public request-size, batch-size, rate-limit or concurrency guarantee on this page. Any enforced constraint is supplied for the implemented deployment.
DEPLOYMENT CONTRACTDEPLOYMENT CONTRACTDEPLOYMENT CONTRACTDEPLOYMENT CONTRACTEvent delivery follows the integration contract
Where event-driven delivery is used, lifecycle events, authentication and delivery behavior are configured for the integration rather than exposed as a one-size-fits-all public contract.
CONFIGURED PER INTEGRATION
Show the integration shape without inventing routes
The public example uses AC820825 to show input context and enrichment output. Exact HTTP routes and payloads belong to the project API reference.
API INPUT · PROJECT ROUTEDEPLOYMENT CONTRACTREVIEW / HOLDDEPLOYMENT CONTRACTStandard HTTP clients, unless an SDK is real
API integrations use the implemented HTTP contract and standard client tooling. No universal ENRIVAQ SDK is claimed.
HTTPcurl / standard clientUniversal fallback when documented.PYTHONRequests / clientExample only, not an official SDK claim.JSfetch / clientStandard HTTP integration.PROJECTOptional project toolingDocumented only when supplied.