VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Selos, kits, mixes e caixas

Selos

Lista, cria, consulta, altera e exclui os selos do seller (etiquetas sobre os produtos).

Um selo é uma etiqueta que aparece sobre a foto do produto ("Novo", "-20%", "Frete grátis"). Aqui você cria o selo e define a aparência; para ele aparecer, ainda é preciso colocá-lo nos produtos.

Listar

GET/api/v1/vendor/stickersSeller

Listar os selos

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Exemplo de requisição (listar)

bash
curl "$BASE_URL/api/v1/vendor/stickers" \
  -H "Authorization: Bearer $TOKEN"

Resposta (listar)

200Selos
json
{
  "stickers": [
    {
      "id": "e4c03c56-f826-4fc0-a29b-896793caef22",
      "name_admin": "Promoção de outubro",
      "name_desktop": "PROMOÇÃO",
      "name_mobile": "PROMO",
      "style": "T",
      "appearance": {
        "bg_color": "#ef4444",
        "text_color": "#ffffff",
        "font_size": 12,
        "padding": 6,
        "radius": 4,
        "position": "tl",
        "opacity": 1,
        "image_url": ""
      },
      "display_on": {
        "product_card": true,
        "pdp": true,
        "quickview": true
      },
      "status": "A",
      "position": 0,
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "created_at": "2026-10-11T20:00:00Z",
      "updated_at": "2026-10-11T20:00:00Z",
      "assignment_mode": "manual"
    }
  ],
  "total": 1
}

Campos da resposta

stickersarray

Seus selos, por posição.

idstring (uuid)
Id do selo.
name_adminstring
Nome interno, só para você.
name_desktopstring
Texto no computador.
name_mobilestring
Texto no celular (pode ficar vazio).
stylestring
TIP
T texto, I imagem, P pictograma (hoje exibido como texto).
appearanceobject
Aparência: bg_color, text_color, font_size, padding, radius, position (tl, tr, bl, br), opacity, image_url.
display_onobject
Onde aparece: product_card, pdp, quickview (booleanos).
statusstring
AD
A ativo, D desativado.
positioninteger
Ordem entre os selos.
vendor_idstring (uuid)
Seu seller.
assignment_modestring
Sempre manual para selos do seller.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).
totalinteger
Quantidade.

Erros (listar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings"]}

Criar

POST/api/v1/vendor/stickersSeller

Criar um selo

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Corpo da requisição

name_adminstringobrigatório
Nome interno. Obrigatório.
name_desktopstring
Texto exibido. Vazio = igual a name_admin.
name_mobilestring
Texto no celular.
stylestringpadrão: T
TIP
Estilo.
appearanceobject
Aparência (veja os campos da resposta). Vazio = {}.
display_onobject
Onde aparece. Padrão: card, página do produto e visão rápida.
statusstringpadrão: A
AD
Status inicial.
positionintegerpadrão: 0
Ordem.

Exemplo de requisição (criar)

bash
curl -X POST "$BASE_URL/api/v1/vendor/stickers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name_admin": "Promoção de outubro",
  "name_desktop": "PROMOÇÃO",
  "style": "T",
  "appearance": {
    "bg_color": "#ef4444",
    "text_color": "#ffffff",
    "position": "tl"
  },
  "status": "A"
}'

Resposta (criar)

201Selo criado
json
{
  "id": "e4c03c56-f826-4fc0-a29b-896793caef22",
  "name_admin": "Promoção de outubro",
  "name_desktop": "PROMOÇÃO",
  "name_mobile": "PROMO",
  "style": "T",
  "appearance": {
    "bg_color": "#ef4444",
    "text_color": "#ffffff",
    "font_size": 12,
    "padding": 6,
    "radius": 4,
    "position": "tl",
    "opacity": 1,
    "image_url": ""
  },
  "display_on": {
    "product_card": true,
    "pdp": true,
    "quickview": true
  },
  "status": "A",
  "position": 0,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "created_at": "2026-10-11T20:00:00Z",
  "updated_at": "2026-10-11T20:00:00Z",
  "assignment_mode": "manual"
}

Campos da resposta

idstring (uuid)
Id do selo.
name_adminstring
Nome interno, só para você.
name_desktopstring
Texto no computador.
name_mobilestring
Texto no celular (pode ficar vazio).
stylestring
TIP
T texto, I imagem, P pictograma (hoje exibido como texto).
appearanceobject
Aparência: bg_color, text_color, font_size, padding, radius, position (tl, tr, bl, br), opacity, image_url.
display_onobject
Onde aparece: product_card, pdp, quickview (booleanos).
statusstring
AD
A ativo, D desativado.
positioninteger
Ordem entre os selos.
vendor_idstring (uuid)
Seu seller.
assignment_modestring
Sempre manual para selos do seller.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).

Erros (criar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings"]}
400Nome vazio, estilo ou status fora da lista.{"error":"invalid style \"X\" (expected T, I, or P)"}

Consultar

GET/api/v1/vendor/stickers/{id}Seller

Consultar um selo

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório
Id do selo.

Exemplo de requisição (consultar)

bash
curl "$BASE_URL/api/v1/vendor/stickers/$STICKER_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta (consultar)

200Selo
json
{
  "id": "e4c03c56-f826-4fc0-a29b-896793caef22",
  "name_admin": "Promoção de outubro",
  "name_desktop": "PROMOÇÃO",
  "name_mobile": "PROMO",
  "style": "T",
  "appearance": {
    "bg_color": "#ef4444",
    "text_color": "#ffffff",
    "font_size": 12,
    "padding": 6,
    "radius": 4,
    "position": "tl",
    "opacity": 1,
    "image_url": ""
  },
  "display_on": {
    "product_card": true,
    "pdp": true,
    "quickview": true
  },
  "status": "A",
  "position": 0,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "created_at": "2026-10-11T20:00:00Z",
  "updated_at": "2026-10-11T20:00:00Z",
  "assignment_mode": "manual"
}

Campos da resposta

idstring (uuid)
Id do selo.
name_adminstring
Nome interno, só para você.
name_desktopstring
Texto no computador.
name_mobilestring
Texto no celular (pode ficar vazio).
stylestring
TIP
T texto, I imagem, P pictograma (hoje exibido como texto).
appearanceobject
Aparência: bg_color, text_color, font_size, padding, radius, position (tl, tr, bl, br), opacity, image_url.
display_onobject
Onde aparece: product_card, pdp, quickview (booleanos).
statusstring
AD
A ativo, D desativado.
positioninteger
Ordem entre os selos.
vendor_idstring (uuid)
Seu seller.
assignment_modestring
Sempre manual para selos do seller.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).

Erros (consultar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings"]}
404O selo não existe ou não é seu.{"error":"sticker not found"}

Alterar

PUT/api/v1/vendor/stickers/{id}Seller

Alterar um selo

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório
Id do selo.

Corpo da requisição

name_desktopstring
Texto exibido. Vazio = igual a name_admin.
name_mobilestring
Texto no celular.
stylestring
TIP
Estilo.
appearanceobject
Aparência (veja os campos da resposta). Vazio = {}.
display_onobject
Onde aparece. Padrão: card, página do produto e visão rápida.
statusstring
AD
Status inicial.
positioninteger
Ordem.
name_adminstring
Novo nome interno; não pode ficar em branco.

Exemplo de requisição (alterar)

bash
curl -X PUT "$BASE_URL/api/v1/vendor/stickers/$STICKER_ID" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name_desktop": "OFERTA",
  "status": "A"
}'

Resposta (alterar)

200Selo alterado
json
{
  "id": "e4c03c56-f826-4fc0-a29b-896793caef22",
  "name_admin": "Promoção de outubro",
  "name_desktop": "OFERTA",
  "name_mobile": "PROMO",
  "style": "T",
  "appearance": {
    "bg_color": "#ef4444",
    "text_color": "#ffffff",
    "font_size": 12,
    "padding": 6,
    "radius": 4,
    "position": "tl",
    "opacity": 1,
    "image_url": ""
  },
  "display_on": {
    "product_card": true,
    "pdp": true,
    "quickview": true
  },
  "status": "A",
  "position": 0,
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "created_at": "2026-10-11T20:00:00Z",
  "updated_at": "2026-10-11T20:00:00Z",
  "assignment_mode": "manual"
}

Campos da resposta

idstring (uuid)
Id do selo.
name_adminstring
Nome interno, só para você.
name_desktopstring
Texto no computador.
name_mobilestring
Texto no celular (pode ficar vazio).
stylestring
TIP
T texto, I imagem, P pictograma (hoje exibido como texto).
appearanceobject
Aparência: bg_color, text_color, font_size, padding, radius, position (tl, tr, bl, br), opacity, image_url.
display_onobject
Onde aparece: product_card, pdp, quickview (booleanos).
statusstring
AD
A ativo, D desativado.
positioninteger
Ordem entre os selos.
vendor_idstring (uuid)
Seu seller.
assignment_modestring
Sempre manual para selos do seller.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).

Erros (alterar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings"]}
404O selo não existe ou não é seu.{"error":"sticker not found"}
400Campo inválido (nome em branco, estilo, status).{"error":"invalid status \"X\" (expected A or D)"}

Excluir

DELETE/api/v1/vendor/stickers/{id}Seller

Excluir um selo

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório
Id do selo.

Exemplo de requisição (excluir)

bash
curl -X DELETE "$BASE_URL/api/v1/vendor/stickers/$STICKER_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta (excluir)

200Selo excluído
json
{
  "message": "sticker deleted"
}

Campos da resposta

messagestring
Confirmação fixa.

Erros (excluir)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings"]}
404O selo não existe ou não é seu.{"error":"sticker not found"}
Exclusão

A exclusão é definitiva e remove o selo de todos os produtos. Para tirá-lo do ar sem perder a configuração, altere o status para D.

Veja também

  • Vitrine e ofertas: visão geral
Anterior
Selos, kits, mixes e caixas
Próxima
Selos nos produtos
Nesta página
  • Listar
  • Exemplo de requisição (listar)
  • Resposta (listar)
  • Erros (listar)
  • Criar
  • Exemplo de requisição (criar)
  • Resposta (criar)
  • Erros (criar)
  • Consultar
  • Exemplo de requisição (consultar)
  • Resposta (consultar)
  • Erros (consultar)
  • Alterar
  • Exemplo de requisição (alterar)
  • Resposta (alterar)
  • Erros (alterar)
  • Excluir
  • Exemplo de requisição (excluir)
  • Resposta (excluir)
  • Erros (excluir)
  • Veja também