Skip to main content
GET
Get product highlights
Retrieve concise, pre-generated selling points for a product detail page. Highlight content is scoped to the catalogue selected by the Tenantid header. This endpoint does not require a Core Intent operation token.

Request example

Use the exact product identifier from your preezie catalogue. URL-encode the identifier when it contains characters that are not safe in a URL path.

Response

The endpoint returns a JSON object containing the generated highlights and their most recent generation time:

Content not available

A successful request returns 200 OK even when highlight content has not been generated for the product:
Treat an empty array as content unavailable and render your product page without the highlights section. It is not necessary to show an error to the shopper.
Highlights are generated ahead of time. This endpoint retrieves stored content and does not start content generation.
To generate this content for a catalogue, see Configure FAQ and Highlights jobs.

Authorizations

Tenantid
string
header
required

The preezie tenant identifier. This value identifies the catalogue and is not a secret.

Path Parameters

productId
string
required

The product identifier used in the tenant's catalogue.

Response

The generated highlights for the product.

highlights
string[]
required

Generated product selling points. The array is empty when content is unavailable.

highlightsGeneratedAt
string<date-time> | null

UTC timestamp for the most recent highlights generation, or null when content has not been generated.