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

Produtos do selo

Lista os produtos que têm um selo e liga ou desliga produtos à mão.

A ligação manual diz exatamente em quais produtos o selo aparece. Serve para campanhas pontuais ("Dia das Mães") e para destacar produtos escolhidos. Quando o selo está em modo regra, a lista é mantida pela plataforma, e ligar à mão aqui ainda é possível, mas veja o aviso abaixo. O módulo product-stickers precisa estar ligado.

GET/api/v1/admin/stickers/{id}/productsAdmin

Lista os produtos com o selo

Devolve todos os produtos ligados ao selo (por regra ou à mão), sem paginação.

Parâmetros de caminho

iduuidobrigatório
Id do selo.
POST/api/v1/admin/stickers/{id}/productsAdmin

Liga um produto ao selo

Liga um produto. Repetir a chamada para um produto já ligado não dá erro e não duplica.

Parâmetros de caminho

iduuidobrigatório
Id do selo.

Corpo da requisição (JSON)

product_iduuidobrigatório
Id do produto.
DELETE/api/v1/admin/stickers/{id}/products/{product_id}Admin

Desliga um produto do selo

Remove a ligação. Desligar um produto que não estava ligado não dá erro.

Parâmetros de caminho

iduuidobrigatório
Id do selo.
product_iduuidobrigatório
Id do produto.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/stickers/$STICKER/products" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"product_id":"c3f92551-9dda-4fc7-b518-353d1c4e4035"}'

curl -X DELETE "$BASE_URL/api/v1/admin/stickers/$STICKER/products/c3f92551-9dda-4fc7-b518-353d1c4e4035" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Produtos com o selo
json
{
  "products": [
    {
      "id": "c3f92551-9dda-4fc7-b518-353d1c4e4035",
      "name": "Notebook Slim Rosa 02373",
      "slug": "notebook-slim-rosa-02373-2373",
      "sku": "SD-002373",
      "price": 249900,
      "image_url": "/uploads/exemplo/product/notebook.png",
      "attached_at": "2026-10-11T21:09:15Z"
    }
  ]
}
201Produto ligado
json
{ "message": "attached" }
200Produto desligado
json
{ "message": "detached" }

Campos de cada produto

iduuid
Id do produto.
namestring
Nome.
slugstring
Trecho de URL.
skustring
SKU. Vazio se não houver.
priceinteger
Preço de venda em centavos.
image_urlstring
Imagem principal. Ausente sem imagem.
attached_atstring
Quando foi ligado, RFC 3339.

Erros

StatusQuandoCorpo de exemplo
400product_id ausente{"error":"product_id is required"}
400product_id que não é um UUID{"error":"failed to attach product","detail":"o valor \"nope\" não é um uuid válido. ..."}
400Corpo que não é JSON{"error":"invalid request body","detail":"..."}
401Token ausente ou expirado{"error":"invalid or expired token"}
403Módulo desligado{"error":"module_disabled","module":"product-stickers"}
500id do selo que não é UUID{"error":"failed to list products","detail":"..."}

A mensagem de UUID inválido vem em português do servidor.

Ligar à mão num selo de regra

Se o selo está em modo rule e a regra também escolhe aquele produto, a avaliação marca o vínculo como da regra: quando a regra deixar de valer para o produto, ele perde o selo, mesmo que você o tenha ligado antes. Para um selo fixo, use o modo manual.

Selo desativado não aparece

Estar ligado não basta: o selo precisa estar com status A. E a vitrine só mostra um selo de seller nos produtos do próprio seller.

Veja também

  • Regras automáticas
  • Criar e gerenciar selos
  • Selos de produto
Anterior
Criar e gerenciar selos
Próxima
Regras automáticas de selo
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também