v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Catálogo - Marcas

Criar marca

Cria uma nova marca no catálogo

post/{alias}/catalog/brands

Path parameters

aliasstring required

Alias da loja

Request body

namestring required

Nome da marca. Esse valor deve ser único. O valor é sanitizado e normalizado automaticamente.

activeboolean required

Se a marca está ativo

featuredboolean required
descriptionstring

Descrição da marca. O valor é sanitizado e normalizado automaticamente.

logo_urlstring uri

URL do logo da marca

Example request

{
  "name": "Yampi",
  "description": "Marca X de produtos",
  "logo_url": "https://foo.bar/logo.png"
}

Response

Marca criada com sucesso

Example response

{
  "data": {
    "name": "Nome da marca",
    "description": "Descrição da marca",
    "logo_url": "https://foo.bar/logo.png"
  }
}