Developers · REST API

Integrate product enrichment into your existing workflow

ENRIVAQ supports API-based product intake in configured deployments. The exact route, authentication, status and result contract is supplied for the integration being implemented.

This page shows the API integration shape. Exact endpoints, authentication, schemas, state names and limits are defined in the implementation-specific API reference.

THREE-CALL EXECUTION RAILIMPLEMENTATION-SPECIFIC CONTRACT
01 · SUBMITSend product recordAPI INPUT · PROJECT ROUTE

Identifiers + existing product data according to the implemented schema.

02 · STATUSRead processing stateDEPLOYMENT CONTRACT

Only if asynchronous or staged processing exists in production.

03 · RESULTRetrieve structured outputDEPLOYMENT CONTRACT

Stable fields and validation state exposed by the real result schema.

REFERENCE LIFECYCLENO UNIVERSAL ROUTE CLAIM
API use cases

Embed enrichment where product records already move programmatically

The API can sit inside a PIM, ERP-related workflow, internal catalog application or ecommerce data process once the real integration contract exists.

EMBEDDING TOPOLOGYVERIFIED USE CASES ONLY
HOST SYSTEMPIM workflowProgrammatic enrichment around incomplete records.
HOST SYSTEMERP-related processMove dry product records into a richer downstream state.
REST APITechnical boundaryOnly documented operations and schemas.
HOST SYSTEMInternal catalog appSubmit products from a controlled internal workflow.
HOST SYSTEMEcommerce pipelineReturn approved structured product information downstream.
Authentication

Document the implemented credential boundary, not a typical REST pattern

The public reference must state how credentials are issued, transported, protected and revoked only after those details are confirmed.

Authentication is defined by the implemented integration contract; no universal public scheme is claimed.

CREDENTIAL BOUNDARY LOCKCONFIGURED AUTHENTICATION
CLIENT SIDE

Credential handling

IssueCONFIGURED
TransportCONFIGURED
StorageCLIENT SECURITY POLICY
AUTH BOUNDARYDEPLOYMENT CONTRACT
API SIDE

Request acceptance

Credential typeCONFIGURED
RevocationCONFIGURED
Failure responseCONFIGURED
REQUEST ENVELOPE / SCHEMA GATEPROJECT SCHEMA
API INPUT · PROJECT ROUTECONCEPTUAL RECORD SHAPE
01{
02 "product_reference": "AC820825",
03 "identifiers": { ... },
04 "existing_data": { ... }
05}
SCHEMA GATE

Validate before submit

required fieldsDEPLOYMENT CONTRACT
field typesDEPLOYMENT CONTRACT
payload limitsIF APPLICABLE
Submit product

Send the product record into the enrichment workflow

The request body must match the implemented schema. Field names, types and required flags belong in the API reference, not in marketing copy.

Processing status

Processing state is exposed only as defined by the project contract

The lane below is conceptual workflow language, not a universal API enum. Exact asynchronous state names are supplied only when the integration exposes them.

STATE TRANSIT RAILCONCEPTUAL · NOT API ENUM
01
ReceivedConceptual workflow state
02
ProcessingConceptual workflow state
03
Result availableConceptual workflow state
04
Integration failureContract-specific handling
The state model shown here applies only to asynchronous implementations; synchronous deployments use their actual response contract.
Retrieve result

Return a stable structured result to the calling system

The result schema should expose only fields and validation information that the implementation actually returns.

RESULT CONTRACT DIFFSTABLE SCHEMA REQUIRED
INPUT RECORD
identityKNOWN
attributesPARTIAL
contentEXISTING
RESULT ENVELOPE
accepted product fieldsDEPLOYMENT CONTRACT
validation / exception stateDEPLOYMENT CONTRACT
source provenanceAVAILABLE IN PRODUCT WORKFLOW
content / SEO fieldsWHEN CONFIGURED
Sample request / response

Use a real product to describe the contract boundary

AC820825 can be used to demonstrate identity, accepted attributes and a held conflict, but exact JSON request/response examples are published only with the implemented API contract.

TWIN PAYLOAD CORRELATIONDEPLOYMENT CONTRACT REQUIRED FOR EXECUTABLE JSON
REQUESTAC820825 · CONCEPTUAL INPUT
01{ "product_reference": "AC820825" }
02// exact fields supplied in project API contract
REQUEST
↕
RESULT
RESPONSEACCEPTED FIELDS + REVIEW STATE
01{ "accepted_fields": "...", "weight": "REVIEW / HOLD" }
02// exact fields supplied in project API contract
Errors

Route real failures to clear client actions

Separate integration failures from product-data exceptions. Exact HTTP codes and machine-readable error names are part of the project API contract, not assumed on this public page.

FAILURE ROUTING BOARDCONFIGURED PER INTEGRATION
FAILURE CLASSMalformed requestReturned through the integration error contract.
FAILURE CLASSInvalid credentialReturned through the integration error contract.
FAILURE CLASSProcessing failureReturned through the integration error contract.
CLIENT ACTION
ROUTER
ACTIONFix requestFOLLOW DEPLOYMENT CONTRACT
ACTIONRe-authenticateFOLLOW DEPLOYMENT CONTRACT
ACTIONRetry / escalateFOLLOW DEPLOYMENT CONTRACT
CAPACITY BUDGETCONFIGURED
REQUEST RATERequests / intervalDEPLOYMENT CONTRACT
BATCH SIZERecords / submissionDEPLOYMENT CONTRACT
CONCURRENCYParallel workDEPLOYMENT CONTRACT
Rate limits

Capacity follows the deployment contract

Request, batch and concurrency limits are defined for the deployed integration and workload profile rather than exposed as one universal public limit.

Documentation

Keep the overview readable and the technical contract precise

This page explains the integration shape. Exact endpoints, schemas, authentication, examples and operational constraints belong in the dedicated API Documentation section.

REFERENCE SPLITOVERVIEW ≠ CONTRACT
REST API OVERVIEW

For solution architects

What the API enables
Where it fits in the workflow
What must be verified
SOURCE
OF
TRUTH
API DOCUMENTATION

For implementers

Exact endpoint contract
Request / response schemas
Auth, errors, limits, examples
Integration handoff

Map the API to the product-data flow you already have

Bring the submitting system, the fields available today and the structured result required downstream. The implementation contract is then defined around that data flow.

INTEGRATION CONTRACT BUILDERWORKFLOW → DEPLOYMENT CONTRACT
INPUT 01Submitting system
INPUT 02Available product fields
INPUT 03Required downstream result
CONTRACTDefine the API fitCONFIGURED

Outputs of the discussion

Verified request schema
Verified processing model
Verified result schema
Verified operational constraints

Talk to ENRIVAQ

Request a catalog assessment

Tell us enough to make the next step useful for your catalog.