Atualizar uma marca

PUT https://.account-name.krzlabs.io/api/v1/brands/:id

Realiza a atualização de uma marca.


Path Params

id string required
ID da marca.

Field Type optional description Searchable
code string required Código da marca.
O código deve ser único e é o identificador global da marca.
false
name Translate required Nome da marca true
original_name Translate not required Nome original da marca.
Mais especificamente, sua razão social.
true
description Translate not required Descrição da marca.
Mais especificamente, sua descrição comercial ou todas as informações que julgar necessário da marca.
false
image string not required Imagem da marca false
enabled boolean not required Indica se a marca está ativa ou não. false
tags Array(string) not required Tags da marca.
Tags são utilizadas para categorizar as marcas, permitindo regras de negócio específicas para cada tag e novas organizações de dados.
false
Exemplo em JSON
{
  "code": "brand_123",
  "name": {
    "pt": "Marca Exemplo",
    "en": "Example Brand"
  },
  "original_name": {
    "pt": "Razão Social Exemplo LTDA",
    "en": "Example Corporate Name Ltd."
  },
  "description": {
    "pt": "Descrição comercial da marca.",
    "en": "Commercial description of the brand."
  },
  "image": "https://cdn.exemplo.com/brands/brand_123.png",
  "enabled": true,
  "tags": ["premium", "importado", "sazonal"]
}

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type optional description Searchable
code string required Código da marca.
O código deve ser único e é o identificador global da marca.
false
name Translate required Nome da marca true
original_name Translate not required Nome original da marca.
Mais especificamente, sua razão social.
true
description Translate not required Descrição da marca.
Mais especificamente, sua descrição comercial ou todas as informações que julgar necessário da marca.
false
image string not required Imagem da marca false
enabled boolean not required Indica se a marca está ativa ou não. false
tags Array(string) not required Tags da marca.
Tags são utilizadas para categorizar as marcas, permitindo regras de negócio específicas para cada tag e novas organizações de dados.
false

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved