Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Abaixo temos mais informações sobre cada EndPoint utilizado na comunicação com o ERP/Retaguarda.


Informações

O microserviço de controle está disponível na url

5.1 Compartilhamento

A API compartilhamento é de extrema importância para que o PDVSync saiba onde entregar as informações enviadas em todos as API´s, ou seja, através da composição dos dados da compartilhamento o PDVSync sabe quem é o dado enviado tem um ID Proprietário e este na compartilhamento tem quem são as lojas que devem receber as informações enviadas com um ID Proprietário.

...

                                  


CampoTipoTamanhoObrigatórioDescrição
idRetaguardaString100SimIdentificador do compartilhamento no ERP/Retaguarda
idProprietarioString100Sim

Código que identifica o proprietário da informação enviada para PDVSync.

Este código determina na estrutura da “Compartilhamento”, todas as lojas abaixo do ID Proprietário que deverão receber os dados enviados para o PDVSync.

nomeCompartilhamentoString100SimNome do compartilhamento que está sendo criado
nivelString2SimDefine o nível hierárquico da informação no compartilhamento que está sendo criado
idRetaguardaLojaString100SimIdentificador da loja no ERP/Retaguarda
idInquilinoString100SimIdentificador da estrutura de redes, franquias,
centrais 
centrais e lojas
dataAtualizacaoString26SimData/hora do envio
dataCadastroString26SimData/hora do cadastro 



Bloco de código
languagejava
themeEclipse
titlePOST ​/api​/retaguarda​/compartilhamentos
collapsetrue
[
{
"idRetaguarda": "a5c20fa2942342188cacabec8b9da543",
"idProprietario": "1639797f5ce64843a73711d919dad5e7",
"nomeCompartilhamento": "Master",
"nivel": 0,
"idRetaguardaPai": "",
"idRetaguardaLoja": "",
"idInquilino": "OMXKpmP8hVjbqExUN7sa"
},
{
"idRetaguarda": "998e4779609b45aa9f09ba04da1eb81e",
"idProprietario": "693325a343724ff0920fa368377ccd19",
"nomeCompartilhamento": "Central",
"nivel": 1,
"idRetaguardaPai": "a5c20fa2942342188cacabec8b9da543",
"idRetaguardaLoja": "",
"idInquilino": "OMXKpmP8hVjbqExUN7sa"
},
{
"idRetaguarda": "1e6186cbdf4345d7bdcafc862510f31d",
"idProprietario": "57348546ff964e9aa63517e829f33f6d",
"nomeCompartilhamento": "Loja 01",
"nivel": 2,
"idRetaguardaPai": "998e4779609b45aa9f09ba04da1eb81e",
"idRetaguardaLoja": "1d7556c01a604bf28dc4cb1ac4a4ae2f",
"idInquilino": "OMXKpmP8hVjbqExUN7sa"
},
{
"idRetaguarda": "91fd568a3e2748cab760b15731447abc",
"idProprietario": "06df84c10a3049ed9e359dc24d37d5a2",
"nomeCompartilhamento": "Loja 02",
"nivel": 2,
"idRetaguardaPai": "998e4779609b45aa9f09ba04da1eb81e",
"idRetaguardaLoja": "7f16bb7c5b8b4d00821af3b8de08f221",
"idInquilino": "OMXKpmP8hVjbqExUN7sa"
}
]


5.2 InquilinoLoteExterno

A API InquilinoLoteExterno deverá ser utilizada pela ERP/Retaguarda para iniciar, encerrar e consultar o status do processo de integração com o PDVSync. 

...

Para que a integração seja realizada o ERP/Retaguarda deverá solicitar um lote para o PDVSyn, onde deverá informar o inquilino e quais tipos de dados serão integrados.


Parâmetros de entrada:

CampoTipo
TamanhoObrigatório
Descrição
loteOrigem

do inquilino no TOTVS RAC

mensagemsituacaosituaçãotipoLoteTipo do lote externo para o PdvSync
Cliente = 0,
Loja = 1,
Motivo = 2,
Usuario = 3,
Estoque = 4,
FcpProduto = 5,
Compartilhamento = 6,
Imposto = 7,
Ncm = 8,
PisCofin = 9,
TributoNcm = 10,
Preco = 11,
ClassificacaoProduto = 12,
Produto = 13ididInquilinodataAtualizacaodataCadastro
statusEnum

Para iniciar a integração é necessário que o ERP/Retaguarda envie o status:

0 - InicioEnvio

tipoLoteEnum

Tipo da informação que será integrada com o PdvSync, sendo:
0- Cliente
1-Loja
2-Motivo
3-Usuario
4-Estoque
5-FcpProduto
6-Compartilhamento
7-Imposto
8-Ncm
9-PisCofin
10-TributoNcm
11-Preco
12-ClassificacaoProduto
13-Produto

idInquilinoString Identificador da estrutura de redes, franquias, centrais e lojas
Bloco de código
language
Bloco de código
languagejava
themeEclipse
titlePOST /api/retaguarda/inquilinolotesexternos
collapsetrue

Parâmetros de saída: 

...

{
    "status": "InicioEnvio",
    "tipoLote": [1,6],
    "idInquilino": "QRXBxobJ11Yr5H93h5ON"
}


Parâmetros de saída: 

...

FECHAMENTO → EndPoint - /api/retaguarda/inquilinolotesexternos/{idInquilino}/{lote} - PUT

Esta API é responsável por avisar o PDVSync que o envio das informações foi concluída, para que inicie o processo de validação e envio para as Lojas.

Detalhes sobre a API estão no MicroServiço https://pdvsync-core-controle-dev-aadivv24nq-ue.a.run.app/swagger/index.html , Módulo INQUILINOLOTEEXTERNO


CampoTipoTamanhoObrigatórioDescrição

...

sucess

...





message

...





loteOrigem

...





mensagem

...





status

...





tipoLote




FECHAMENTO → EndPoint -

5.4 Lote Externo Retornos - INQUILINOLOTEEXTERNO

 EndPoint - /api/retaguarda/LoteExternoRetornosinquilinolotesexternos/{idInquilino}/{loteOrigemlote} - GETPUT

Esta API retorna o sucesso ou qual erro ocorreu na validação do Lote de informações enviados para o PDVSyncé responsável por avisar o PDVSync que o envio das informações foi concluída, para que inicie o processo de validação e envio para as Lojas.

Detalhes sobre a API estão no MicroServiço no MicroServiço https://pdvsync-core-controle-dev-aadivv24nq-ue.a.run.app/swagger/index.html , Módulo INQUILINOLOTEEXTERNO


CampoTipoTamanhoObrigatórioDescrição








































Detalhes sobre a API estão no  MicroServiço   https://pdvsync-core-controle-dev-aadivv24nq-ue.a.run.app/swagger/index.html , Módulo
Bloco de código
languagejava
themeEclipse
titleGET PUT ​/api​/retaguarda​/LoteExternoRetornos​inquilinolotesexternos​/{inquilino}​/{loteOrigemlote}
collapsetrue
Informações

5.4 Lote Externo Retornos - INQUILINOLOTEEXTERNO



...

Âncora
dadosBasicos
dadosBasicos

...