VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Página de produto

Selos do produto

Lista os selos visuais ativos de um produto (por exemplo "Mais vendido" ou "Frete grátis") com as regras de aparência e onde exibir.

Um selo (sticker) é uma etiqueta visual sobre o produto: "Mais vendido", "Últimas unidades", "Frete grátis". O lojista cria os selos no painel e os liga a produtos manualmente ou por regra automática (mais vendidos, estoque baixo, menor preço em 90 dias, frete grátis). Esta rota devolve os selos ativos de um produto, na ordem em que devem aparecer.

A rota depende do módulo de selos de produto ativo na loja; sem ele, responde 403 module_disabled. Selos de um vendedor só aparecem em produtos desse mesmo vendedor; selos da loja aparecem em qualquer produto.

GET/api/v1/storefront/products/{id}/stickersPública

Selos ativos de um produto

Parâmetros de caminho

iduuidobrigatório
Id do produto.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/storefront/products/34a3bed9-c40d-4519-801f-5cae027eac2a/stickers"

Resposta

200Selos retornados (exemplo ilustrativo do formato)
json
{
  "stickers": [
    {
      "id": "c3a1f7f2-0a4e-4a33-9c36-7a6c3f0b1e22",
      "name_admin": "Mais vendido (regra)",
      "name_desktop": "Mais vendido",
      "name_mobile": "Top",
      "style": "ribbon",
      "appearance": { "background": "#E11D48", "color": "#FFFFFF" },
      "display_on": { "product_card": true, "pdp": true, "quickview": false },
      "status": "A",
      "position": 0,
      "created_at": "2026-09-10T12:00:00Z",
      "updated_at": "2026-09-10T12:00:00Z"
    }
  ]
}
200Produto sem selos (resposta real da loja de testes)
json
{ "stickers": [] }

Campos da resposta

stickersarray
Selos ativos do produto, por posição. Lista vazia se não há.
stickers[].iduuid
Id do selo.
stickers[].name_desktopstring
Texto do selo em telas grandes.
stickers[].name_mobilestring
Texto do selo em telas pequenas.
stickers[].name_adminstring
Nome interno dado pelo lojista. Não exiba ao comprador.
stickers[].stylestring
Estilo base do selo definido pelo lojista (por exemplo faixa ou etiqueta).
stickers[].appearanceobject
Aparência (cores e afins). As chaves são definidas pelo lojista e pelo tema; ignore as que você não usa.
stickers[].display_onobject
Onde o selo aparece: product_card (cartão da lista), pdp (página do produto), quickview (visão rápida). Respeite estes sinalizadores.
stickers[].statusstring
Sempre A aqui.
stickers[].positioninteger
Ordem do selo.

Erros

StatusQuandoExemplo de corpo
403Módulo de selos não ativo na loja{"error":"module_disabled","module":"product-stickers"}
500Falha ao consultar{"error":"failed to load stickers","detail":"..."}
Um selo por tela

Respeite display_on: o mesmo selo pode estar ligado para a página do produto e desligado para o cartão. Em listas grandes, evite chamar esta rota para cada cartão; busque só na página do produto.

Selos por regra mudam sozinhos

Selos automáticos são reavaliados pela loja de tempos em tempos. Um produto pode ganhar ou perder o selo "Últimas unidades" sem nenhuma edição manual; não guarde a resposta por muito tempo.

Veja também

  • Características
  • Consultar produto
Anterior
Vídeos e replays
Próxima
Produtos obrigatórios
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também