APIs privadas

Comercial · criar e atualizar

Criar e manter cadastros auxiliares do Comercial
View as Markdown

Comercial · criar e atualizar

Esta página concentra as operações privadas de escrita para cadastros auxiliares do Comercial.

Escopo atual:

  • POST /simplificav2/etapa_negociacao
  • PUT /simplificav2/etapa_negociacao/{id}
  • POST /simplificav2/motivo_cancelamento
  • PUT /simplificav2/motivo_cancelamento/{id}
  • POST /simplificav2/origem_comercial
  • PUT /simplificav2/origem_comercial/{id}
  • POST /simplificav2/categoria_produto
  • PUT /simplificav2/categoria_produto/{id}
  • POST /simplificav2/produto
  • PUT /simplificav2/produto/{id}
  • POST /simplificav2/servico
  • PUT /simplificav2/servico/{id}
  • POST /simplificav2/procedimento
  • PUT /simplificav2/procedimento/{id}
  • POST /simplificav2/kit
  • PUT /simplificav2/kit/{id}

Autenticação

1Authorization: Bearer {{bearer_token}}
2Content-Type: application/json

Regras gerais

  • todas as chamadas usam JSON;
  • cada chamada opera em um único registro;
  • os cadastros criados por POST nascem ativos;
  • não existe rota de exclusão por API para esses cadastros auxiliares;
  • use PUT com ativo = "N" para inativar;
  • use PUT com ativo = "S" para reativar.
  • nos PUT, a API atualiza somente os atributos enviados;
  • campos omitidos continuam com o valor atual e não são apagados.

Etapas de negociação

Rotas

  • GET /simplificav2/etapa_negociacao
  • POST /simplificav2/etapa_negociacao
  • PUT /simplificav2/etapa_negociacao/{id}

Use esse cadastro para manter as etapas do pipeline comercial.

Motivos de cancelamento comercial

Rotas

  • GET /simplificav2/motivo_cancelamento
  • POST /simplificav2/motivo_cancelamento
  • PUT /simplificav2/motivo_cancelamento/{id}

Observações:

  • origem define onde o motivo pode ser usado;
  • valores aceitos: O para oportunidade, V para venda e VO para todos.

Origens comerciais

Rotas

  • GET /simplificav2/origem_comercial
  • POST /simplificav2/origem_comercial
  • PUT /simplificav2/origem_comercial/{id}

Observações:

  • use essas rotas para manter as origens comerciais do funil;
  • no PUT, você pode ajustar o nome e o status ativo.

Categorias de produto

Rotas

  • GET /simplificav2/categoria_produto
  • POST /simplificav2/categoria_produto
  • PUT /simplificav2/categoria_produto/{id}

Observações:

  • use essas rotas para manter categorias de produto ou serviço do catálogo comercial;
  • no POST, a categoria nasce ativa;
  • no PUT, você pode ajustar o nome e o status ativo.

Produtos

Rotas

  • GET /simplificav2/produto
  • POST /simplificav2/produto
  • PUT /simplificav2/produto/{id}

Observações:

  • use essas rotas para manter produtos do catálogo comercial;
  • POST exige nome, categoria_produto_id, valor e custo;
  • movimenta_estoque aceita S ou N;
  • ao desligar movimenta_estoque, o saldo do produto é zerado pelo fluxo operacional do sistema.

Serviços

Rotas

  • GET /simplificav2/servico
  • POST /simplificav2/servico
  • PUT /simplificav2/servico/{id}

Observações:

  • use essas rotas para manter serviços comuns do catálogo;
  • POST exige nome, categoria_produto_id, valor e custo;
  • serviço não movimenta estoque por essa API.

Procedimentos

Rotas

  • GET /simplificav2/procedimento
  • POST /simplificav2/procedimento
  • PUT /simplificav2/procedimento/{id}

Observações:

  • use essas rotas para manter procedimentos do catálogo de serviços;
  • POST exige nome, categoria_produto_id, valor e custo;
  • procedimento é tratado como um serviço marcado para uso clínico.

Kits

Rotas

  • GET /simplificav2/kit
  • POST /simplificav2/kit
  • PUT /simplificav2/kit/{id}

Observações:

  • use essas rotas para manter kits comerciais e sua composição;
  • POST exige nome, categoria_produto_id, valor e custo;
  • itens, quando enviado, substitui a composição do kit no PUT;
  • para limpar a composição, envie itens: [].

Resposta de sucesso

Todas as operações usam o mesmo retorno mínimo:

1{
2  "status": "sucesso",
3  "mensagem": "Solicitação executada com sucesso.",
4  "data": {
5    "id": 123
6  }
7}