Product information API

Product information API for catalog records

Request structured product details for catalog enrichment, product onboarding, content checks, and monitoring workflows.

Product page URL https://shop.example/p/123
Product information POST /v1/product-information

Use product information when catalog, enrichment, onboarding, or content-quality workflows need structured details.

Request body
{
  "productUrl": "https://shop.example/p/123"
}
Response preview
{
  "productInformation": {
    "title": "Replacement water filter cartridge",
    "brand": "AquaPro",
    "images": [
      "https://cdn.example/products/water-filter-123/main.jpg"
    ],
    "attributes": {
      "capacity": "1 liter",
      "packSize": "2"
    },
    "ratings": {
      "average": 4.6,
      "reviewCount": 1284
    }
  },
  "creditsRemaining": 2480
}
titlebrandimagesattributesratings

Request shape and public routes.

Single requests send productUrl. Bulk requests send items[].productUrl. Bearer auth is required for product and usage routes.

Use case Endpoint Request body Returns
Get product information POST /v1/product-information { "productUrl": "https://shop.example/p/123" } Returns title, brand, images, attributes, ratings, category data, and other product details for one product page URL.
Bulk product information POST /v1/product-information/bulk { "items": [{ "productUrl": "https://shop.example/p/123" }] } Collects product information for many product page URLs with per-item results.
Usage and credits GET /v1/usage No request body Returns credit balance, rate class, limits, plan data, and recent usage rows for the authenticated token.

Readable JSON before code snippets.

Use this page’s example to confirm the body shape, expected response fields, and endpoint mapping before copying language-specific code from the OpenAPI reference.

Request body
{
  "productUrl": "https://shop.example/p/123"
}
Response preview
{
  "productInformation": {
    "title": "Replacement water filter cartridge",
    "brand": "AquaPro",
    "images": [
      "https://cdn.example/products/water-filter-123/main.jpg"
    ],
    "attributes": {
      "capacity": "1 liter",
      "packSize": "2"
    },
    "ratings": {
      "average": 4.6,
      "reviewCount": 1284
    }
  },
  "creditsRemaining": 2480
}

Fields this workflow usually reads.

Exact fields depend on endpoint, product page URL, and enabled coverage, but these are the fields this page is designed around.

productInformationtitlebrandimagesattributescategoryPathratings

Where this page fits.

Each page targets a distinct workflow, field set, or buying question.

Catalog enrichment

Fill missing product details from supported product page URLs.

Attribute extraction

Capture structured attributes and feature text for data-quality review.

Product setup

Seed internal product records before human review or approval.

Content checks

Compare title, brand, image, and rating fields against internal catalog data.

Coverage and operating boundaries.

Coverage is enabled by supported retailer, marketplace, and product page URL.

Polling cadence belongs to the client integration and is discussed during onboarding.

The API is not an official marketplace partner API and does not promise unlimited collection.

Short answers for evaluation.

Visible answers are mirrored in structured data for eligible generated pages.

Do callers provide marketplace IDs or supplier IDs?

No. Callers send productUrl for single requests or items[].productUrl for bulk requests. Internal identifiers are derived by the API when the URL is supported.

Which endpoint should I use first?

Use product-stock for availability and offers, and product-information for catalog details.

Can I use bulk requests?

Yes. Dedicated stock and information bulk endpoints accept arrays of product page URLs and return per-item results.

How is coverage confirmed?

Share target retailers or marketplaces, expected volume, required fields, and sample product URLs during onboarding.