Parameters
Query parameters of GET /v1/fragment.
| Parameter | Values | Default | Notes |
|---|---|---|---|
ean | 8–14 digits | (required) | EAN-8, EAN-13, EAN-14 or UPC-A |
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 | es | Widget copy and accessibility labels only. The data is always the Spanish catalogue |
star | gold · blue · orange · white · black | gold | Star colour, from a closed palette |
accent | rrggbb or rgb (hex, without #) | design default | Focus ring |
Unknown values never break the fragment: they fall back to the default. Unknown 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.
Star colours
star takes one of these values:
| Value | Colour | Notes |
|---|---|---|
star=gold | #f5b301 | Default |
star=blue | #003481 | Brand blue |
star=orange | #fd9e02 | |
star=white | #ffffff | Dark backgrounds only — see below |
star=black | #000000 |
Without star, the ratings widget uses gold.
GET https://saz-es.public.shopadvizor.com/saz-ssr-server/v1/fragment?ean=4001724038818&lang=es&star=blue
Authorization: Basic <your credential>
white needs a dark backgroundThe widget's own background is white. On it, white stars are invisible. Use star=white only if your page is dark and you also darken the surfaces from
your stylesheet (--sa-surface, see the styling link 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: see
Ratings widget styling.
The widget inherits your page's font automatically. It loads no webfont of its own.