Endpoints - Cotação de Produtos

Owned by Joao Paulo Marcon
Last updated: Sept 10, 2024 by Jhonathan Christian Steffens
2 min read

1. Exemplo do json:

[ { "codigo": 3, "descricao": "Soja", "unidade_medida": 2, "codigo_externo": "15" } ]

Campos:

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

  • descricao: Descrição da cotação informada no cadastro do registro.

  • codigo_unidade_medida: Código da unidade de medida vinculado na cotação. Esse código deve ser o id da unidade de medida no banco de dados do CRM.

  • codigo_externo: Código da cotação no sistema integrado.

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

2.1 - Buscar uma cotação pelo código

Endpoint: /cotacao

Tipo: get

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código da cotação no banco de dados do CRM.

  • codigoExterno: Tipo: String. Código da cotação no banco de dados do sistema integrado

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna a cotação no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as cotações

Endpoint: /cotacao/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das cotações no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar cotação

Endpoint: /cotacao

Tipo: post

Notas:

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

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

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

  • O campo descrição é obrigatório;

  • Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna a cotação cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Deletar uma cotação

Endpoint: /cotacao

Tipo: delete

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código da cotação no banco de dados do CRM.

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

Resposta: Status 200 - Mensagem: Registro deletado com sucesso.

2.5 - Retornar os metadados da cotação

Endpoint: /cotacao/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 cotação

2.6 - Pesquisar

Endpoint: /cotacao/pesquisa

Tipo: post

Notas:

  • Esse endpoint retorna as cotações baseado nos filtros e na ordenação informados;

  • Exemplo do corpo da requisição:

  • { "pagina": 1, "quantidadeRegistros": 1, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "soja" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }

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