Índice
Índice
O PDVSync é a camada responsável por orquestrar as operações de sincronização de dados entre o TOTVS Varejo PDV Omnishop e Omni e as suas respectivas retaguardas/ERPs.
...
...
...
Exemplo de Fluxo de chamadas de API´s com Abertura de lote, Fechamento de Lote e Solicitação de Retorno do Status do Lote Enviado.
...
OBS: Todos Schemas e Retornos disponíveis estão no Swagger.
...
Âncora | ||||
---|---|---|---|---|
|
IDInquilino : OMXKpmP8hVjbqE
...
Para o PDVSync foram definidos microsserviços independentes, levando em consideração a utilização e afinidade das informações trafegadas e armazenadas.
Os microsserviços foram divididos em:
...
Âncora | ||||
---|---|---|---|---|
|
No MicroServiço controle, com relação a comunicação com o ERP/Retaguarda, temos as informações de Abertura e Fechamento do Lote de envio de dados e o retorno do Lote enviado, informando sucesso das informações entregues no PDVSync ou qual o erro encontrado e a estrutura de lojas na Compartilhamento, esta responsável por determinar quais lojas irão receber qual informação entregue no PDVSync.
...
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.
...
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.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
...
Âncora | ||||
---|---|---|---|---|
|
EndPoint - /api/retaguarda/lojas - POST
...
Campo | Tipo | Tamanho | Obrigatoriedade | Descrição |
razaoSocial | String | 50 | Sim | Razão social da loja. |
nomeFantasia | String | 50 | Sim | Nome fantasia da loja. |
cnpj | String | 14 | Sim | CNPJ da loja. |
inscricaoEstadual | String | 15 | Sim | Inscrição Estadual da Loja |
inscricaoMunicipal | String | 15 | Não | Inscrição Municipal da Loja |
endereco | String | 200 | Sim | Endereço da Loja |
numero | String | 10 | Sim | Número da Loja |
complemento | String | 100 | Não | Complemento do Endereço da Loja |
bairro | String | 150 | Sim | Bairro da Loja |
cidade | String | 150 | Sim | Cidade da Loja |
estado | String | 60 | Sim | Estado da Loja |
siglaUf | String | 2 | Sim | Sigla do Estado da Loja (UF) |
codigoUFIBGE | String | 2 | Sim | Código da UF no IBGE |
codigoMunicipioIbge | String | 50 | Sim | Código do Município do IBGE |
cep | String | 10 | Sim | CEP da Loja |
telefone | String | 20 | Sim | Telefone da Loja |
codigoIdentificacaoLoja | String | 20 | Sim | Código de Identificação da Loja |
modeloFiscal | String | 1 | Não | Modelo Fiscal da Loja: A configuração do modelo fiscal da loja poderá ser realizado através do configurador do PDV |
regimeTributario | String | 1 | Sim | Enquadramento Fiscal da Loja 0 - Simples Nacional 1 - Normal |
rede | String | 40 | Sim | Descrição da REDE no ERP/Retaguarda |
numeroLoja | String | 30 | Sim | Cóidgo da Loja no ERP/Retaguarda |
idInquilino | String | Sim | Código do Inquilino o qual a Loja pertence | |
idRetaguarda | String | Sim | Código da Loja no ERP/Retaguarda | |
idProprietario | DateTime | Sim | Código do Proprietário da informação, no caso da Loja é o próprio ID Retaguarda | |
loteOrigem | Integer | Sim | Número do lote que está sendo integrado, disponibilizado pelo PDV Sync ao ERP na abertura da integração | |
lote | Integer | Não | Informação do PDV Sync, não integrado pelo ERP |
EndPoint - /api/retaguarda/motivos - POST
...
Campo | Tipo | Tamanho | Obrigatoriedade | Descrição |
Descrição | String | Sim | Descrição do Motivo | |
Tipo | Integer | Sim | Tipo do Motivo utilizado : AcrescimoDesconto = 0 TrocaDevolucao = 1 CancelamentoVenda = 5 Sangria = 6 Suprimento = 7 | |
Situação | Integer | Sim | Situação do Motivo. 1 - Ativo 0 - Inativo | |
id | String | Não | Campo Interno do PDVSync | |
idInquilino | String | 100 | Sim | Código do Inquilino o qual a Loja pertence |
idRetaguarda | String | 100 | Sim | Código da Loja no ERP/Retaguarda |
dataAtualizacao | DateTime | Não | Campo Interno data da atualização no PDVSync | |
dataCadastro | DateTime | Não | Campo Interno data de cadastro no PDVSync | |
idProprietario | String | 100 | Sim | Código do Proprietário da informação, no caso da Loja é o próprio ID Retaguarda |
loteOrigem | Interger | Sim | Número do lote que está sendo integrado, disponibilizado pelo PDVSync ao ERP na abertura da integração | |
lote | Interger | Não | Campo Interno Informação do PDVSync, |
EndPoint - /api/retaguarda/motivos - POST
...
Campo | Tipo | Tamanho | Obrigatoriedade | Descrição |
Descrição | String | 100 | Sim | Descrição do Motivo |
Tipo | Integer | Sim | Tipo do Motivo utilizado 0 - 1 - | |
Situação | Integer | Sim | Aituação do Motivo | |
id | String | Não | ||
idInquilino | String | 100 | Sim | Código do Inquilino o qual a Loja pertence |
idRetaguarda | String | 100 | Sim | Código da Loja no ERP/Retaguarda |
dataAtualizacao | DateTime | Não | Data da Atualização no PDVSync | |
dataCadastro | DateTime | Não | Data de Cadastro no PDVSync | |
idProprietario | String | 100 | Sim | Código do Proprietário da informação, no caso da Loja é o próprio ID Retaguarda |
loteOrigem | Interger | Sim | Número do lote que está sendo integrado, disponibilizado pelo PDV Sync ao ERP na abertura da integração | |
lote | Interger | Não | Informação do PDV Sync, não integrado pelo ERP |
Âncora Produto Produto
API com um método Post, Get, Put e Delete para o ERP possa ser enviar o cadastro de produtos no PDVSync.
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
[{ "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdProprietario": "78965", "IdRetaguarda": "12356", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaImposto": "6lnnB85sauBB3nZeGX08", "IdRetaguardaNcm": "7nnnB85sauBB3nZeGX08", "IdRetaguardaPisCofins": "8unnB85sauBB3nZeGX08", "Descricao": "Produto 12222 Completo", "UnidadeMedida": "UN", "DescontoMaximo": 10, "TipoArredondaTrunca": "01", "CodigoProduto": "56987", "CodigoAlternativo": "56987", "OrigemProduto": "0", "Situacao": 1, "Imagem": "alksjdkjaskdjalskdjaisudoi23u4o2i34534h563kj5464k5jh61l2k42l3542m34h5k3jg465k34jh5453j4h5k3j4h5k3j4h545l34jh54l63k4jh6l3k4jh536l34u54y63i4u54y63k4j5h6l34jh6i34u54y6893745yt3489u5ht93458jt9304u5t3904j58t9034j58t9034u5t", "TipoProduto": 1, "Fracionado": true, "CnpjFornecedor": "25362415680001", "EscalaRelevante": true, "ValorBaseFcp": 0, "CodigoBeneficioFiscal": "AB", "PercentualFcp": 1, "CstIcms": "CST", "PercentualReducaoIcms": 1, "AliquotaIcms": 1, "Vlicmsret": 1, "MotivoDesoneracaoIcms": 1, "DescontaDesoneracaoNf": false, "Cest": "Cest", "produtoKits": [{ "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "IdRetaguardaProdutoKit": "1234558", "Descricao": "Kit Teste 01", "QuantidadeVendaKit": 10, "TipoValorKit": 1, "Situacao": 1, "ValorDesconto": 1, "NovoValorUnitario": 58 }, { "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "IdRetaguardaProdutoKit": "1234558", "Descricao": "Kit Teste 01", "QuantidadeVendaKit": 10, "TipoValorKit": 1, "Situacao": 1, "ValorDesconto": 1, "NovoValorUnitario": 58 }, { "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "IdRetaguardaProdutoKit": "1234558", "Descricao": "Kit Teste 01", "QuantidadeVendaKit": 10, "TipoValorKit": 1, "Situacao": 1, "ValorDesconto": 1, "NovoValorUnitario": 58 } ], "produtosSimilares": [{ "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "Situacao": 1, "IdRetaguardaSimilar": "1234558" }, { "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "Situacao": 1, "IdRetaguardaSimilar": "1234558" } ], "ProdutosSugestoes": [{ "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "Situacao": 1, "IdRetaguardaSugestao": "1234558" }, { "Id": "6lnnB85sauBB3nZeGX08", "IdInquilino": "V3uEWOAdRCTLUJX7eedZ", "IdRetaguarda": "78965", "IdProprietario": "78965", "Lote": 12345698765, "LoteOrigem": "20210420135510963", "IdRetaguardaProduto": "132216354", "Situacao": 1, "IdRetaguardaSugestao": "1234558" } ], "codigosProduto": [{ "codigo": "56987", "descricao": "CodigoProduto", "idRetaguarda": "av25e1d2a3de2df1", "dataAtualizacao": "2021-05-11T14:22:18.816Z", "dataCadastro": "2021-05-11T14:22:18.816Z", "situacao": "1" }, { "codigo": "7892509156987", "descricao": "CódigoBarras", "idRetaguarda": "12faserytgf123sdfg", "dataAtualizacao": "2021-05-11T14:22:18.816Z", "dataCadastro": "2021-05-11T14:22:18.816Z", "situacao": "1" } ] } ] |
Âncora | ||||
---|---|---|---|---|
|
Âncora FormaPagamento FormaPagamento
Âncora | ||||
---|---|---|---|---|
|
Âncora estoque estoque
Âncora imposto imposto
Pre-Requisitos para instalação do Client:
Onde deverá conter as informações de loja, inquilino, parâmetros, etc.
...
1º - Pré-requisito
Alterar o arquivo pg_hba.conf localizado no diretório C:\Program Files\PostgreSQL\15\data para que o Agendador de Tarefas tenha acesso a realizar os comandos na máquina local.
...