Get Products

GET /api/enrichment/products · Scope: catalog:read

Paginated export of active products, sorted by ascending id. See the guide.

Query parameters

integer

default:"0"

Zero-based page index.

integer

default:"100"

Items per page, clamped to 1–500.

string

Optional incremental filter. Epoch millis, ISO-8601 instant (2026-06-01T00:00:00Z), or local date-time (2026-06-01T00:00:00). Returns only products updated after this moment.

Request

curl "https://api.verzla.com/api/enrichment/products?page=0&pageSize=250&modifiedSince=2026-06-01T00:00:00Z" \
  -H "X-Api-Client-Key: sk_live_your_key_here"

Response `200`

object[]

Products on this page (see shape below).

number

Current zero-based page index.

number

Page size actually used (post-clamp).

number

Total matching products across all pages.

number

Total number of pages.

Product shape (`items[]`)

number

Internal product id. Identity — read-only.

string

Stock keeping unit. Identity — read-only.

string

External/ERP id. Identity — read-only.

string

Global trade item number. Read-only.

string

Product name. Enrichable.

string

URL slug. Enrichable.

string

Long-form description. Enrichable.

number

Template this product is bound to.

object[]

Current attributes. Enrichable. Attributes with an empty value are omitted.

Show attribute

string

Attribute name.

string

Attribute value.

object | null

Link to a template option, or null for free-form. Fields: optionId, unit, priority, dataType, showOnWebsite.

object

Read-only context: { id, name, website, slug }.

string[]

Read-only category names.

string[]

Read-only image URLs.

string[]

Document references. Enrichable.

string[] | null

Read-only. On a master product, the attribute names that differentiate its variants. null on variants and standalone products.

object[] | null

Read-only. On a master product, its sibling variants (the master itself is not included). null on variants and standalone products.

Show variant

number

Internal product id of the variant.

string

Variant SKU.

string

Variant name.

object[]

The variant’s attributes, same shape as the product attributes above. Empty-valued attributes are omitted.

string | null

Read-only. On a variant product, the SKU of its family’s master product. null on the master and on standalone products.

{
  "items": [
    {
      "id": 90210,
      "sku": "ABC-123",
      "externalId": "erp-55021",
      "gtin": "5012345678900",
      "name": "Cordless Impact Driver",
      "slug": "cordless-impact-driver",
      "description": "An 18V brushless impact driver...",
      "attributeTemplateId": 41,
      "attributes": [
        { "attribute": "Voltage", "detail": "18", "option": { "optionId": 880, "unit": "V", "priority": 1, "dataType": "NUMBER", "showOnWebsite": true } }
      ],
      "brand": { "id": 12, "name": "Acme Tools", "website": "https://acme.example", "slug": "acme-tools" },
      "categories": ["Power Tools", "Drivers"],
      "images": ["https://cdn.verzla.com/p/abc-123/1.jpg"],
      "files": ["https://cdn.verzla.com/p/abc-123/manual.pdf"],
      "variantAttributes": ["Voltage"],
      "variants": [
        { "id": 90211, "sku": "ABC-124", "name": "Cordless Impact Driver 12V", "attributes": [ { "attribute": "Voltage", "detail": "12", "option": null } ] }
      ],
      "variantMaster": null
    }
  ],
  "page": 0,
  "pageSize": 250,
  "totalElements": 4820,
  "totalPages": 20
}

Errors

Status	When
`400`	Invalid `modifiedSince` value (not epoch millis or ISO-8601)
`401`	Missing or invalid API key
`403`	Key lacks `catalog:read`

Overview

Catalog

Submissions

Query parameters

Request

Response `200`

Product shape (`items[]`)

Errors

​Query parameters

​Request

​Response 200

​Product shape (items[])

​Errors

Query parameters

Request

Response `200`

Product shape (`items[]`)

Errors