Web service com.senior.g5.co.mcm.ven.frete
Este web service é utilizado na solução de integração do ERP (Gestão Empresarial | ERP) com o Gestão de Fretes.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_mcm_ven_frete?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mcm_ven_frete?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mcm_ven_frete?wsdl
Porta(s)
- ExportarDadosCalculoFrete
- ExportarNotaFiscal
- ExportarPedidoCancelado
- ImportarDadosCalculoFrete
- TrocarTransportadora
ExportarDadosCalculoFrete
Para exportação dos dados para integração com o TMS Embarcador dos pedidos e notas fiscais eletrônicas de venda que possuem pendência no processo "TMS - Dados de cálculo do frete".
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarDadosCalculoFrete> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <SigInt>String</SigInt> </parameters> </ser:ExportarDadosCalculoFrete> </soapenv:Body> </soapenv:Envelope> ```
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
CodEmp | Opcional | Integer | Number(004) - Código da empresa |
CodFil | Opcional | Integer | Number(005) - Código da filial |
SigInt | Opcional | String | String(015) - Identificação do sistema integrado |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarDadosCalculoFreteResponse> <result> <LinhaDados> <SeqInt>Integer</SeqInt> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <CodCli>Integer</CodCli> <TmsPed>Integer</TmsPed> <VlrLiq>Double</VlrLiq> <PesRea>Double</PesRea> <PesCub>Double</PesCub> <QtdVol>Integer</QtdVol> <CodTra>Integer</CodTra> <TipEnt>Integer</TipEnt> <CifFob>String</CifFob> <NomCli>String</NomCli> <CgcCpf>String</CgcCpf> <NumRge>String</NumRge> <InsEst>String</InsEst> <FonEnt>String</FonEnt> <CelEnt>String</CelEnt> <EmaEnt>String</EmaEnt> <CepEnt>Integer</CepEnt> <EndEnt>String</EndEnt> <NenEnt>String</NenEnt> <BaiEnt>String</BaiEnt> <CidEnt>String</CidEnt> <CodRai>Integer</CodRai> <EstEnt>String</EstEnt> <ObsEnt>String</ObsEnt> <TriIcm>String</TriIcm> </LinhaDados> <FinalizaramRegistros>String</FinalizaramRegistros> <TipoRetorno>Integer</TipoRetorno> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ExportarDadosCalculoFreteResponse> </soapenv:Body> </soapenv:Envelope> ```
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
LinhaDados | Opcional | Set | Contém os dados de um pedido de venda ou nota fiscal eletrônica que deve ter seu frete calculado pelo TMS Embarcador |
LinhaDados.SeqInt | Opcional | Integer | Number(009) - Número sequencial dos registros de integração |
LinhaDados.CodEmp | Opcional | Integer | Number(004) - Código da empresa |
LinhaDados.CodFil | Opcional | Integer | Number(005) - Código da filial |
LinhaDados.CodCli | Opcional | Integer | Number(004) - Código do cliente |
LinhaDados.TmsPed | Opcional | Integer | Number(009) - Número do pedido no TMS Embarcador |
LinhaDados.VlrLiq | Opcional | Double | Number(015,2) - Valor líquido do pedido/nota fiscal |
LinhaDados.PesRea | Opcional | Double | Number(015,2) - Peso bruto do pedido/nota fiscal |
LinhaDados.PesCub | Opcional | Double | Number(015,2) - Peso cubado do pedido/nota fiscal |
LinhaDados.QtdVol | Opcional | Integer | Number(003) - Quantidade de volume formado pelo pedido (Enviado fixo 1) |
LinhaDados.CodTra | Opcional | Integer | Number(009) - Número da transportadora do pedido/nota fiscal |
LinhaDados.TipEnt | Opcional | Integer | Number(001) - Tipo de entrega - Lista: 1 = Normal, 2 = Agendada, 3 = Emergencial |
LinhaDados.CifFob | Opcional | String | String(003) - Indicativo se o frete é CIF ou FOB (CIF = Por conta do cliente, FOB = Por conta do destinatário) |
LinhaDados.NomCli | Opcional | String | String(100) - Nome do cliente |
LinhaDados.CgcCpf | Opcional | String | Number(014) - Número do CNPJ ou CPF do cliente |
LinhaDados.NumRge | Opcional | String | Number(010) - Número do RG do cliente (se for pessoa física) |
LinhaDados.InsEst | Opcional | String | String(025) - Inscrição estadual do cliente |
LinhaDados.FonEnt | Opcional | String | String(020) - Número do telefone de entrega |
LinhaDados.CelEnt | Opcional | String | String(020) - Número do telefone celular do cliente |
LinhaDados.EmaEnt | Opcional | String | String(100) - Endereço eletrônico (E-mail) do cliente |
LinhaDados.CepEnt | Opcional | Integer | Number(008) - CEP do endereço de entrega do cliente |
LinhaDados.EndEnt | Opcional | String | String(100) - Endereço de entrega do cliente |
LinhaDados.NenEnt | Opcional | String | String(060) - Número do endereço de entrega do cliente |
LinhaDados.BaiEnt | Opcional | String | String(075) - Bairro de Entrega do cliente |
LinhaDados.CidEnt | Opcional | String | String(060) - Cidade do endereço de entrega do cliente |
LinhaDados.CodRai | Opcional | Integer | Number(007) - Código da cidade para o RAIS |
LinhaDados.EstEnt | Opcional | String | String(002) - Estado do endereço de entrega do cliente |
LinhaDados.ObsEnt | Opcional | String | String(250) - Observação para a entrega |
LinhaDados.TriIcm | Opcional | String | String(001) - Indicativo se o cliente tem tributação de ICMS ou não - Lista: S = Sim, N = Não |
FinalizaramRegistros | Opcional | String | String(001) - Indicativo se há mais registros para serem exportados - Lista: S = Sim, N = Não |
TipoRetorno | Opcional | Integer | Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
MensagemRetorno | Opcional | String | String(250) - Mensagem de Retorno de Processamento |
erroExecucao | Opcional | String | Erro de execução |
ExportarNotaFiscal
Para exportação dos dados de uma NF-e logo após sua autorização indicando ao TMS Embarcador que o pedido foi faturado. Deve exportar as notas fiscais eletrônicas autorizadas quando o processo "TMS - Faturamento NF saída" estiver habilitado para ser integrado.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarNotaFiscal> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <SigInt>String</SigInt> </parameters> </ser:ExportarNotaFiscal> </soapenv:Body> </soapenv:Envelope> ```
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
CodEmp | Opcional | Integer | Number(004) - Código da empresa |
CodFil | Opcional | Integer | Number(005) - Código da filial |
SigInt | Opcional | String | String(015) - Identificação do sistema integrado |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarNotaFiscalResponse> <result> <TipoRetorno>Integer</TipoRetorno> <MensagemRetorno>String</MensagemRetorno> <LinhaDados> <SeqInt>String</SeqInt> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <CodCli>Integer</CodCli> <TmsPed>String</TmsPed> <NumNfv>Integer</NumNfv> <SerNfv>String</SerNfv> <DatEmi>String</DatEmi> <ChvAcs>String</ChvAcs> <QtdVol>Integer</QtdVol> <CFOP>String</CFOP> </LinhaDados> <erroExecucao>String</erroExecucao> </result> </ser:ExportarNotaFiscalResponse> </soapenv:Body> </soapenv:Envelope>
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
TipoRetorno | Opcional | Integer | Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
MensagemRetorno | Opcional | String | String(250) - Mensagem de Retorno de Processamento |
LinhaDados | Opcional | Set | Contém os dados para exportação da Nota Fiscal Eletrônica (NF-e). |
LinhaDados.SeqInt | Opcional | String | Number(009) - Número sequencial dos registros de integração |
LinhaDados.CodEmp | Opcional | Integer | Number(004) - Código da empresa |
LinhaDados.CodFil | Opcional | Integer | Number(005) - Código da filial |
LinhaDados.CodCli | Opcional | Integer | Number(004) - Código do cliente |
LinhaDados.TmsPed | Opcional | String | Number(009) - Número do pedido no TMS Embarcador |
LinhaDados.NumNfv | Opcional | Integer | Number(009) - Número da nota fiscal |
LinhaDados.SerNfv | Opcional | String | String(003) - Série da nota fiscal |
LinhaDados.DatEmi | Opcional | String | String(019) - Data de emissão da nota fiscal |
| LinhaDados.ChvAcs | Opcional | String | String(044) - Chave de acesso da Nota Fiscal (DANFE) |
LinhaDados.QtdVol | Opcional | Integer | Number(003) - Quantidade de Volumes (Envia 1 caso não tenha sido preenchido na tela de embalagens da nota) |
LinhaDados.CFOP | Opcional | String | String(004) - CFOP Predominante da NF-e |
erroExecucao | Opcional | String | Erro de execução |
ExportarPedidoCancelado
Para exportação do cancelamento de um pedido ou de uma NF-e de venda ao sistema TMS Embarcador para que o TMS Embarcador cancele o cálculo do frete e não acione a transportadora. Deve exportar o cancelamento quando o processo "TMS - Cancelamento de pedido" estiver habilitado para ser integrado.
Necessita autenticação: Sim.
Situação da versão: Atual
Versão: 1.
Requisição:
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarPedidoCancelado> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <SigInt>String</SigInt> <QuantidadeRegistros>Integer</QuantidadeRegistros> </parameters> </ser:ExportarPedidoCancelado> </soapenv:Body> </soapenv:Envelope> ```
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
CodEmp | Opcional | Integer | Number(004) - Código da empresa |
CodFil | Opcional | Integer | Number(005) - Código da filial |
SigInt | Opcional | String | String(015) - Identificação do sistema integrado |
QuantidadeRegistros | Opcional | Integer | Number(009) - Número de registros exportados |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarPedidoCanceladoResponse> <result> <LinhaDados> <SeqInt>String</SeqInt> <CodEmp>Integer</CodEmp> <CodCli>Integer</CodCli> <MotCan>String</MotCan> <CodFil>Integer</CodFil> <TmsPed>String</TmsPed> </LinhaDados> <TipoRetorno>Integer</TipoRetorno> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ExportarPedidoCanceladoResponse> </soapenv:Body> </soapenv:Envelope> ```
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
LinhaDados | Opcional | Set | Contém os dados para cancelamento de um pedido no TMS Embarcador |
LinhaDados.SeqInt | Opcional | String | Number(009) - Número sequencial dos registros de integração |
LinhaDados.CodEmp | Opcional | Integer | Number(004) - Código da empresa |
LinhaDados.CodCli | Opcional | Integer | Number(004) - Código do cliente |
LinhaDados.MotCan | Opcional | String | String(500) - Descrição do motivo de cancelamento do pedido |
LinhaDados.CodFil | Opcional | Integer | Number(005) - Código da filial |
LinhaDados.TmsPed | Opcional | String | Number(009) - Número do pedido no TMS Embarcador |
TipoRetorno | Opcional | Integer | Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
MensagemRetorno | Opcional | String | String(250) - Mensagem de Retorno de Processamento |
erroExecucao | Opcional | String | Erro de execução |
ImportarDadosCalculoFrete
Para importação dos dados de um frete calculado pelo Gestão de Fretes para um pedido ou um NF-e de venda. Para que o frete calculado seja importado o processo de "TMS - Dados de cálculo do frete" deve estar habilitado.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ImportarDadosCalculoFrete> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <LinhaDados> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <CodCli>Integer</CodCli> <TmsPed>String</TmsPed> <NumTra>Integer</NumTra> <TipEnt>Integer</TipEnt> <QtdDia>Integer</QtdDia> <ValFre>Double</ValFre> <PesPed>Double</PesPed> </LinhaDados> </parameters> </ser:ImportarDadosCalculoFrete> </soapenv:Body> </soapenv:Envelope> ```
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
LinhaDados | Opcional | Set | Contém os dados de um frete calculado pelo TMS Embarcador para um pedido de venda ou nota fiscal eletrônica |
LinhaDados.CodEmp | Opcional | Integer | Number(004) - Código da empresa |
LinhaDados.CodFil | Opcional | Integer | Number(005) - Código da filial |
LinhaDados.CodCli | Opcional | Integer | Number(004) - Código do cliente |
LinhaDados.TmsPed | Opcional | String | Number(009) - Número do pedido no TMS Embarcador |
LinhaDados.NumTra | Opcional | Integer | Number(009) - Número da transportadora |
LinhaDados.TipEnt | Opcional | Integer | Number(001) - Tipo de entrega - Lista: 1 = Normal, 2 = Agendada, 3 = Emergencial |
LinhaDados.QtdDia | Opcional | Integer | Number(004) - Quantidade de dias para entrega a partir da data atual |
LinhaDados.ValFre | Opcional | Double | Number(015,2) - Valor do frete destacado |
LinhaDados.PesPed | Opcional | Double | Number(015,2) - Peso real do pedido |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ImportarDadosCalculoFreteResponse> <result> <TipoRetorno>Integer</TipoRetorno> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:ImportarDadosCalculoFreteResponse> </soapenv:Body> </soapenv:Envelope> ```
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
TipoRetorno | Opcional | Integer | Number(001) - Indicativo do tipo de retorno da solicitação - Lista: 1 = Processado com sucesso, 2 = Processado com erro |
MensagemRetorno | String | Opcional | String(250) - Mensagem de retorno do processamento |
erroExecucao | String | Opcional | Erro de execução |
TrocarTransportadora
Para importação dos dados enviados pelo TMS Embarcador sobre a alteração de transportadora de um pedido ou NF-e de venda.
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:TrocarTransportadora> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <LinhaDados> <CodEmp>Integer</CodEmp> <CodFil>Integer</CodFil> <CodCli>Integer</CodCli> <TmsPed>String</TmsPed> <CodTra>Integer</CodTra> <QtdDia>Integer</QtdDia> <VlrFre>Double</VlrFre> <IdOrig>String</IdOrig> </LinhaDados> </parameters> </ser:TrocarTransportadora> </soapenv:Body> </soapenv:Envelope> ```
Parâmetros da requisição:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
LinhaDados | Opcional | Set | Contém os dados importados do TMS Embarcador para alteração de transportadora. |
LinhaDados.CodEmp | Opcional | Integer | Number(004) - Código da empresa |
LinhaDados.CodFil | Opcional | Integer | Number(005) - Código da filial |
LinhaDados.CodCli | Opcional | Integer | Number(004) - Código do cliente |
LinhaDados.TmsPed | Opcional | String | Number(009) - Número do pedido no TMS Embarcador |
LinhaDados.CodTra | Opcional | Integer | Number(009) - Número da transportadora |
LinhaDados.QtdDia | Opcional | Integer | Number(004) - Quantidade de dias para entrega a partir da data atual |
LinhaDados.VlrFre | Opcional | Double | Number(015,2) - Valor do frete destacado |
LinhaDados.IdOrig | Opcional | String | Number(009) - Identificador do registro para mapear com o retorno |
Resposta:
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
```xml <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:TrocarTransportadoraResponse> <result> <TipoRetorno>Integer</TipoRetorno> <Retorno> <TmsPed>String</TmsPed> <TipRet>Integer</TipRet> <MsgRet>String</MsgRet> <IdOrig>String</IdOrig> </Retorno> <MensagemRetorno>String</MensagemRetorno> <erroExecucao>String</erroExecucao> </result> </ser:TrocarTransportadoraResponse> </soapenv:Body> </soapenv:Envelope> ```
Atributos da resposta:
Nome | Preenchimento | Tipo | Descrição |
---|---|---|---|
TipoRetorno | Opcional | Integer | Number(001) - Indicativo do tipo de retorno da solicitação - Lista: 1 = Processado com sucesso, 2 = Processado com erro |
Retorno | Opcional | Set | Contém os dados de retorno de um registro da requisição |
Retorno.TmsPed | Opcional | String | Number(009) - Número do pedido no TMS Embarcador |
Retorno.TipRet | Opcional | Integer | Number(001) - Indicativo do tipo de retorno do registro - Lista: 1 = Processado com sucesso, 2 = Processado com erro |
Retorno.MsgRet | Opcional | String | String(250) - Mensagem de retorno do registro |
Retorno.IdOrig | Opcional | String | Number(009) - Identificador do registro mapeado na requisição |
MensagemRetorno | Opcional | String | String(250) - Mensagem de retorno do processamento |
erroExecucao | Opcional | String | Erro de execução |