Desenvolvedores

Tags

Crie tags e ligue a produtos, variantes e categorias.

Tags marcam itens do catálogo e organizam chats. Todas as rotas exigem a permissão PROMISSE_TAGS.

Rotas#

Rota Corpo Resposta
GET /tags Lista com id, name, color, icon, private_view_chat e add_to_chat
POST /tag name e color obrigatórios. Opcionais: icon, products, variants, categories, private_view_chat, add_to_chat 201, { id, name, color, products, variants, categories }
PATCH /tag/:id Os mesmos, todos opcionais { "ok": true }
DELETE /tag/:id 204

Campos#

Campo Regra
name De 1 a 100 caracteres. Único na loja. Repetido responde 400 tag_name_taken.
color Formato #RRGGBB.
icon URL ou caminho, ou null.
products, variants, categories Listas de até 500 IDs.
private_view_chat Booleano.
add_to_chat Booleano.

Exemplos#

Criar uma tag ligada a um produto:

Terminal
curl -X POST "https://api.promisse.store/api/v1/tag" \
  -H "x-api-key: $PROMISSE_KEY" \
  -H "content-type: application/json" \
  -d '{ "name": "VIP", "color": "#00B2FF", "products": ["UUID_DO_PRODUTO"] }'

Substituir a lista de produtos e limpar as categorias:

Terminal
curl -X PATCH "https://api.promisse.store/api/v1/tag/UUID_DA_TAG" \
  -H "x-api-key: $PROMISSE_KEY" \
  -H "content-type: application/json" \
  -d '{ "products": ["UUID_DO_PRODUTO"], "categories": [] }'

Regras das listas#

  • ID que não é da loja é ignorado em silêncio. A resposta do POST mostra o que ficou.
  • No PATCH, enviar uma lista substitui o conjunto, [] esvazia e campo ausente não muda.