...
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 |
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.
...
Campo | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
idRetaguarda | String | 100 | Sim | Identificador do compartilhamento no ERP/Retaguarda |
idProprietario | String | 100 | Sim | 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. |
nomeCompartilhamento | String | 100 | Sim | Nome do compartilhamento que está sendo criado |
nivel | String | 2 | Sim | Define o nível hierárquico da informação no compartilhamento que está sendo criado |
idRetaguardaLoja | String | 100 | Sim | Identificador da loja no ERP/Retaguarda |
idInquilino | String | 100 | Sim | Identificador da estrutura de redes, franquias, |
centrais e lojas | ||||
dataAtualizacao | String | 26 | Sim | Data/hora do envio |
dataCadastro | String | 26 | Sim | Data/hora do cadastro |
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[ { "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" } ] |
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:
Campo | Tipo |
---|
Descrição |
---|
do inquilino no TOTVS RAC
status | Enum | Para iniciar a integração é necessário que o ERP/Retaguarda envie o status: 0 - InicioEnvio |
tipoLote | Enum | Tipo da informação que será integrada com o PdvSync, sendo: |
idInquilino | String | Identificador da estrutura de redes, franquias, centrais e lojas |
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Bloco de código | ||||||||
|
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
Campo | Tipo | Tamanho | Obrigatório | Descrição |
---|
...
sucess |
...
message |
...
loteOrigem |
...
mensagem |
...
status |
...
tipoLote |
FECHAMENTO → EndPoint -
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
Campo | Tipo | Tamanho | Obrigatório | Descrição |
---|---|---|---|---|
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Informações | ||||||||
...
Âncora | ||||
---|---|---|---|---|
|
...