Parameters
Query parameters of GET /v1/fragment, shared by both widgets.
| Parameter | Values | Default | Notes |
|---|---|---|---|
ean | 8–14 digits | (required) | EAN-8, EAN-13, EAN-14 or UPC-A |
variant | compact · reviews | compact | Send reviews for the carousel. Any other value prints the compact rating |
schema | full · rating-only · none | full | See the decision |
name | text, ≤200 chars | Shopadvizor catalogue name | Optional with schema=full, and preferred — yours wins over the catalogue's |
productId | text, ≤2,048 chars | — | Needed for a rich result with schema=rating-only. The service does not reject a call without it, but the rating it emits is then attached to nothing (why). A longer value is dropped rather than truncated: a cut @id would silently stop matching your page's node |
lang | fr · es | fr | Widget copy and accessibility labels only. The data is always the French catalogue: Spain has its own service |
star | gold · blue · orange · white · black | gold (ratings widget) · orange (carousel) | Star colour, from a closed palette |
accent | rrggbb or rgb (hex, without #) | design default | Focus ring. In the carousel, also the review title, date and author, the arrows and the active dot: it sets both --sa-accent and --sa-primary |
Unknown values never break the fragment: they fall back to the default. Unknown variant and star
values are also logged.
# in accentIn a URL, # starts the fragment and everything after it never reaches the server:
accent=#e31c39 arrives empty. Send accent=e31c39, or encode the sign as %23e31c39.
breakdownbreakdown is a compact-rating flag for the per-star breakdown. It is a Phase-2 preview, outside the
current scope — do not enable it. It does nothing in the carousel.
Star colours
star takes one of these values, in both widgets:
| Value | Colour | Notes |
|---|---|---|
star=gold | #f5b301 | Default |
star=blue | #003481 | Brand blue, same as the carousel arrows |
star=orange | #fd9e02 | Same as the carousel default |
star=white | #ffffff | Dark backgrounds only — see below |
star=black | #000000 |
Without star, the ratings widget uses gold and the reviews carousel its own orange (#fd9e02).
GET https://saz-ssr-server.public.shopadvizor.com/v1/fragment?ean=3175681302679&lang=fr&star=blue
Authorization: Basic <your credential>
white needs a dark backgroundThe widgets' own surfaces are white: the ratings widget's background and the carousel's cards. On
them, white stars are invisible — and in the carousel the empty stars are only an outline in the
same colour. Use star=white only if your page is dark and you also darken the surfaces from
your stylesheet (--sa-surface, see the styling links below).
Brand colours beyond the palette
The star parameter offers a curated list. If you need a colour outside it, override the CSS custom
properties from your own stylesheet on the shopadvizor-rating element. Each widget exposes its
own set and its own defaults:
The widgets inherit your page's font automatically. They load no webfont of their own.