APIs Logistica - Integração Coleta Entrega - Entregas

Objetivo

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

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:

Integração

Os dados integrados são:

API	Referência Winthor	Tipo(Tamanho)	Observacao
Entrega
friendlyId	pcnfsaid.numtransvenda	VARCHAR2(60)
externalId	pcnfsaid.numtransvenda	VARCHAR2(40)
documento	pcnfsaid.numnota	DATE
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	pcnfsaid.totpeso	NUMBER(18,6)
cubagemTotal	pcnfsaid.totvolume	NUMBER(12)
valorTotal	pcnfsaid.vltotal	NUMBER(12,2)
quantidadeTotalVolumes	pcnfsaid.numvolume	VARCHAR2(20)
observacao	pcnfsaid.obs	VARCHAR2(255)

EnderecoEntrega
API	Referência Winthor	Tipo(Tamanho)	Observacao
clienteId	pcintegracaodepara.idexterno		Para a tabela com valor PCCLIENT e campo CGCENT no qual corresponde ao CGCENT sem pontos e tracos da PCCLIENT.
localidadeId	pcintegracaodepara.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 entregas para integrar:

URI

method: 'GET',
url: '/logistica/apis/v1/entregas/buscar'

Exemplo Retorno:

Exemplo Retorno

[
	 {
		"friendlyId": "string",
		"externalId": "string",
		"documento": "string",
		"unidadeOperacionalId": "string",
		"unidadeCadastroId": "string",
		"enderecoDestino": {
			"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/entregas/salvar-id-coleta-entrega'

Body

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

Requisição para buscar entregas já integradas:

URI

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

Exemplo Retorno

[
	{
		"numTransVenda": "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/entregas/salvar-retorno-coleta-entrega'

Body

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

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

URI

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

Exemplo Retorno:

Exemplo Retorno

[
	{
		"numTransVenda": "string"
	}
]

Páginas filhas

APIs Logistica - Integração Coleta Entrega - Entregas

Objetivo

Pré-Requisitos e Restrições

Integração