Appearance
Marcas
Gerencie as marcas dos produtos da loja.
Listar marcas
http
GET /api/v1/brandsQuery parameters
| Parâmetro | Tipo | Descrição |
|---|---|---|
search | string | Busca por nome |
active | boolean | Filtrar por status ativo |
sort | string | Campo de ordenação (padrão: name) |
direction | string | asc ou desc (padrão: asc) |
per_page | integer | Itens por página (máx: 100, padrão: 25) |
Exemplo
bash
curl -X GET "https://sualoja.com.br/api/v1/brands?active=true" \
-H "X-API-Key: SUA_CHAVE"Resposta
json
{
"data": [
{
"id": 1,
"name": "Nike",
"slug": "nike",
"description": "Marca esportiva internacional",
"website": "https://nike.com",
"active": true,
"logo": "https://sualoja.com.br/storage/.../nike-logo.webp",
"products_count": 120,
"created_at": "2026-01-10T08:00:00Z",
"updated_at": "2026-03-05T12:00:00Z"
}
]
}Buscar marca
http
GET /api/v1/brands/{id}Retorna a marca com a contagem de produtos.
Criar marca
http
POST /api/v1/brandsCampos
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | ✅ | Nome da marca |
description | string | Descrição | |
website | string | URL do site oficial | |
active | boolean | Ativa (padrão: true) | |
seo_title | string | Título para SEO | |
seo_description | string | Meta description | |
seo_keywords | string | Palavras-chave |
Exemplo
bash
curl -X POST https://sualoja.com.br/api/v1/brands \
-H "X-API-Key: SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{
"name": "Adidas",
"website": "https://adidas.com.br",
"active": true
}'Atualizar marca
http
PUT /api/v1/brands/{id}Aceita os mesmos campos do POST, todos opcionais.
Excluir marca
http
DELETE /api/v1/brands/{id}Restrição
Não é possível excluir uma marca que possui produtos vinculados. A API retorna 422:
json
{
"message": "Não é possível excluir: 30 produto(s) vinculado(s)."
}