Quickstart

This walkthrough takes you through one full turn of the pipeline. You’ll need an API key with both catalog:read and catalog:submit scopes.

Set your key

export VERZLA_ENRICHMENT_KEY="sk_live_your_key_here"
export VERZLA_BASE="https://api.verzla.com/api/enrichment"

Fetch the attribute templates

Learn the schema you’re enriching against.

curl "$VERZLA_BASE/attribute-templates" \
  -H "X-Api-Client-Key: $VERZLA_ENRICHMENT_KEY"

Note the id, attribute, unit, and dataType of each option — your proposals should line up with these.

Fetch a page of products

Pull the first 25 active products to enrich.

curl "$VERZLA_BASE/products?page=0&pageSize=25" \
  -H "X-Api-Client-Key: $VERZLA_ENRICHMENT_KEY"

Or target specific SKUs (up to 50):

curl "$VERZLA_BASE/products/skus" \
  -H "X-Api-Client-Key: $VERZLA_ENRICHMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "skus": ["ABC-123", "ABC-124"] }'

Generate and submit proposals

Run your model over the products, then submit — with a confidence score per item.

curl "$VERZLA_BASE/products/submissions" \
  -H "X-Api-Client-Key: $VERZLA_ENRICHMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalSubmissionId": "quickstart-001",
    "items": [
      {
        "sku": "ABC-123",
        "confidence": 88,
        "description": "An 18V brushless impact driver with 180 Nm of torque...",
        "attributes": [
          { "attribute": "Voltage", "detail": "18", "option": { "optionId": 880, "unit": "V", "priority": 1, "dataType": "NUMBER", "showOnWebsite": true } }
        ]
      }
    ]
  }'

A CREATED status with a revisionId means your proposal is queued for review.

Watch your acceptance rate

Once reviewers work through the queue, check how you’re doing.

curl "$VERZLA_BASE/acceptance-rate" \
  -H "X-Api-Client-Key: $VERZLA_ENRICHMENT_KEY"

See tracking your acceptance rate for the full breakdown.

Next steps

Attribute templates

Align your proposals to the merchant’s schema.

Submitting proposals

Confidence scoring, batching, and result handling in depth.

Getting Started

Authentication

The Enrichment Workflow

Next steps

Attribute templates

Submitting proposals

​Next steps

Attribute templates

Submitting proposals

Next steps