Storefront rendering

Render a product Rich Snippet

Returns visible product-rating HTML and matching Product JSON-LD.

GEThttps://api.widget.cevoid.com/v1/products/{productRef}/rich-snippet

Request

curl 'https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet?language=sv-SE' \
  -H "Authorization: Bearer ${CEVOID_PUBLISHABLE_KEY}"

fetch("https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet?language=sv-SE", {
  headers: {
    Authorization: "Bearer YOUR_PUBLISHABLE_KEY",
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet?language=sv-SE", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_PUBLISHABLE_KEY}`,
  },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet",
    params={
        "language": "sv-SE",
    },
    headers={
        "Authorization": f"Bearer {os.environ['CEVOID_PUBLISHABLE_KEY']}",
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet?language=sv-SE',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('CEVOID_PUBLISHABLE_KEY'),
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet?language=sv-SE", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + os.Getenv("CEVOID_PUBLISHABLE_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://api.widget.cevoid.com/v1/products/prd_linen_shirt/rich-snippet?language=sv-SE")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CEVOID_PUBLISHABLE_KEY")}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

{
  "html": "<div class=\"cevoid-rating\">Rated 4.8 out of 5 from 24 reviews</div>",
  "jsonLd": {
    "@context": "https://schema.org",
    "@type": "Product",
    "@id": "https://shop.example.com/products/linen-shirt#cevoid-product",
    "url": "https://shop.example.com/products/linen-shirt",
    "name": "Linen Shirt",
    "image": "https://cdn.cevoid.com/products/linen-shirt.jpg",
    "brand": {
      "@type": "Brand",
      "name": "Example Apparel"
    },
    "sku": "LINEN-SHIRT-NATURAL-M",
    "gtin": "07350012345678",
    "mpn": "LS-NAT-M",
    "aggregateRating": {
      "@type": "AggregateRating",
      "ratingValue": 4.8,
      "ratingCount": 24,
      "bestRating": 5,
      "worstRating": 1
    }
  },
  "projectionVersion": 1,
  "computedAt": "2026-08-01T10:05:00.000Z"
}

{
  "additional_data": {
    "property1": null,
    "property2": null
  },
  "status": 400,
  "code": "bad_request",
  "message": "Bad request",
  "request_id": "req_abc123"
}

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "property1": null,
    "property2": null
  },
  "status": 404,
  "code": "not_found",
  "message": "Resource not found",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "property1": null,
    "property2": null
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded",
  "request_id": "req_abc123",
  "additional_data": {
    "retry_after_seconds": 1
  }
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

{
  "status": 503,
  "code": "service_unavailable",
  "message": "Service unavailable",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your publishable key.

Path parameters

productRefstringrequired

Stable Cevoid product or variant id, external product reference, URL slug, or auto with a referer.

Length: 1 to 256
Example: prd_linen_shirt

Query parameters

marketstring

Workspace market short id. When omitted, Cevoid infers the market from the referer URL.

Length: 1 to 128
Example: mar_sweden

languagestringrequired

Language used for market-specific product presentation, such as sv or en-US.

Length: 1 to 64
Example: sv-SE

refererstring<uri>

Product page URL used for auto product resolution and optional market inference.

Maximum length: 2048
Example: https://shop.example.com/products/linen-shirt

Headers

refererstring<uri>

Product page URL used when the referer query parameter is omitted.

Maximum length: 2048
Example: https://shop.example.com/products/linen-shirt

Response

200 Successful response application/json

htmlstringrequired

Visible aggregate-rating HTML rendered from the same projection snapshot as jsonLd.

Minimum length: 1
Example: <div class="cevoid-rating">Rated 4.8 out of 5 from 24 reviews</div>

jsonLdobjectrequired

Properties (11)

@contextenum<string>required

Schema.org vocabulary URL.

Allowed value: https://schema.org
Example: https://schema.org

@typeenum<string>required

Schema.org entity type.

Allowed value: Product
Example: Product

@idstring<uri>required

Canonical product entity identifier.

Example: https://shop.example.com/products/linen-shirt#cevoid-product

urlstring<uri>required

Canonical product page URL.

Example: https://shop.example.com/products/linen-shirt

namestringrequired

Market-specific product title.

Example: Linen Shirt

imagestring<uri>

Market-specific primary product image URL.

Example: https://cdn.cevoid.com/products/linen-shirt.jpg

brandobject

Product brand when available.

Properties (2)

@typeenum<string>required

Allowed value: Brand
Example: Brand

namestringrequired

Example: Example Apparel

skustring

Product SKU when available.

Example: LINEN-SHIRT-NATURAL-M

gtinstring

Global Trade Item Number when available.

Example: 07350012345678

mpnstring

Manufacturer Part Number when available.

Example: LS-NAT-M

aggregateRatingobjectrequired

Properties (5)

@typeenum<string>required

Allowed value: AggregateRating
Example: AggregateRating

ratingValuenumberrequired

Published average rating.

Range: 0 < x
Example: 4.8

ratingCountintegerrequired

Published rating count.

Range: 0 < x
Example: 24

bestRatingenum<number>required

Highest possible rating.

Allowed value: 5
Example: 5

worstRatingenum<number>required

Lowest possible rating.

Allowed value: 1
Example: 1

projectionVersionenum<number>required

Version of the authoritative review projection used for both response representations.

Allowed value: 1
Example: 1

computedAtstring<date-time>required

ISO 8601 timestamp when the authoritative review projection was computed.

Example: 2026-08-01T10:05:00.000Z

Response headers (7)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Cache-Controlstring

Browser freshness is 60 seconds. Shared caches are fresh for five minutes and may serve stale content while revalidating for another five minutes. TTL is the only invalidation guarantee; moderation or removal may take up to ten minutes because no active purge is performed.

Varystring

Workspace credentials and both accepted referer header spellings are included because product and Market context may be inferred from the page URL.

400 Bad request application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

404 Not found application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobjectrequired

Machine-readable rate-limit details.

Properties (2)

retry_after_secondsintegerrequired

Range: 0 <= x

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (6)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

503 Service unavailable application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any | null

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available