DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Objetivo

Esse método tem como objetivo Buscar uma ou mais compras de Vale Pedágio.


Observações Importantes

  1. Não é possível realizar rajadas para esse método, a TARGET limita 50 requisições por minuto, aconselhamos requisições por demanda, caso o limite de 50 requisições seja ultrapassado, iremos bloquear as requisições apenas para o método que ultrapassou o limite durante 5 minutos.
  2. A busca por período só retornará as compras realizadas no máximo nos últimos 90 dias.


Request

BuscaCompraValePedagioRequest
CampoTipoObrigatórioDescriçãoObservação
1QuantidadeItensPorPaginaintSimQuantidade de itens por página a serem retornadas.O máximo são 99 itens por página
2NumeroPaginaintSimNumero da pagina da lista a ser retornada.N/A
3IdModoCompraValePedagiointSimInforma se deseja buscar modos de compra específicos.

1= Cartão
2= Sem Parar

3= Veloe

4IdStatusValePedagiointNãoStatus das compras a serem buscadas.1= Aguardando
2= Confirmada
3= Cancelada
5DataInicioPeriodoDatetime (YYYY-MM-DD)NãoData de Início das compras a serem buscadas.Exemplo: (2018-08-20T10:05:33)
6DataFimPeriodoDatetime (YYYY-MM-DD)NãoData Fim das compras a serem buscadas.Exemplo: (2018-08-20T10:05:33)
7IdCompraValePedagiointNãoID de transação emitido no momento da compra.N/A
8IdIntegradorintNãoId do IntegradorId de controle do Integrador.
9TipoBuscaUnitariaintNãoTipo Busca Unitária

1= PorIdEntidade (IdCompraValePedagio)

2= PorIdIntegrador (IdIntegrador)

Response

BuscaCompraValePedagioResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponseNãoRetorna o ErroNulo em caso de sucesso
2TipoComprastringSimTipo da CompraN/A
3IdCompraintSimId da CompraN/A
4DataHoraCompraDatetime (YYYY-MM-DD)SimData e Hora da Compra.Exemplo: (2018-08-20T10:05:33)
5DataHoraCargaConfirmacaoDatetime (YYYY-MM-DD)NãoData e Hora da confirmação da carga.Exemplo: (2018-08-20T10:05:33)
6TagOuCartaostringSimTAG ou CartãoN/A
7ValordecimalSimValor da CompraN/A
8CIOTstringNãoNúmero do CIOT, caso tenha sido comprado pode dentro do CIOT.N/A
9Varejobool (true || false)SimCaso tenha sido comprado de forma avulsa.N/A
10NomePortadorstringSimNome do Portador do Cartão.N/A
11OrigemComprastringSimSe foi feito fia portal ou integração WS.N/A
12PodeEmitirRecibobool (true || false)SimSe está pronto para emissão de recibo.N/A
13PodeCarregarbool (true || false)SimSe está pronto para ser carregado.N/A
14IdStatusCompraValePedagiointNãoStatus da Compra de Vale Pedágio1= Aguardando
2= Confirmada
3= Cancelada
15OrigemCargastringNãoLocal de onde a carga foi feita.N/A
16IdOperacaoTransporteintNãoID da viagem caso tenha sido comprado pode dentro do CIOT.N/A
17DocumentoRelacionadostringNãoNúmero de algum documento relacionado à compra.N/A
18NomeFantasiastringNãoNome Fantasia do comprador em caso de CNPJ.N/A
19CPFCondutorstringNãoCPF do Motorista portador.N/A
20PodeCancelarComprabool (true || false)Sim

Se ainda está apto para cancelamento.

No caso, se ainda não foi carregado.

N/A
21UsuarioCompradorstringSimUsuário que realizou a compra do VP. Em caso de integração será utilizado o usuário de WS do cliente.N/A
22NomeRotastringSimNome da Rota utilizada para definir o custo.N/A
23IdRotaintNãoID da Rota utilizada para definir o custo.N/A
24Simplesbool (true || false)NãoServe para definir se a compra a ser registrada é a completa, com mais campos obrigatórios para cadastro, ou simples, com uma quantidade menor de campos a serem informados obrigatoriamente.N/A
25NumeroRecibostringNãoNúmero do Recibo do Vale PedágioN/A
26IdIntegradorstringNãoId IntegradorN/A
27SaldoAnteriorCartaodecimalNãoSaldo Anterior do CartãoN/A
28SaldoPosteriorCartaodecimalNãoSaldo Posterior do CartãoN/A
29ValorCarregadoCartaodecimalNãoValor Carregado no CartãoN/A
ResultadoPaginadoResponse
CampoTipoObrigatórioDescriçãoObservação
1ErroErroResponse - stringNãoRetorna o ErroNULO em caso de sucesso
2ItensN/AN/AItensN/A
3NumeroPaginaintSimNúmero da PáginaN/A
4QuantidadeItensPorPaginaintSimQuantidade de Itens por PáginaN/A
5QuantidadeTotalItensintSimQuantidade Total de ItensN/A
6QuantidadeTotalPaginasintSimQuantidade Total de PáginasN/A

Método

Abaixo, segue o método - 'BuscaCompraValePedagioRequest'.

BuscaCompraValePedagioRequest
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:BuscarCompraValePedagio>
         <tms:auth>
            <tms:Usuario>?</tms:Usuario>
            <tms:Senha>?</tms:Senha>
            <tms:Token>?</tms:Token>
         </tms:auth>
         <tms:buscaCompraValePedagio>
            <tms:IdStatusValePedagio>?</tms:IdStatusValePedagio>
            <tms:QuantidadeItensPorPagina>?</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>?</tms:NumeroPagina>
            <tms:IdModoCompraValePedagio>?</tms:IdModoCompraValePedagio>
            <tms:DataInicioPeriodo>?</tms:DataInicioPeriodo>
            <tms:DataFimPeriodo>?</tms:DataFimPeriodo>
            <tms:IdCompraValePedagio>?</tms:IdCompraValePedagio>
            <tms:IdIntegrador>?</tms:IdIntegrador>
            <tms:TipoBuscaUnitaria>?</tms:TipoBuscaUnitaria>
         </tms:buscaCompraValePedagio>
      </tms:BuscarCompraValePedagio>
   </soapenv:Body>
</soapenv:Envelope>

Buscar Compra Vale Pedágio

Abaixo, segue exemplo do método Buscar Compra Vale Pedágio.

BuscaCompraValePedagioRequest
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tms="http://tmsfrete.v2.targetmp.com.br" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header/>
   <soapenv:Body>
      <tms:BuscarCompraValePedagio>
         <tms:auth>
            <tms:Usuario>tms.exemplo</tms:Usuario>
            <tms:Senha>v0hXPrwerKblaBs=</tms:Senha>
            <tms:Token i:nil="true" />
         </tms:auth>
         <tms:buscaCompraValePedagio>
            <tms:IdStatusValePedagio i:nil="true" />
            <tms:QuantidadeItensPorPagina>1</tms:QuantidadeItensPorPagina>
            <tms:NumeroPagina>1</tms:NumeroPagina>
            <tms:IdModoCompraValePedagio>2</tms:IdModoCompraValePedagio>
            <tms:DataInicioPeriodo i:nil="true" />
            <tms:DataFimPeriodo i:nil="true" />
            <tms:IdCompraValePedagio>178130</tms:IdCompraValePedagio>
            <tms:IdIntegrador i:nil="true" />
            <tms:TipoBuscaUnitaria i:nil="true" />
         </tms:buscaCompraValePedagio>
      </tms:BuscarCompraValePedagio>
   </soapenv:Body>
</soapenv:Envelope>
                

            

Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://tmsfrete.v2.targetmp.com.br/FreteTMSService/BuscarCompraValePedagioResponse</Action>
  </s:Header>
  <s:Body>
    <BuscarCompraValePedagioResponse xmlns="http://tmsfrete.v2.targetmp.com.br">
      <BuscarCompraValePedagioResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Erro i:nil="true" />
        <Itens>
          <BuscaCompraValePedagioResponse>
            <Erro i:nil="true" />
            <TipoCompra>ViaFacil</TipoCompra>
            <IdCompra>178130</IdCompra>
            <DataHoraCompra>2018-08-29T09:53:38.72</DataHoraCompra>
            <DataHoraCargaConfirmacao>2018-08-29T10:53:38.72</DataHoraCargaConfirmacao>
            <TagOuCartao>0710349620</TagOuCartao>
            <Valor>65.60</Valor>
            <CIOT>N/A</CIOT>
            <Varejo>true</Varejo>
            <NomePortador i:nil="true" />
            <OrigemCompra i:nil="true" />
            <PodeEmitirRecibo>false</PodeEmitirRecibo>
            <PodeCarregar>true</PodeCarregar>
            <IdStatusCompraValePedagio>2</IdStatusCompraValePedagio>
            <OrigemCarga i:nil="true" />
            <IdOperacaoTransporte i:nil="true" />
            <DocumentoRelacionado i:nil="true" />
            <NomeFantasia>ADIMAX</NomeFantasia>
            <CPFCondutor i:nil="true" />
            <PodeCancelarCompra>true</PodeCancelarCompra>
            <UsuarioComprador>adimax.tms</UsuarioComprador>
            <NomeRota>TOCO-CAMPINAS-PAULINIA</NomeRota>
            <IdRota>37161</IdRota>
            <Simples i:nil="true" />
            <NumeroRecibo>000000024234463</NumeroRecibo>
            <IdIntegrador>37187</IdIntegrador>
            <SaldoAnteriorCartao>0.00</SaldoAnteriorCartao>
            <SaldoPosteriorCartao>65.60</SaldoPosteriorCartao>
            <ValorCarregadoCartao>65.60</ValorCarregadoCartao>
          </BuscaCompraValePedagioResponse>
        </Itens>
        <NumeroPagina>1</NumeroPagina>
        <QuantidadeItensPorPagina>20</QuantidadeItensPorPagina>
        <QuantidadeTotalItens>1</QuantidadeTotalItens>
        <QuantidadeTotalPaginas>1</QuantidadeTotalPaginas>
      </BuscarCompraValePedagioResult>
    </BuscarCompraValePedagioResponse>
  </s:Body>
</s:Envelope>
  • No labels