TOTVS Distribuição e Varejo - linha Winthor

Páginas filhas
  • APIs Logistica - Integração Coleta Entrega - Coletas

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração de Coletas.

Pré-Requisitos e Restrições

  • Necessário a instalação do serviço winthor-logistica-apis. Para realizar a instalação desse serviço, segue link com as devidas explicações:

Comece por aqui -> Parametrizações WTA


Integração


Os dados integrados são: 

Coleta


APIReferência Winthor Tipo(Tamanho)Observacao

friendlyId

pcnfent.numtransentVARCHAR2(60)

externalId

pcnfent.numtransentVARCHAR2(40)

documento

pcnfent.numnotaDATE

unidadeOperacionalId

pcintegracaodepara.idexterno
Para a tabela com valor PCFILIAL e campo CODFILIAL no qual corresponde ao codfilial da PCNFENT.

unidadeCadastroId

pcintegracaodepara.idexterno
Para a tabela com valor PCFILIAL e campo CODFILIAL no qual corresponde ao codfilial da PCNFENT.

pesoTotalBruto

pcnfent.totpeso

cubagemTotal

pcnfent.numvol

valorTotal

pcnfent.vltotal

quantidadeTotalVolumes

pcnfent.numvolume

observacao

pcnfent.obs

EnderecoColeta


APIReferência Winthor Tipo(Tamanho)Observacao
clienteIdpcintegracaodepara.idexterno

Para a tabela com valor PCCLIENT e campo CGCENT no qual corresponde ao CGCENT sem pontos e tracos da PCCLIENT.

localidadeIdpcintegracaodepara.idexterno
Para a coluna com valor PCCLIENT|PCCLIENTENDENT e campo LOGRADOURO|NUMERO|CEP no qual corresponde a concatenacao dos campos ENDERENT, NUMEROENT E CEPENT com pipe(|).
complemento

pcclientendent.complementoent, pcclient.complementoent

VARCHAR2(80)


tipoEndereco

PRINCIPAL utilizado nos enderecos principais e DEPOSITO utilizado nos enderecos alternativos.



Requisição para buscar coletas para integrar:

URI
method: 'GET',
url: '/logistica/apis/v1/coletas/buscar'


Exemplo Retorno:

Exemplo Retorno
[
	 {
		"friendlyId": "string",
		"externalId": "string",
		"documento": "string",
		"unidadeOperacionalId": "string",
		"unidadeCadastroId": "string",
		"enderecoOrigem": {
			"clienteId": "string",
			"localidadeId": "string",
			"complemento": "string",
			"descricao": "string",
			"tipoEndereco": "string",
			"telefone": "string"
		},
		"pesoTotalBruto": "number",
		"cubagemTotal": "number",
		"valorTotal": "number",
		"quantidadeTotalVolumes": 0,
		"observacao": "string"
	}
]





Requisição para inserir o idExterno do coleta entrega na coleta.

URI
method: 'POST',
url: '/logistica/apis/v1/coletas/salvar-id-coleta-entrega'



Body
{
    "numTransEnt": "string",
    "idExterno": "string",
    "dataSituacao": "yyyy-MM-dd'T'HH:mm:ss"
}



Requisição para buscar coletas já integradas:

URI
method: 'GET',
url: '/logistica/apis/v1/coletas/buscar-integradas'



Exemplo Retorno
[
	{
		"numTransEnt": "string",
		"idColetaEntrega": "string",
		"dataUltimaAlteracao": "yyyy-MM-dd'T'HH:mm:ss"
	}
]



Requisição para inserir os dados recebidos do coleta entrega na coleta:

URI
method: 'POST',
url: '/logistica/apis/v1/coletas/salvar-retorno-coleta-entrega'



Body
{
    "idExterno": "string",
    "numTransEnt": "string",
    "situacao": "string",
    "dataUltimaAlteracao": "yyyy-MM-dd'T'HH:mm:ss"
}

Requisição para buscar coletas não integradas:

URI
method: 'GET',
url: '/logistica/apis/v1/coletas/buscar-nao-integradas'


Exemplo Retorno:

Exemplo Retorno
[
	{
		"numTransEnt": "string"
	}
]







  • Sem rótulos