TOTVS Distribuição e Varejo - linha Winthor

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

Objetivo

Este documento tem como objetivo explicar o funcionamento da integração do Cliente.

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

  • Para realizar o cadastro de clientes no WinThor, acesse o link abaixo:

Como cadastrar cliente na rotina 302?


Integração


Os dados integrados são: 

Cliente


APIReferência Winthor Tipo(Tamanho)Observacao
nomepcclient.clienteVARCHAR2(60)
nomeFantasiapcclient.fantasiaVARCHAR2(40)
dataAtualizacaopcclient.dtultalterDATE



documentoIdentificacao


APIReferência Winthor Tipo(Tamanho)Observacao
numeropcclient.cgcentVARCHAR2(18)
enderecos


APIReferência Winthor Tipo(Tamanho)Observacao
numeropcclient.numeroent / pcclientendent.numeroentVARCHAR2(6)
complementopcclient.complementoent / pcclientendent.complementoentVARCHAR2(80)
descricaoN/A
Sera utilizado Endereco Principal quando endereco principal , trazendo os dados da pcclient e Endereco Alternativo quando nao for endereco principal, trazendo os dados da pcclientendent.
tipoEnderecoN/A
PRINCIPAL utilizado nos enderecos principais e DEPOSITO utilizado nos enderecos alternativos.
telefonepcclient.telentVARCHAR2(13)
localidade


APIReferência Winthor Tipo(Tamanho)Observacao
tipoLocalidadeN/A
Enum do tipo: PAIS, ESTADO, MUNICIPIO, BAIRRO, LOGRADOURO, CODIGO_POSTAL, NUMERO_LOGRADOURO


Neste componente todos possuem nomeCurto e nomeLongo, serao separados pelo tipoComponente que e o mesmo ENUM do tipoLocalidade citado acima assim como retornara os dados a pcclient em caso de endereco principal e pcclientendent em caso de alternativo no endereco.

componentesEnderecos


nomeCurto/nomeLongoReferência Winthor Tipo(Tamanho)Observacao
ESTADOpcclient.estent / pcclientendent.estentVARCHAR2(2)
MUNICIPIOpcclient.municent / pcclientendent.municentVARCHAR2(15)
BAIRROpcclient.bairroent/ pcclientendent.bairroentVARCHAR2(40)
LOGRADOUROpcclient.enderent/ pcclientendent.enderentVARCHAR2(40)
CODIGO_POSTALpcclient.cepent/ pcclientendent.cepentVARCHAR2(9)
NUMERO_LOGRADOUROpcclient.numeroent/ pcclientendent.numeroentVARCHAR2(6)

Requisição para buscar clientes não integrados:

URI - Cadastrar Cliente
method: 'GET',
url: '/logistica/apis/v1/clientes/buscar'


Exemplo Retorno:

Body
[
	{
		"nome": "string",
		"nomeFantasia": "string",
		"documentoIdentificacao": {
			"numero": "string"
		},
		"horarioFuncionamento": [
			{
				"diasSemana": "string",
				"horarioInicio": "HH:mm",
				"horarioFim": "HH:mm",
				"tipo": "string"
			}
		],
		"enderecos": [
			{
				"numero": "string",
				"complemento": "string",
				"descricao": "string",
				"tipoEndereco": "PRINCIPAL|DEPOSITO",
				"telefone": "string",
				"localidade": {
					"tipoLocalidade": "PAIS|ESTADO|MUNICIPIO|BAIRRO|LOGRADOURO|CODIGO_POSTAL|NUMERO_LOGRADOURO",
					"componentesEnderecos": [
						{
							"nomeLongo": "string",
							"nomeCurto": "string",
							"tipoComponente": "PAIS|ESTADO|MUNICIPIO|BAIRRO|LOGRADOURO|CODIGO_POSTAL|NUMERO_LOGRADOURO"
						}
					]
				}
			}
		],
		"dataAtualizacao": "yyyy-MM-dd'T'HH:mm:ss"
	}
]



Requisição para buscar clientes já integrados para atualização:

URI Parameters - Listar um único cadastro
method: 'GET',
url: '/logistica/apis/v1/clientes/buscar-atualizar'

*PARAMS:*
dataUltimaAlteracao: date - Informe a data de última alteração para trazer clientes alterados apos esta data.


Exemplo Retorno:

URI Parameters - Listar todos cadastros
[
	{
		"nome": "string",
		"nomeFantasia": "string",
		"documentoIdentificacao": {
			"numero": "string"
		},
		"horarioFuncionamento": [
			{
				"diasSemana": "string",
				"horarioInicio": "HH:mm",
				"horarioFim": "HH:mm",
				"tipo": "string"
			}
		],
		"enderecos": [
			{
				"numero": "string",
				"complemento": "string",
				"descricao": "string",
				"tipoEndereco": "PRINCIPAL|DEPOSITO",
				"telefone": "string",
				"localidade": {
					"tipoLocalidade": "PAIS|ESTADO|MUNICIPIO|BAIRRO|LOGRADOURO|CODIGO_POSTAL|NUMERO_LOGRADOURO",
					"componentesEnderecos": [
						{
							"nomeLongo": "string",
							"nomeCurto": "string",
							"tipoComponente": "PAIS|ESTADO|MUNICIPIO|BAIRRO|LOGRADOURO|CODIGO_POSTAL|NUMERO_LOGRADOURO"
						}
					]
				}
			}
		],
		"dataAtualizacao": "yyyy-MM-dd'T'HH:mm:ss"
	}
]






  • Sem rótulos