Page Comparison

1. Exemplo do json:

{
  "codigo": 2,
  "descricao": "Viasoft",
  "codigo_externo": "5",
  "ativo": "S"
}

Campos:

• codigo: Código do registro no banco de dados do CRM

• descricao: Descrição da marca;

• ativo: Campo para indicar se a marca está ativa (S) ou inativa (N)

...

2.1 - Buscar Marca pelo código

Endpoint: /produto-marca

Tipo: get

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código da marca no banco de dados do CRM.

• codigoExterno:Tipo: String.Código da marca no banco de dados do sistema integrado

...

2.2 - Buscar todas as marcas

Endpoint: /produto-marca/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das marcas no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar marca

Endpoint:/produto-marca

Tipo: post

Notas:

• Informe no corpo da requisição o json conforme exemplo na sessão 1.

• Para cadastrar uma nova marca não informe o campo “codigo”;

• Para editar uma marca já existente informe o campo “codigo” com o código da marca que deseja editar;

...

Não é possível deletar uma marca, apenas inativar, pois a marca pode ter vinculo com produtos. Nesse caso, a marca continua no banco de dados porém com o status inativo.

Endpoint:/produto-marca

Tipo: delete

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código da marca no banco de dados do CRM.

• codigoExterno:Tipo: String.Código da marca no banco de dados do sistema integrado, caso existir.

...

2.5 - Retornar os metadados da marca

Endpoint: /produto-marca/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos da marca

2.6 - Pesquisar

Endpoint: /produto-marca/pesquisa

Tipo: post

Notas:

• Esse endpointretorna as marcas baseado nos filtros e na ordenação informados;

• Exemplo do corpo da requisição:

• Code Block
  { "pagina": 1, "quantidadeRegistros": 5, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "VIASOFT" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }

• Nesse exemplo, estamos filtrando todas as marcas cuja descrição possua o texto “VIASOFT”, também estamos ordenando os registros pela descrição de forma ascendente.