{"info":{"_postman_id":"99a44af6-febd-4823-8971-a1383aba2ec6","name":"API - Engloba Sistemas","description":"
\n

Documentação das APIs disponíveis na Engloba Sistemas:

\n
\n
Calcular (cotação) de frete\nEnviar XML da NF-e, Arquivo Proceda, Arquivo Texto, JSON XML e etc. para a transportadora\nConsultar o rastreamento e os detalhes do pedido através da chave da NF-e\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9831556","collectionId":"99a44af6-febd-4823-8971-a1383aba2ec6","publishedId":"Szf6Yp9W","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"000000","highlight":"EF5B25"},"publishDate":"2020-04-22T20:02:14.000Z"},"item":[{"name":"Calcular (cotação) de frete","id":"bfedd570-1b7c-4e02-89e4-bd945108c6b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://englobasistemas.com.br/financeiro/api/fretes/calcularFrete?apikey={{apikey}}&local=BR&peso={{peso_total_real}}&peso_cubado={{peso_total_cubado}}&valor={{valor_total_pedido}}&cep={{cep_destino}}","description":"
\n

Através dessa API, o usuário poderá ter acesso ao valor do frete e o prazo de entrega para um determinado CEP.

\n
\n

Parâmetros para requisição

\n

Tabela descrevendo o atributo, tipo, obrigatoriedade e descrição com valor exemplo:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipoobrigatóriodescrição
apikeystringtruechave da API fornecida pela Engloba Sistemas
localstringtrueenviar BR para valores no padrão brasileiro ou EN para o padrão americano - exemplo: BR
pesodecimaltruepeso real total em KG dos produtos - exemplo: 0,50
peso_cubadodecimaltruepeso total em KG dos produtos - exemplo: 5,50
valordecimaltruevalor total dos produtos - exemplo: 1449,21
cepnumbertrueCEP onde o pedido será entregue ex: 07111-080
\n

Em caso de sucesso (status code: 200), a API retorna um JSON com os seguintes valores:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipodescrição
fretedecimalValor total do frete
prazointPrazo de entrega em dias
descricao_servicostringDescrição do serviço prestado que será prestado - exemplo: normal, expresso e etc.
transportadorastringTransportadora responsável pelo serviço
atendestringretorna uma string se atende o CEP sim ou não
sigla_base_destinostringSigla da base de destino que efetua a entrega final
data_previstadateData prevista para ser feita a entrega
peso_taxadodecimalPeso considerado para definição do frete
codigo_regra_calculo_freteintCódigo da regra de cálculo considera para o cálculo do frete
\n

Em caso de insucesso (status code: 500), a API retorna um JSON com os seguintes valores:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipodescrição
MessagestringExemplo de mensagem de erro: CEP inválido e etc
\n
","urlObject":{"protocol":"https","path":["financeiro","api","fretes","calcularFrete"],"host":["englobasistemas","com","br"],"query":[{"key":"apikey","value":"{{apikey}}"},{"key":"local","value":"BR"},{"key":"peso","value":"{{peso_total_real}}"},{"key":"peso_cubado","value":"{{peso_total_cubado}}"},{"key":"valor","value":"{{valor_total_pedido}}"},{"key":"cep","value":"{{cep_destino}}"}],"variable":[]}},"response":[],"_postman_id":"bfedd570-1b7c-4e02-89e4-bd945108c6b5"},{"name":"Enviar XML da NF-e, Arquivo Proceda, Arquivo Texto, JSON XML e etc. para a transportadora","id":"7b6938a1-1a72-437a-b232-a890ab8d0204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{{Colocar aqui o XML da NF-e}}"},"url":"https://englobasistemas.com.br/arquivos/api/GerarPedido/Gerar?apikey={{apikey}}","description":"
\n

Através dessa API, o usuário poderá enviar os XMLs das notas fiscais, conhecimentos, arquivo proceda, arquivos textos, JSON, XML e etc., esses arquivos deverão ter os dados do pedido que deverá ser entregue ou coletado pela transportadora

\n
\n

Parâmetros para requisição

\n

Tabela descrevendo o atributo, tipo, obrigatoriedade e descrição com valor exemplo:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipoobrigatóriodescrição
apikeystringtrueChave da API fornecida pela Engloba Sistemas
\n

** Enviar no corpo (BODY/RAW) da requisição o XML da NF-e, XML do CT-e, arquivo proceda, XML, JSON e etc **

\n

Em caso de sucesso (status code: 200), a API retorna uma string com o valor:

\n

true

\n

Em caso de insucesso (status code: 500), a API retorna um JSON, detalhes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipodescrição
MessagestringExemplo de mensagem de erro: Configuração não existe
\n
","urlObject":{"protocol":"https","path":["arquivos","api","GerarPedido","Gerar"],"host":["englobasistemas","com","br"],"query":[{"key":"apikey","value":"{{apikey}}"}],"variable":[]}},"response":[],"_postman_id":"7b6938a1-1a72-437a-b232-a890ab8d0204"},{"name":"Consultar o rastreamento e os detalhes do pedido através da chave da NF-e","id":"8ae65b9d-e5e1-4b0d-931f-569ecd8f561a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://englobasistemas.com.br/arquivos/api/PegarOcorrencias/RastreamentoChaveNfe?apikey={{apikey}}&chaveNfe={{chave_da_nfe}}","description":"
\n

Através dessa API, o usuário poderá consultar os detalhes de um pedido, rastreamento e comprovante de entrega

\n
\n

Parâmetros para requisição

\n

Tabela descrevendo o atributo, tipo, obrigatoriedade e descrição com valor exemplo:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipoobrigatóriodescrição
apikeystringtrueChave da API fornecida pela Engloba Sistemas
chaveNfestringtruechave da nota com 44 digitos
\n

Em caso de sucesso (status code: 200), a API retorna um JSON com a seguinte matriz:

\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipodescrição
codigointCódigo interno do pedido na Engloba Sistemas
numero_pedidostringNúmero do pedido do remetente
destinatariostringNome do destinatário
situacaostringSituação atual do pedido
conhecimentointNúmero do conhecimento
servicostringDescrição do serviço
remetentestringNome do remetente
pagadorstringTomador (pagador) do frete
ar_postagemstringNúmero dos Correios em caso de postagem
chavestringNúmero da chave do cliente
arquivo_processadostringNome do arquivo processado
contratostringNúmero do contrato
canal_vendastringCanal de vendas do remetente
canal_distribuicaostringCanal de distribuição do remetente
periodo_entregastringEm qual período o pedido deverá ser entregue (manhã, tarde, noite)
rotastringRota otimizada
valor_total_fretedecimalValor total do frete
base_destinostringBase de destino responsável pela entrega
sub_produtostringSubproduto do pedido
numero_clientestringNúmero do cliente
pedido_3stringNúmero do pedido 2 do remetente
no_prazo\"stringSe o pedido está no prazo sim ou não
data_previstastringData prevista para entrega/coleta
data_finalstringData da finalização do pedido
data_clientestringData do pedido
data_coletastringData do recebimento do pedido na transportadora
data_cadastrostringData do cadastro do pedido na Engloba Sistemas
data_envio_ctestringData da autorização do CT-e
chave_cte_anteriorstringChave do CT-e anterior, quando redespacho e subcontratação
frete_peso_documento_anteriorstringFrete do CT-e anterior, quando redespacho e subcontratação
edicao\"stringEdição do pedido
observacaostringObservação do pedido
ultima_ocorrenciastringÚltima ocorrência do pedido
lote_processamentostringLote de processamento na geração do pedido
qtde_chamadosintQtde. de chamados existentes para esse pedido
qtde_instrucoesintQtde. de instruções de entrega - coleta
chave_ctestringChave do CT-e
serie_conhecimentointSérie do conhecimento
cte_protocolo_autorizacaostringProtocolo de autorização do CT-e
data_averbacaostringData da averbação
retorno_averbacaostringRetorno da averbação
comprovante_entrega_digitalizadoboolComprovante de entrega digitalizado
empresastringNome da transportadora
\n
\n

|--|--|--|\n codigo |int| Código interno do rastreamento\n fk_remessa |int | Código do pedido\n data_cadastro |string | Data de cadastro da ocorrência\n local |string | Local onde foi lançado a ocorrência\n data_ocorrencia |int | Data efetiva da ocorrência\n usuario |string | Nome do usuário que lançou a ocorrência\n ocorrencia |string | Ocorrência \n ocorrencia_cliente |string | Ocorrência personalizada para o pedido\n codigo_ocorrencia |int | Código da ocorrência\n codigo_de_para |string | Código deXpara\n base_origem |string | Base de origem da ocorrência\n obs |string | Observação lançada

\n

Em caso de insucesso (status code: 500), a API retorna um JSON com os seguintes valores:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
atributotipodescrição
MessagestringExemplo de mensagem de erro: Apikey inválida
\n
","urlObject":{"protocol":"https","path":["arquivos","api","PegarOcorrencias","RastreamentoChaveNfe"],"host":["englobasistemas","com","br"],"query":[{"key":"apikey","value":"{{apikey}}"},{"key":"chaveNfe","value":"{{chave_da_nfe}}"}],"variable":[]}},"response":[],"_postman_id":"8ae65b9d-e5e1-4b0d-931f-569ecd8f561a"}],"event":[{"listen":"prerequest","script":{"id":"a6937a46-f2f2-4ce6-8d25-8311ecd41bff","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"393f934e-ad48-4ffd-a6c8-32a598c67f2d","type":"text/javascript","exec":[""]}}]}