E-Gestão API

Introdução

A API foi criada para permitir integração com o sistema ERP E-Gestão.

Autenticação

Como no desenvolvimento de API tratamos de vários endpoints restritos, é essencial ter a implementação de segurança. Quando trabalhamos com WebAPI é necessário se autenticar a cada requisição. Iremos trabalhar com bearer, que trafega um token no header.

Cadastro

API	Description
POST api/cadastro/consultaRotasVendas?cdempresa={cdempresa}&pageCount={pageCount}&pageNumber={pageNumber}	No documentation available.
GET api/cadastro/consultaTransportadoras?cdempresa={cdempresa}&pageCount={pageCount}&pageNumber={pageNumber}	No documentation available.
GET api/cadastro/consultaTiposCliente?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaRegioes?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaEspecies?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaTiposEndereco?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaTiposTelefone?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaTiposDocumento?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaCondicoesFaturamento?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaTiposProduto?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaCargos?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaCentrosDeCusto?cdempresa={cdempresa}&cdCentroCustoPai={cdCentroCustoPai}	No documentation available.
GET api/cadastro/consultaTiposContaContabil?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaContasContabeis?cdempresa={cdempresa}&cdTipoContaContabil={cdTipoContaContabil}&cdContaContabilPai={cdContaContabilPai}	No documentation available.
GET api/cadastro/consultaCategoriasProduto?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaSubcategoriasProduto?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaPaises?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaUfs	No documentation available.
GET api/cadastro/consultaCidades?cdempresa={cdempresa}&uf={uf}	No documentation available.
GET api/cadastro/consultaCEP?cep={cep}	No documentation available.
GET api/cadastro/consultaIventarios?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaOrigemMercadoriaIcms?cdempresa={cdempresa}	No documentation available.
GET api/cadastro/consultaMarcas?cdempresa={cdempresa}	No documentation available.

WMS

API	Description
POST api/wms/consultarEndereco?cdEmpresa={cdEmpresa}	No documentation available.
POST api/wms/consultarEnderecosProduto?cdEmpresa={cdEmpresa}&pageCount={pageCount}&pageNumber={pageNumber}	No documentation available.
POST api/wms/consultarMovimentacoes?cdEmpresa={cdEmpresa}&pageCount={pageCount}&pageNumber={pageNumber}	No documentation available.
POST api/wms/consultarSaldoEndereco?cdEmpresa={cdEmpresa}&pageCount={pageCount}&pageNumber={pageNumber}	No documentation available.
POST api/wms/transferencia?cdEmpresa={cdEmpresa}	No documentation available.
POST api/wms/picking?cdEmpresa={cdEmpresa}&CodigoPedidoVenda={CodigoPedidoVenda}&codigoProdutoKit={codigoProdutoKit}	No documentation available.
POST api/wms/pickingSemEndereco?cdEmpresa={cdEmpresa}&CodigoPedidoVenda={CodigoPedidoVenda}&codigoProdutoKit={codigoProdutoKit}	No documentation available.
POST api/wms/atualizaDadosPickingSemEndereco?cdEmpresa={cdEmpresa}&CodigoPedidoVenda={CodigoPedidoVenda}	No documentation available.
POST api/wms/VerificaLotePickingSemEndereco?cdEmpresa={cdEmpresa}&Lote={Lote}&codigoProdutoKit={codigoProdutoKit}	No documentation available.
POST api/wms/Encerramentopicking?cdEmpresa={cdEmpresa}&CodigoPedidoVenda={CodigoPedidoVenda}	No documentation available.

Acesso

API	Description
POST api/Acesso/login	No documentation available.
POST api/Acesso/loginEmpresa	No documentation available.
POST api/Acesso/trocarSenha	No documentation available.
POST api/Acesso/consultaLembrete	No documentation available.
POST api/Acesso/logServico	No documentation available.
POST api/Acesso/esqueciSenha	No documentation available.

Relatorios

API	Description
POST api/Relatorios/RelatorioClienteInadimplente?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.

Clientes

Metodos relacionados aos Clientes.

API	Description
GET Api/Cliente/SelecionarCliente?cdempresa={cdempresa}&cdCliente={cdCliente}&Documento={Documento}	No documentation available.
GET Api/Cliente/ConsultaSintegra?cdempresa={cdempresa}&CNPJ={CNPJ}&UF={UF}	No documentation available.
POST Api/Cliente/SelecionarClientesPaginado?cdempresa={cdempresa}&pageNumber={pageNumber}&pageCount={pageCount}	No documentation available.
POST Api/Cliente/inserir?cdempresa={cdempresa}	No documentation available.
PUT Api/Cliente/alterar?cdempresa={cdempresa}	No documentation available.

DisponibilizacaoDados

API	Description
GET api/DisponibilizacaoDados/disponibilizaDadosVendas?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.
GET api/DisponibilizacaoDados/disponibilizaDadosFaturamento?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.
GET api/DisponibilizacaoDados/disponibilizaDadosFinanceiro?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.
GET api/DisponibilizacaoDados/disponibilizaDadosClientes?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.
GET api/DisponibilizacaoDados/disponibilizaDadosEstoque?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.

Tool

API	Description
POST api/Tools/encrypt	No documentation available.

Fornecedor

API	Description
POST Api/Fornecedor/SelecionarFornecedorPaginado?cdempresa={cdempresa}&pageNumber={pageNumber}&pageCount={pageCount}	No documentation available.
GET Api/Fornecedor/SelecionarFornecedor?cdempresa={cdempresa}&cdFornecedor={cdFornecedor}&documento={documento}	No documentation available.
POST Api/Fornecedor/InserirFornecedor?cdempresa={cdempresa}	No documentation available.
PUT Api/Fornecedor/AlterarFornecedor?cdempresa={cdempresa}	No documentation available.

DocumentoPagamento

Metodos relacionados a Pagamentos.

API	Description
POST Api/Pagamentos/SelecionarParcelasPaginado?cdempresa={cdempresa}&pageNumber={pageNumber}&pageCount={pageCount}	Método para consultar Pagamentos.
GET Api/Pagamentos/SelecionarContaPagar?cdempresa={cdempresa}&cdContaPagar={cdContaPagar}&contaPaga={contaPaga}	No documentation available.
GET Api/Pagamentos/SelecionarParcelas?cdempresa={cdempresa}&nrDocumento={nrDocumento}&contaPaga={contaPaga}	No documentation available.
POST Api/Pagamentos/InserirContaPagar?cdempresa={cdempresa}	No documentation available.
PUT Api/Pagamentos/AlterarContaPagar?cdempresa={cdempresa}	No documentation available.
DELETE Api/Pagamentos/ExcluirParcela?cdempresa={cdempresa}&cdContaPagar={cdContaPagar}&cdParcela={cdParcela}&cdUsuario={cdUsuario}	No documentation available.

Produto

API	Description
POST api/Produto/BuscarProdutosPaginado?cdEmpresa={cdEmpresa}&pageNumber={pageNumber}&pageCount={pageCount}&cdCliente={cdCliente}&buscaApp={buscaApp}	No documentation available.
POST api/Produto/BuscarProduto?cdEmpresa={cdEmpresa}&nrCdProduto={nrCdProduto}	No documentation available.
POST api/Produto/InserirProduto?cdEmpresa={cdEmpresa}	No documentation available.
PUT api/Produto/AlterarProduto?cdEmpresa={cdEmpresa}	No documentation available.

Venda

Metodos relacionados a venda de produtos e serviços.

API	Description
POST Api/Venda/consultarPedidosExpedicao?cdEmpresa={cdEmpresa}&pageCount={pageCount}&pageNumber={pageNumber}&cdPedidoVenda={cdPedidoVenda}	Método para consultar pedidos disponíveis para expedição. Retorna a lista de pedidos que estão disponíveis para expedição.
POST Api/Venda/consultarPedidosVenda?cdEmpresa={cdEmpresa}&pageCount={pageCount}&pageNumber={pageNumber}	Método para consultar pedidos no ERP, retorna uma lista de pedidos solicitados.
GET Api/Venda/consultarPedidoVenda?cdEmpresa={cdEmpresa}&cdPedidoVenda={cdPedidoVenda}	Método para apresentar as informações de um pedido de venda específico.
GET Api/Venda/consultarIndicadorExecutivoConta?cdEmpresa={cdEmpresa}&cdExecutivoConta={cdExecutivoConta}	Método para apresentar as informações de um Executivo de Vendas específico.
POST Api/Venda/inserirPedidoVenda?cdEmpresa={cdEmpresa}	Método para envio de um pedido de venda para o ERP pelo app de força de vendas
POST Api/Venda/alterarPedidoVenda?cdEmpresa={cdEmpresa}	Método para alteração de um pedido de venda no ERP, utilizado apenas para integração com app de força de vendas.
DELETE Api/Venda/ExcluirPedido?cdEmpresa={cdEmpresa}&cdPedidoVenda={cdPedidoVenda}&cdUsuario={cdUsuario}	No documentation available.
POST Api/Venda/consultarTabelaPrecos?cdEmpresa={cdEmpresa}&cdTipoCliente={cdTipoCliente}	Método para consulta das tabelas de preços disponiveis para o app de força de vendas.
POST Api/Venda/consultarIndicadores?cdEmpresa={cdEmpresa}	Método para consulta dos indicadores do executivo de conta, para o app de força de vendas.
GET Api/Venda/StatusPedidoVenda?cdEmpresa={cdEmpresa}&cdPedidoVenda={cdPedidoVenda}	No documentation available.
POST Api/Venda/EnviarXML?cdEmpresa={cdEmpresa}&cdPedidoVenda={cdPedidoVenda}	No documentation available.
GET Api/Venda/ExtensoesEtiqueta	No documentation available.
POST Api/Venda/EnviarEtiqueta?cdEmpresa={cdEmpresa}	No documentation available.
POST Api/Venda/EnvioPedidoVenda?codigopedido={codigopedido}&codigoEmpresa={codigoEmpresa}	Método para Enviar email com pedido de venda..
POST Api/Venda/EnvioPedidoVendaPDF?codigopedido={codigopedido}&codigoEmpresa={codigoEmpresa}&email={email}	Método para Enviar email com pedido de venda..
POST Api/Venda/RetornoPedidoVendaPDF?codigopedido={codigopedido}&codigoEmpresa={codigoEmpresa}&email={email}	Método para retornar PDF do pedido de venda..
POST Api/Venda/RetornoPedidoVendaPDF?codigopedido={codigopedido}&codigoEmpresa={codigoEmpresa}	Método para retornar PDF do pedido de venda..
POST Api/Venda/Venda?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}	Método para cadastrar o pedido. Será retornado uma primary key do tipo inteiro (codigo do pedido) ao criar o pedido.
POST Api/Venda/Venda/Lote?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}	Método para cadastrar pedido em lote, via e-commerce ou agente externo. Será retornado uma lista de primarys keys do tipo inteiro (codigo do pedido) ao criar o pedido.
GET Api/Venda/Venda/{codigo}?codigoPedido={codigoPedido}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}	Método para consultar o pedido pelo código. Serão rertornadas as informações sobre o pedido.
GET api/Venda?tokenMLB={tokenMLB}&codigoNotaFiscal={codigoNotaFiscal}&ShippmentID={ShippmentID}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}	Método para consultar o pedido no Mercado Livre pelo código MELI do Pedido. Será retornado as informações sobre o pedido.

MontagemCarga

API	Description
GET Api/MontagemCarga/consultaMontagemCarga?cdEmpresa={cdEmpresa}&CNPJ={CNPJ}&token={token}&codigoMontagemCarga={codigoMontagemCarga}	No documentation available.
GET Api/MontagemCarga/consultaPedidosAguardandoTransporte?cdEmpresa={cdEmpresa}&CNPJ={CNPJ}&token={token}&pedidoFaturado={pedidoFaturado}&pageNumber={pageNumber}&pageSize={pageSize}&strSortExpression={strSortExpression}	No documentation available.
POST Api/MontagemCarga/inserirMontagemCarga?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.
PUT Api/MontagemCarga/alterarMontagemCarga?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}	No documentation available.
POST Api/MontagemCarga/consultarMontagensCarga?cdempresa={cdempresa}&CNPJ={CNPJ}&token={token}&pageCount={pageCount}&pageNumber={pageNumber}	No documentation available.

Shopee

API	Description
GET api/Shopee	No documentation available.
POST api/Shopee	No documentation available.
GET api/Shopee/code_enterprise/{id}?code={code}&shop_id={shop_id}	No documentation available.
GET api/Shopee/code/{id}?code={code}&main_account_id={main_account_id}	No documentation available.

Estoque

API	Description
POST api/Estoque/relatorioEstoqueLiquido?cdEmpresa={cdEmpresa}	No documentation available.

Financeiro

Metodos relacionados ao financeiro.

API	Description
GET Api/Alunos/consultarFinanceiroCliente?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&codigoCliente={codigoCliente}	Método para consultar informações financeiras.
GET api/Financeiro?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&RegistroAluno={RegistroAluno}	Método para consultar informações financeiras.
GET api/Financeiro?codigoAluno={codigoAluno}&codigoPedido={codigoPedido}&dataVencimento={dataVencimento}&tipoRetorno={tipoRetorno}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&RegistroAluno={RegistroAluno}	Método para gerar boleto. Esse metodo não possui informações no body (json) da requisição, apenas recebe parametros do cabeçalho e retorna o nosso numero do boleto (identificado do boleto).
GET api/Financeiro?codigoAluno={codigoAluno}&nossoNumero={nossoNumero}&tipoRetorno={tipoRetorno}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&RegistroAluno={RegistroAluno}	Método para consultar boleto.
PUT api/Financeiro?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&codigoPedido={codigoPedido}	Método para cancelar boleto. Esse metodo não possui informações no body (json) da requisição, apenas recebe parametros do cabeçalho e retorna se a solicitação foi atendida ou não.
GET api/Financeiro?codigoAluno={codigoAluno}&nossoNumero={nossoNumero}&CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&RegistroAluno={RegistroAluno}&CodigoPedido={CodigoPedido}	Método para consultar NF-e do aluno.
GET api/Financeiro?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&DataInicial={DataInicial}&DataFinal={DataFinal}&Documento={Documento}	Método para consultar informações financeiras detalhadas

Recebimento

API	Description
POST api/Recebimento/EnviarRecebimento?cdempresa={cdempresa}&token={token}	No documentation available.
POST api/Recebimento/EnviarXML?cdempresa={cdempresa}	No documentation available.

Webhook

API	Description
POST api/Webhook/EstoqueLiquido?cdempresa={cdempresa}	No documentation available.
POST api/Webhook/StatusPedidoVenda?cdempresa={cdempresa}&cdPedidoVenda={cdPedidoVenda}	No documentation available.
GET api/Webhook	No documentation available.

Entrega

API	Description
POST Api/Entrega/consultarPedidos?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&pageCount={pageCount}&pageNumber={pageNumber}&sort={sort}	No documentation available.
POST Api/Entrega/CadastrarEntrega?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}	No documentation available.

RetornoMeli

Metodos relacionados aos Alunos.

API	Description
POST api/RetornoMeli	Método para consultar o pedido pelo código. Será retornado as informações sobre o pedido.
POST api/RetornoMeli?token={token}&tokenMELI={tokenMELI}&caminhoArquivo={caminhoArquivo}	Método para Enviar Imagens do produto.
POST api/RetornoMeli?token={token}&tokenAPI={tokenAPI}&codigoProduto={codigoProduto}&codigoInventario={codigoInventario}&codigoEmpresa={codigoEmpresa}&codigoPlataforma={codigoPlataforma}	Método de Atualização de Estoque da Variação API
POST api/RetornoMeli?token={token}&codigoEmpresaAdmin={codigoEmpresaAdmin}&codigoEmpresaAdminReplicada={codigoEmpresaAdminReplicada}&codigoProduto={codigoProduto}&codigoProdutoDadoIntegracaoEcommerce={codigoProdutoDadoIntegracaoEcommerce}&codigoUsuarioLogado={codigoUsuarioLogado}	Método para Replicar publicação entre as empresas

integracaoPipefy

API	Description
GET api/integracaoPipefy?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&tokenPipefy={tokenPipefy}&phaseId={phaseId}&startCursor={startCursor}	Método para consultar informações dos Cards em fase de Pagamento.
GET api/integracaoPipefy?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&tokenPipefy={tokenPipefy}&phaseId={phaseId}&cardId={cardId}	Método para Mover os cards de phase
GET api/integracaoPipefy?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&tokenPipefy={tokenPipefy}&cardId={cardId}	Método para Mover os cards de phase

integracaoArquivo

Metodos relacionados à integração de arquivos.

API	Description
GET api/integracaoArquivo?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&nr_codigo_produto={nr_codigo_produto}	Método para consultar a existencia do produto.
POST api/integracaoArquivo?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&nr_codigo_produto={nr_codigo_produto}&count={count}&empresa={empresa}	Método para Enviar Imagens do produto.

Empresa

Metodos relacionados a Pagamentos.

API	Description
POST api/Empresa?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}	Método para incluir empresa.
PUT api/Empresa?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&codigoEmpresaAlterada={codigoEmpresaAlterada}	Método para Alterar Empresa.
PUT api/Empresa?CNPJ={CNPJ}&token={token}&codigoEmpresa={codigoEmpresa}&codigoEmpresaASerDesabiitada={codigoEmpresaASerDesabiitada}	Método para Desabilitar Empresa.
GET api/Empresa?token={token}&codigoEmpresa={codigoEmpresa}&codigoProduto={codigoProduto}	Método para Retornar Informações do eCommerce.