Introdução

Preparamos uma documentação completa para você usar a nossa API sem complexidade!

A API é o principal meio para os desenvolvedores acessarem nossos recursos e realizar a integração com o seu sistema.

Requisitos para integrar conosco:
  • Conhecimento em APIs RESTful, se você não conhece, recomendamos este guia para te ajudar.
  • Uma conta no pedidoeletronico.com, se ainda não tiver clique aqui e crie uma.
  • Um pouco de conhecimento em programação.
URL base para as requisições:

https://apidata.pedidoeletronico.com/

Autenticação

Autenticação, é necessário?

Sim! Para que nossa API possa ser acionada é preciso realizar uma Autenticação para garantir que os dados transacionados estejam seguros. Utilizamos uma autenticação através do token de segurança que cada conta possui.

Antes de iniciar, verifique se você já possui:
  • Uma conta no pedidoeletronico.com, se ainda não tiver clique aqui e crie uma.
  • Token de segurança
Como obter o token de segurança:

Após criar sua conta, acesse no menu Configuração da empresa -> Empresas . Dentro deste módulo estará um campo preenchido com Token, preencha seu cadastro de empresa, copie e salve suas informações.

Como enviar o token de autenticação:

Com o token em mãos, você deve adicioná-lo no cabeçalho em todas as requisições que for realizar da seguinte forma:

--header 'Content-Type: application/json', 'xToken: token_value'

OBS: Caso envie da forma errada ou não envie, você receberá um erro 401 - Unathorized.

Limite de requisições

Para preservar a integridade e a confiabilidade da plataforma, as nossas APIs têm o seguinte limite de taxa: 100 requisições por minuto.

Ao projetar seu aplicativo pense em controlar o fluxo de solicitações de API para uma melhor produtividade sem exceder o máximo de requisições por segundo, caso contrário, você receberá um erro 429 - Too Many Requests.

Tipo de requisições

GET

utilizamos a metodologia com data de última alteração, paginação e quantidade de registros por página.

Para realizar a busca deve-se encaminhar a página, juntamente com a quantidade de registros. A data de última alteração é opcional, caso encaminhe, será buscado os registros que sofreram alteração ou foram incluídos a partir do que for encamihado.

Os parâmetros em sua maioria são:

Campo Tipo Descriçao
pagina Integer número da página para obter registros
quantidadeRegistros Integer número da registros que devem vir no select ( máx 100 )
dtUltimaAlteracao DateTime(yyyy-mm-dd T HH:mm:ss) Opcional - Data de última alteração dos registros
id Integer Indetificador único dos objetos

URL Base Exemplo https://apidata.pedidoeletronico.com/api/TipoCadastro/ObterRegistros/pagina/quantidadeRegistro/dtUltimaAlteracao

Para buscar todos os registros cadastrados, basta fazer um GET com o seguinte endereço ( no exemplo, produtos ): https://apidata.pedidoeletronico.com/api/TipoCadastro/ObterRegistros/1/100/2020-01-05T15:17:42

Para buscar apenas um registro, basta fazer um GET no endereço cujo o ID foi o armazenado em nosso banco com o xMeuID do integrador ( no exemplo, clientes ): https://apidata.pedidoeletronico.com/api/TipoCadastro/ObterRegistro/1234

POST

Toda requisição POST deverá possuir além do token, o header de Content-type json --header 'Content-Type: application/json', 'xToken: token_value'

Para inserir novos dados, basta chamar a URL e adicionar no body da requisição em formato json respeitando o nome dos campos do objeto ( no exemplo, produtos ): https://apidata.pedidoeletronico.com/api/TipoCadastro/Post


                       body { 
                        "stAtivo": true,
                        "dtEmissao": "2020-01-08T23:17:42", 
                        "xAlternativoProduto": "sample string 6",
                        "xNomeProduto": "sample string 7", 
                        }
PUT

para atualizar informações, deve-se utilizar o método PUT seguindo a mesma lógica do POST https://apidata.pedidoeletronico.com/api/Produtos/Post , porém deve-se encaminhar obrigatoriamente o ID do registro do nosso banco de dados a ser atualizado

Nosso MarketPlace

Como ingressar e fazer parte de nossa parceria?

Ao finalizar a integração com seu aplicativo, entre em contato conosco para preencher suas informações necessárias para validação da sua integração e tenha a oportunidade de aparecer em nosso marketplace.

Milhares de clientes visualizam nossos serviços todos os dias, venha fazer parte da nossa parceria!

Clique aqui e preencha seus dados

Categorias do produto

As categorias do produto possuem níveis hierárquicos entre categoria pai e categoria filha.

URL Get: https://apidata.pedidoeletronico.com/api/CategoriaProduto/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/CategoriaProduto/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/CategoriaProduto/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idCategoria Integer Identificador único do objeto
xCategoria String(100) Nome da categoria
xCategoriaPai String(100) Nome da categoria pai, automaticamente vinculada conforme descrição enviada, caso não enviada ficará sem categoria pai.
xRepresentacao String(100) Nome da representação da categoria, automaticamente vinculada conforme descrição enviada, caso não enviada ficará sem representação
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Clientes

Clientes são cadastros que pertencem ao sistema e fazem referência na hora de realizar o pedido de venda.

URL Get: https://apidata.pedidoeletronico.com/api/Cliente/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/Cliente/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/Cliente/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idClientes Integer Identificador único do objeto
xRazaoSocial String(200) Razão social do cliente
xRamoAtividade String(45) Procura pelo Ramo de Atividade
xFantasiaCliente String(200) Nome Fantasia do cliente
xCodigoAlternativo String(50) Código alternativo do cliente
xCpfCnpj String(45) CNPJ do cliente
xRgIe String(15) IE do cliente
xNomeRepresentanteCliente String Nome do representante vinculado ao cliente, com base no nome vinculamos o cadastro do vendedor a este cliente.
xEmailRepresentanteCliente String E-mail do representante vinculado ao cliente, com base no nome vinculamos o cadastro do vendedor a este cliente.
xMeuIdRepresentanteCliente String Código Integração do representante vinculado ao cliente, com base no nome vinculamos o cadastro do vendedor a este cliente.
bInserirRepresentante boolean Se o representante não existir e esse campo estiver True, ele insere o representante na base.
xAnotacaoCliente String Anotações particulares do cliente
xCondicaoPagamento String(45) Busca por uma condição de pagamento existente.
xEmail String E-mails do cliente ( OBS: Separados por vírgula "," )
xTelefones String Telefones do cliente ( OBS: Separados por vírgula "," )
vLimiteCredito Decimal Nullable Limite de crédito do cliente
vMinimoVenda Decimal Mínimo de venda do cliente no pedido de venda
dtCadastro DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de cadastro do cliente
dtUltimaAlteracao DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de última alteração
dtNascimento DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de nascimento do cliente
xWebSite String Website do cliente
lEnderecos Array de Endereco Lista da entidade Endereco
lContatos Array de Contato Lista da entidade Contato
xNomeTransportadora String(75) Busca pelo nome da transportadora
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Condições de pagamento

Condições de pagamento são cadastros que possuem parâmetros como Desconto ou Acréscimo na hora da venda e Definição por tabela de preço por condição.

Eles são utilizados na hora da venda e seus parâmetros são opcionais

URL Get: https://apidata.pedidoeletronico.com/api/CondicaoPagamento/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/CondicaoPagamento/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/CondicaoPagamento/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idCondicaoPagamento Integer Identificador único do objeto
xCondicaoPagamento String(50) Nome da condição
xFormula String(100) Fórmula da condição caso ela possua uma condição especial. (Obs: será priorizado a xFormula no lugar do campo nParcelas)
nParcelas Integer Nullable Número de parcelas caso ela seja uma condição normal. (Obs: será priorizado a xFormula no lugar do campo nParcelas)
nDiaFavoravel Integer Nullable Dia específico de vencimento das duplicatas.
vDescCondicao Decimal Nullable Desconto ou acréscimo da condição de pagamento na hora da venda
xTabelaPrecoCondicao String(100) Nome da tabela de preço vinculada a condição. Ela será buscada através de nosso banco de dados.
stBaixa Byte Define se a condição baixa alguma parcela ( 0 - Baixa a primeira parcela | 1 - Nenhuma | 2 - Todas )
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Data Servidor

Esta api tem como objetivo fornecer a data e hora do servidor com apenas um GET sem parâmetros ou Token no header.

URL Get: https://apidata.pedidoeletronico.com/api/DateServer/ObterRegistro/

Estrutura de retorno:
Campo Tipo Descriçao
DateServidor DateTime(yyyy-mm-dd T HH:mm:ss) Data e hora do servidor

Endereços

Endereços podem ser vários e estão vinculados a clientes, representações e transportadoras. Em nossa api, essa estrutura deve ser encaminhada ou recebida nas apis dos respectivos cadastros comentados.

Esse registro se vincula com cada tipo de cadastro com base no ID do cadastro vinculado. Lembrando que NÃO é permitido ter ID de cadastros diferentes, exemplo: um endereço possuir os IDs de transportadora e cliente.

Estrutura para GET e POST:
Campo Tipo Descriçao
idEndereco Integer Identificador único do objeto
xTipoEndereco String(2) Sigla do endereço, sendo somente permitido: "CO" COMERCIAL; "FA" FATURAMENTO; "CB" COBRANÇA; "EN" ENTREGA; "PA" PARTICULAR;
xCep String(45) Cep do endereço
xEndereco String(75) Endereço do local
cNumero Integer Número do endereço
xComplemento String(45) Complemento do endereço
xBairro String(45) Bairro do endereço
xCidade String(45) Cidade do endereço
xEstado String(2) Sigla do estado do endereço
xLatitude String(100) Latitude do endereço
xLongitude String(100) Longitude do endereço
stPrincipal boolean true - Cadastro Ativo / false - Cadastro inativo ( OBS: Só é permitido apenas 1 endereço como principal do cadastro vinculado )
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Contatos

Contatos podem ser vários e estão vinculados a clientes. Em nossa api, essa estrutura deve ser encaminhada ou recebida nas apis dos respectivos cadastros comentados.

Esse registro se vincula com cada tipo de cadastro com base no ID do cadastro vinculado.

Estrutura para POST:
Campo Tipo Descriçao
idContato Integer Identificador único do objeto
stDepartamento String(2) Departamento ao qual o contato pertence ( valores : AD - Administrativo / CP - Compras / FA - Faturamento/Comercial / FI - Financeiro)
xNome String(200) Nome do contato
xCargo String(25) Cargo do contato
xAnotacao String Anotação para o contato
xEmail String(256) Email do contato
xTelefone String(16) Telefone do contato
xMeuID String(200) ID do registro com base no banco de dados do integrador

Grades de cores e tamanhos

As grades são cadastros vinculados diretamente no produto. Sua entidade é vinculada na entidade de produto ao realizar um POST ou GET de Produto

Esse registro se vincula com cada tipo de cadastro com base no ID do cadastro vinculado. Ao ser incluído no banco, ele gera um IDENTIFICADOR ÚNICO para que possa ser usado para edições futuras.

Estrutura de COR para GET e POST:
Campo Tipo Descriçao
idGradeCor Integer Identificador único do objeto
xNome String(15) Nome da cor
xCor String(100) Código RGB com hash da cor. Ex: #ff9800
idProduto Integer (obrigatório)Identificador único do objeto Produto
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
Estrutura de TAMANHO para GET e POST:
Campo Tipo Descriçao
idGradeTamanho Integer Identificador único do objeto
xNome String(15) Nome da cor
idProduto Integer (obrigatório)Identificador único do objeto Produto
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo

Imagens

A API de imagens está relacionada diretamente ao cadastro de produto. Encaminhe a imagem em formato base64 para que seja salvo no produto (só serão aceitos formatos png e jpg)

Neste caso em específico a url vai ser diferente e as requisições serão permitidas apenas 1 por segundo.

URL POST: http://apidataimage.pedidoeletronico.com/api/Imagem/PostImagem

Estrutura para o POST:
Campo Tipo Descriçao
idProduto Integer Identificador do produto
base64Image string Imagem convertida em base64

Estoque

Nosso estoque é calculado, para pegar a situação do estoque atual do produto, basta realizar o get encaminhando o idProduto.

Encaminhamos uma Array da situação do estoque do produto pois ele pode conter também os estoques de cada grade de cor e tamanho, se existirem.

URL Get: https://apidata.pedidoeletronico.com/api/Estoque/ObterRegistro/id

Estrutura para GET
Campo Tipo Descriçao
idProduto Integer Identificador único do objeto
vEstoque Decimal Estoque atual do produto.
xGradeCor String(45) Grade de cor do estoque
xGradeTamanho String(45) Grade de tamanho do estoque

Para inserir as movimentações, utilize essa url de post e a estrutura para o post exemplificada mais abaixo

URL POST: https://apidata.pedidoeletronico.com/api/Estoque/Post

Estrutura para POST
Campo Tipo Descriçao
idMovimentoEstoque Integer Identificador único do objeto
xNotaFiscal String(50) Nota fiscal
xAnotacaoMovimento String(500) Anotação do movimento de estoque
dtMovimentacao DateTime(yyyy-mm-dd T HH:mm:ss) Data da movimentação ( obrigatório )
xMeuID String(100) Código de integração
stMovimentacaoEstoque byte Tipo da movimentação (1 - Entrada | 25 - Inventário | 50 - Saída)
lMovimento_Detalhes Array de Itens da movimentação Lista da entidade Itens Mov. Estoque
Estrutura da entidade Itens Movimento Estoque

Obs: Se você utiliza produtos com variações, ignore o idGradeCor e idGradeTamanho porque estes dois são para as grades de cores e tamanhos do produto. Produtos com variação basta mandar apenas o idProduto

Campo Tipo Descriçao
idProduto Integer Identificador único do objeto Produto
idGradeCor Integer Identificador único do objeto Grade Cor do produto
idGradeTamanho Integer Identificador único do objeto Grade Tamanho Produto
qMovimentacao Decimal Quantidade do movimento (somente valores positivos permitidos, as saídas são com base no stMovimentacao)

URL Excluir: https://apidata.pedidoeletronico.com/api/Estoque/Excluir/id

Basta encaminhar o código da movimentação (idMovimentoEstoque) para a Exclusão da movimentação.

Produtos

Cadastro de produtos possui vinculo direto com Categoria, Representação e Unidade de Medida. Buscamos eles em nosso banco baseados na descrição encaminhada, caso não seja achado, será vinculado um padrão já existente na sua base.

URL Get: https://apidata.pedidoeletronico.com/api/Produto/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/Produto/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/Produto/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idProduto Integer Identificador único do objeto
xNome String(100) Nome do produto
cAlternativo String(15) Código alternativo do produto
xUnidadeMedida String(100) Unidade de medida do produto
xRepresentada String(100) Representação do produto
xCategoria String(100) Categoria do produto
pIcms Decimal Nullable Porcentagem para composição de custo de ICMS
pIpi Decimal Nullable Porcentagem para composição de custo de IPI
pSt Decimal Nullable Porcentagem para composição de custo de ST
pOutras Decimal Nullable Porcentagem para composição de custo de Outros valores
vCusto Decimal Nullable Custo do produto
vEstoqueMax Decimal Nullable Valor para estoque máximo
vEstoqueMin Decimal Nullable Valor para estoque mínimo
xAnotacao String(500) Anotações internas do produto
bExibirAnotacaoNoPedido Boolean Nullable Exibe as anotações internas do produto no pedido de venda (true - false)
xFabricante String(65) Fabricante do produto
pComissao Decimal Nullable Porcentagem de comissão vinculada ao produto
vVenda Decimal Nullable Valor de venda do produto
pLucro Decimal Nullable Porcentagem de Lucro do produto
dtCadastro DateTime(yyyy-mm-dd T HH:mm:ss) Data de cadastro do produto
pIpiVenda Decimal Nullable Porcentagem de IPI na venda do produto
pStVenda Decimal Nullable Porcentagem de ST na venda do produto
xNcm String(100) Ncm do produto
cEan String(15) Código Ean do produto
cEanEmb String(20) Código Ean da Embalagem do produto
xCodigoSku String(50) Código SKU Produto
dPesoLiq Decimal Nullable Peso líquido do produto
dPesoBruto Decimal Nullable Peso bruto do produto
vLimiteMinimoVenda Decimal Nullable Mínimo de vendas do produto
idProdutoPai Integer ( Nullable ) Identificador único do objeto do Produto Pai ( usado quando variação )
lImagens Array de Lista das urls de imagens
lGradeCor Array de Grades de cores Lista da entidade Grades
lGradeTamanho Array de Grades de tamanhos Lista da entidade Grades
lVariacoes Array de Variações de Grade dos produtos Lista da entidade Variação de Grades
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador
xMeuIDPai String(200) ID do registro do produto pai com base no banco de dados do integrador
Estrutura das variações

As variações são grades genéricas que ficam atreladas ao produto. Os produtos com variação possuem um produto pai que é necessário para servir de produto base na hora da venda, assim o usuário vai conseguir escolher as grades conforme a sequencia de grades definidas. Se o id das grades não forem encaminhandos, será tentado buscar através do nome da grade, caso não ache, ele vai incluir a grade no nosso banco e atrelar ao produto.

Campo Tipo Descriçao
idGrade Integer Identificador único do objeto Grade
nSequencia Integer Sequência da grade no produto
xNomeGrade String(200) Nome da Grade ( Ex: COR )
gradeVariacao Objeto de Composição da grade
Estrutura da composição da variação da grade
Campo Tipo Descriçao
idGradeComposicao Integer Identificador único do objeto Composição da Grade
xNomeComposicao String(200) Nome da Composição ( Ex: Azul )

Pedido de venda

Nossa integração de pedidos é rápida e fácil. Aqui você vai trabalhar basicamente com todos os cadastros incluídos no sistema e relacioná-los em nosso pedido.

Cadastros como transportadora, condição de pagamento, tabela de preço , status do pedido serão vinculados automaticamente com base no cliente caso não seja encaminhado no pedido.

Obs: Todo pedido incluído vai gerar automaticamente o financeiro e a saída de estoque em nossa base de dados.

URL Get: https://apidata.pedidoeletronico.com/api/PedidoVenda/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/PedidoVenda/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/PedidoVenda/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idPedidoVenda Integer Identificador único do objeto
idStatus Integer Identificador único da entidade Status
idClientes Integer Identificador único da entidade Clientes
idCondicaoPagamento Integer Identificador único da entidade Condição de pagamento
idTransportadora Integer Identificador único do objeto
idRedespacho Integer Identificador único do objeto para redespacho da entidade Transportadora
idRepresentantePedido Integer Identificador único do objeto da entidade Representante
stLancamento Byte Parâmetro para definir se é pedido ou orçamento. 0 - Orçamento / 1 - Pedido
lItens Array de Itens Pedido Lista da entidade Itens Pedido
dEmissao DateTime(yyyy-mm-dd T HH:mm:ss) Data de emissão do pedido
dtPrevisto DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de previsão do pedido
dtUltimaAlteracao DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de última alteração do pedido ( não editável )
vDescontoPed Decimal Desconto total do pedido
vFretePed Decimal Frete do pedido
vOutrasPed Decimal Outras despesas do pedido
stFretePed String(1) Frete por conta de: R - Remetente | D - Destinatário | T - Terceiro | S - Sem Frete |
vSeguroPed Decimal Valor do seguro do pedido
vTotalProd Decimal Valor Total do produto
vSubTotal Decimal Valor total do pedido
xPedidoCompra String(200) Pedido de compra do pedido de venda
xObsInterna String (1000) Observação interna do pedido de venda
xInfAdicional String(1000) Informações adicionais do pedido
xMotivoCancelamento String(1000) Motivo do cancelamento do pedido
xChaveNFe String(100) Informações adicionais do pedido
xNumNF String(100) Informações adicionais do pedido
xMeuID String(200) ID do registro com base no banco de dados do integrador
Estrutura da entidade Itens do pedido
Campo Tipo Descriçao
idPedidoVendaItem Integer Identificador único do objeto
idProduto Integer Identificador único do objeto para redespacho da entidade Produto
idTabelaPreco Integer Identificador único do objeto para redespacho da entidade Tabela de preços
idGradeCor Identificador da entidade Grades de cores Objeto da entidade Grades
idGradeTamanho Identificador da entidade Grades de tamanhos Objeto da entidade Grades
pComissao Decimal % de comissão a nível de item
vComissao Decimal Valor da comissão a nível de item
vUnitarioVenda Decimal Valor Original de Venda ( com impostos sem descontos )
vUnitarioVendaSemImpostos Decimal Valor de venda sem impostos
vUnitarioVendaComImpostos Decimal Valor de Venda Final
pDesconto Decimal % de desconto do item
vDesconto Decimal Desconto do item
pIpiVenda Decimal porcentagem do IPI do produto
pStVenda Decimal porcentagem do ST do produto
vSubTotalSemImpostos Decimal Total do item sem impostos
vSubTotal Decimal Total do item
xMeuID String(200) ID do registro com base no banco de dados do integrador
bExcluir Boolean Caso venha como true, o registro será excluído

Pedido de venda - Status

Atualize rapidamente o status do seu pedido de venda. Com apenas o código do status e do pedido de venda, você pode estar cancelando seu pedido ou colocando seu status para vendido e nosso sistema irá garantir a exclusão das duplicatas ou a geração do financeiro, além de guardar o histórico da alteração de status do pedido.

Um ponto importante, as outras informações você pode encaminhar para que seja alterado os valores dos campos do pedido, não é obrigatório.

URL Post: https://apidata.pedidoeletronico.com/api/PedidoVenda/atualizarstatus

Estrutura para POST:
Campo Tipo Descriçao
idPedidoVenda Integer Identificador único do objeto
idStatus Integer Identificador único da entidade Status
enviarEmailCliente boolean true - envia email para cliente / false - não envia email para cliente
motivoCancelamento String(200) Texto do motivo do cancelamento
xMeuID String(200) ID do pedido de venda de quem está integrando
xNumNF String(100) Número da NF do pedido
xChaveNFe String(100) Chave da NF do pedido
xObsInterna String (1000) Observação interna do pedido de venda
dtEntrega DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data da entrega
dtPrevisaoEntrega DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de previsão de entrega
dtPrevisaoFaturamento DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de previsão de faturamento
dtFaturamento DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de faturamento

Pedido de venda - Exclusão

Realize o processo de exclusão do pedido de venda.

URL Post: https://apidata.pedidoeletronico.com/api/PedidoVenda/Excluir

Estrutura para POST:
Campo Tipo Descriçao
idPedidoVenda Integer Identificador único do objeto

Ramos de Atividade

Ramos de atividade é a categoria ao qual o cliente pertence. É um vínculo para cada cliente cadastrado.

URL Get: https://apidata.pedidoeletronico.com/api/RamoAtividade/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/RamoAtividade/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/RamoAtividade/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idRamoAtividade Integer Identificador único do objeto
xRamoAtividade String(45) Descrição do ramo de atividade
xCodigoRamoAtividade String(15) Código alternativo do ramo de atividade
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Representadas

Representadas são as marcas dos seus produtos em nosso software.

Controlamos comissão com base também na representada de cada produto então em sua entidade existem parâmetros que você pode manusear.

URL Get: https://apidata.pedidoeletronico.com/api/Representacao/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/Representacao/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/Representacao/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idRepresentada Integer Identificador único do objeto
xRazaoSocialRepresentacao String(75) Razão social da representada
xFantasiaRepresentacao String(45) Nome Fantasia da representada
xCnpjRepresentacao String(45) CNPJ da representada
xAnotacoesRepresentacao String Anotações particulares da representada
pComissao Decimal Porcentagem da comissão aplicada na representada
stComissaoIPI boolean Aplica comissão sobre o IPI na venda
stComissaoST boolean Aplica comissão sobre o ST na venda
xTransportadoraRepresentacao String Transportadora vinculada a representada
xEmailsRepresentacao String E-mails da representada ( OBS: Separados por vírgula "," )
xTelefonesRepresentacao String Telefones da representada ( OBS: Separados por vírgula "," )
lEnderecos Array de Endereco Lista da entidade Endereco
lContatos Array de Contato Lista da entidade Contato
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo

Representantes

Representantes são os vendedores vinculados na sua empresa. Lembrando que de acordo com o plano contratado da empresa, existe um limite máximo de representantes

URL Get: https://apidata.pedidoeletronico.com/api/Representantes/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/Representantes/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/Representantes/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idEmpresa_aspnetUsers Integer Identificador único do objeto
xNome String(75) Nome do vendedor
xApelido String(25) Apelido do vendedor
stAdministrador Boolean true - Administrador / false - Vendedor
xEmail String(100) E-mail de login do vendedor
dtInclusao DateTime(yyyy-mm-dd T HH:mm:ss) Data de inclusão do vendedor
xTelefones String(50) Telefone do vendedor
lEnderecos Array de Endereco Lista da entidade Endereco
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Status de venda

Status de venda são cadastros vinculados ao pedido de venda. O pedidoeletronico.com permite configurações na sigla, cor e tipo de status que vai ser.

URL Get: https://apidata.pedidoeletronico.com/api/StatusVenda/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/StatusVenda/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/StatusVenda/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idStatus Integer Identificador único do objeto
xStatus String(25) Descrição do status
xCor String(20) Código RGB com hash da cor. Ex: #ff9800
stTipoVenda Integer Tipo padrão do status no sistema. 0 - Aberto, 1 - Cancelado, 2 - Vendido
xSigla String(2) Sigla do status, ex: "VE", "CA"
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo

Transportadoras

Transportadoras são cadastros que podem ser vinculados ao cliente bem como listar no pedido de venda.

URL Get: https://apidata.pedidoeletronico.com/api/Transportadora/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/Transportadora/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/Transportadora/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idTransportadora Integer Identificador único do objeto
xRazaoSocialTransportadora String(75) Razão social da transportadora
xFantasiaTransportadora String(45) Nome Fantasia da transportadora
xCnpjTransportadora String(45) CNPJ da transportadora
xIeTransportadora String(15) IE da transportadora
xAnotacaoTransportadora String Anotações particulares da transportadora
xEmailsTransportadora String E-mails da transportadora ( OBS: Separados por vírgula "," )
xTelefonesTransportadora String Telefones da transportadora ( OBS: Separados por vírgula "," )
lEnderecos Array de Endereco Lista da entidade Endereco
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Tabela de Preço

Nossas tabelas de preço são extremamente flexíveis em relação a filtros, configurações de valores, etc.

Antes de continuar, entenda melhor como ela funciona, assim você pode explorar mais as opções que possuímos.

Clique aqui e veja nosso tutorial de como funciona nossa tabela de preço.

URL Get: https://apidata.pedidoeletronico.com/api/TabelaPreco/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/TabelaPreco/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/TabelaPreco/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idTabelaPreco Integer Identificador único do objeto
xNome String(200) Nome da tabela de preço
stTipoTabela Byte Tipo da tabela de preço ( 0 - Desconto / 1 - Acréscimo / 2 - Manual ( esta opção utiliza a collection de Produtos ) )
pIndiceTabela Decimal Índice da tabela de preço ( o valor é o mesmo pra desconto ou acréscimo, o sistema identifica pelo stTipoTabela )
pDescontoMaximo Decimal Nullable Quando utilizar stTipoTabela 1 ou 2, esse campo se aplica como o desconto máximo permitido
pComissao Decimal Nullable Valor da comissão que será aplicada nessa tabela de preço
vMinimoVenda Decimal Nullable Valor mínimo de venda por tabela de preço ( Configurável na configuração da empresa )
dInicial DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data inicial de funcionamento da tabela de preço
dFinal DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data final de funcionamento da tabela de preço
lTabelaPrecoItens Array Array da entidade de Produtos da Tabela Preço ( o produto tem que estar ativo no cadastro para ser adicionado )
stCampanhaRepresentante Byte 0 - não filtra / 1 - Filtra. ( Encaminhar os representantes na Array de Representantes na tabela de preço )
lTabelaPrecoPorRepresentante Array Array da entidade de Tabela de preço por Representante
stTabelaPrecoRepresentacao Byte 0 - não filtra / 1 - Filtra. ( Encaminhar os registros na Array de Representacao na tabela de preço )
lTabelaPrecoPorRepresentacao Array Array da entidade de Tabela de preço por Representação
stCampanhaCliente Byte 0 - não filtra / 1 - Filtra. ( Encaminhar os registros na Array de Clientes na tabela de preço )
lTabelaPrecoPorCliente Array Array da entidade de Tabela de preço por Cliente
stCampanhaClienteRamoAtividade Byte 0 - não filtra / 1 - Filtra. ( Encaminhar os registros na Array de Ramos de Atividade na tabela de preço )
lTabelaPrecoPorRamoCliente Array Array da entidade de Tabela de preço por Ramos de atividade
stCampanhaClienteUF Byte 0 - não filtra / 1 - Filtra. ( Encaminhar os registros na Array de Clientes por UF na tabela de preço )
lTabelaPrecoPorUfCliente Array Array da entidade de Tabela de preço por UF
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador
Estrutura da entidade Produto da Tabela Preço
Campo Tipo Descriçao
idTabelaPrecoItem Integer Identificador único do objeto
xMeuIdProduto String(200) Utilizamos o seu código de integração para buscar e adicionar os produtos da nossa base através do campo xMeuID da entidade de produto
pDescontoMaximo Decimal Nullable Porcentagem de desconto máximo por item
pComissao Decimal Nullable Porcentagem de comissão por item
pLucro Decimal Porcentagem de lucro do item
vVenda Decimal Valor de venda base sem impostos
pIpiVenda Decimal Porcentagem de Ipi de venda
pStVenda Decimal Porcentagem de St de Venda
vVendaComImpostos Decimal Valor de venda base com impostos
dtUltimaAlteracao DateTime(yyyy-mm-dd T HH:mm:ss) Nullable Data de última alteração
bExcluir Boolean Caso venha como true, o registro será excluído
Estrutura da entidade Tabela Preço por representante
Campo Tipo Descriçao
idTabelaPrecoRepresentantes Integer Identificador único do objeto
xNomeRepresentante String(200) Nome do vendedor
bExcluir Boolean Caso venha como true, o registro será excluído
Estrutura da entidade Tabela Preço por cliente
Campo Tipo Descriçao
idTabelaPrecoClientes Integer Identificador único do objeto
xRazaoSocialCliente String(200) Nome do cliente
bExcluir Boolean Caso venha como true, o registro será excluído
Estrutura da entidade Tabela Preço por Representação
Campo Tipo Descriçao
idTabelaPrecoRepresentacoes Integer Identificador único do objeto
xRepresentacao String(200) Razão Social da representação
bExcluir Boolean Caso venha como true, o registro será excluído
Estrutura da entidade Tabela Preço por Ramo de atividade de cliente
Campo Tipo Descriçao
idTabelaPrecoRamoAtividadeCliente Integer Identificador único do objeto
xRamoAtividade String(200) Ramo de atividade do cliente
bExcluir Boolean Caso venha como true, o registro será excluído
Estrutura da entidade Tabela Preço por UF cliente
Campo Tipo Descriçao
idTabelaPrecoUfCliente Integer Identificador único do objeto
xUF String(200) UF do cliente
bExcluir Boolean Caso venha como true, o registro será excluído

Unidades de medida

Unidades de medida são cadastros vinculados ao produto, possuindo também campo de casas decimais.

URL Get: https://apidata.pedidoeletronico.com/api/UnidadeMedida/ObterRegistros/pagina/quantidadeRegistros/dtUltimaAlteracao

URL Get: https://apidata.pedidoeletronico.com/api/UnidadeMedida/ObterRegistro/id

URL Post/Put: https://apidata.pedidoeletronico.com/api/UnidadeMedida/Post

Estrutura para GET e POST:
Campo Tipo Descriçao
idUnidadeMedida Integer Identificador único do objeto
xUnidadeMedida String(25) Descrição da unidade de medida
nCasasDecimais Integer Número de casas decimais, máximo 5
xSigla String(2) Sigla da unidade de medida, ex: "KG", "UN"
stAtivo boolean true - Cadastro Ativo / false - Cadastro inativo
xMeuID String(200) ID do registro com base no banco de dados do integrador

Quer ser um desenvolvedor em nosso time?

O pedidoeletronico.com está a procura de talentos

Venha fazer parte, encaminhe seu currículo em nosso site ou através do nosso e-mail desenvolvimento@pedidoeletronico.com e contate-nos para mais informações.