...
...
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/pdvsyncserver/parametros
Post
[{
"idInquilino": "UNI2023totvsIdDoInquilino01-01", → /*O código do IdInquilino IdInquilino conforme retornado no email.*/
"tipoProcesso": 1,/* OnLine = 0, Descida = 1, Subida = 2*/
"quantidadeRegistros": 1001000,
"tempoChamada": 1202000,
"tempoExpurgoLogs": 130000365,
"tipoDado": {
"codigoTipo": 21,
"descricaoTipo": "MotivoLoja",
"tipoUtilizador": " 0",,/*ClienteDown = 0, Server = 1, ClienteUp = 2, ClienteOnLine = 3 */
"tipoProcesso": "0"
0 /*Criacao = 0, Atualizacao = 1, Interno = 2*/
}
}]
Lista de Parâmetros:
codigoTipo | descricaoTipo | tipotipoProcesso |
0 | Cliente | Down |
1 | Loja | Down |
2 | Motivo | Down |
3 | Perfil | Down |
4 | Usuario | Down |
6 | Compartilhamento | Down |
7 | Imposto | Down |
8 | Ncm | Down |
9 | PisCofins | Down |
12 | Produto | Down |
13 | Preco | Down |
14 | Estoque | Down |
15 | Operadora | Down |
16 | DadoComplementar | Down |
17 | CondicaoPagto | Down |
18 | FormaPagto | Down |
19 | Venda | Up |
20 | Caixa | Up |
22 | Troca | Up |
23 | VendaCustodiaXml | Up |
25 | Cliente | Up |
26 | PreVenda | Up |
54 | AlteracaoEstoque | Down |
Exemplo response:
55 | PreVenda | Down |
3º - Abrir Lote com Parâmetro 01 - Loja
Incluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/retaguarda/inquilinolotesexternos
Post
{
"successstatus": true"InicioEnvio",
"messagetipoLote": ""[
1
],
"idInquilino"data": [: "" /*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"success": true,
"tipoProcessomessage": 1"",
"data": {
"quantidadeRegistrosloteOrigem": 10000"20221004175001554",
"tempoChamadamensagem": 2.0null,
"tempoExpurgoLogsstatus": 130000. 0,
"tipoDadotipoLote": {[
"id": null,6
],
"codigoTipoid": 14"DLoi3SX5HDoPOcDlyf0m",
"descricaoTipo""idInquilino": "Estoque",
"tipoUtilizador": 1"dataAtualizacao": "2022-10-04T17:50:01.6441804Z",
"tipoProcesso": 0"dataCadastro": "2022-10-04T17:50:01.6442468Z",
"_expandables": []
},
"id": "",
"idInquilino": "",
"dataAtualizacao": "2022-08-05T15:10:21.604886Z",
"dataCadastro": "2022-08-05T15:10:21.604888Z",
"_expandables": []
}
3º - Abrir Lote com Parâmetro 01 - Loja
}
4º - Cadastro de uma Loja
**Os dados de cadastros devem ser enviados nas propriedades do json abaixoIncluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync-core-controledadosbasicos-qaprd-aadivv24nqq6yz66olca-uerj.a.run.app/api/retaguarda/inquilinolotesexternoslojas
Post
[
{
"statusrazaoSocial": " InicioEnvio ",
"tipoLotenomeFantasia": [" ",
1"cnpj": " ", /*obrigatório e valido - 14 caracteres*/
],"inscricaoEstadual": " ", /*obrigatório - 2 e 14 caracteres*/
"idInquilinoinscricaoMunicipal": " ", O código do IdInquilino conforme retornado no email.
}
Response:
{
/*obrigatório - até 15 caracteres*/
"successendereco": true" ",
"messagenumero": " ",
"datacomplemento": {" ",
"loteOrigembairro": " 20221004175001554 ",
"mensagemcidade": null" ",
"statusestado": 0" ",
"tipoLotesiglaUf": [" ",
6
],
"id": "DLoi3SX5HDoPOcDlyf0m",
"idInquilino"codigoUFIBGE": " ", /*obrigatório - 2 caracteres*/
"codigoMunicipioIbge": " ", /*obrigatório - 7 caracteres*/
"cep": "", /*obrigatorio*/
"dataAtualizacaotelefone": "2022-10-04T17:50:01.6441804Z",
"dataCadastro": "2022-10-04T17:50:01.6442468Z", /*obrigatório - 6 e 14 caracteres*/
"codigoIdentificacaoLoja": "",
"modeloFiscal": 0,
"_expandablesregimeTributario": []1,
}
}
4º - Cadastro de uma Loja
endpoint: https://pdvsync-core-dadosbasicos-prd-q6yz66olca-rj.a.run.app/api/retaguarda/lojas
Post
[
{
"razaoSocial": " "rede": "", /*obrigatório*/
"numeroLoja": "0",
"nomeFantasiaidRetaguardaRede": "",
"cnpjcodigoMaster": " ",
"inscricaoEstadualnomeMaster": " ", --
"inscricaoMunicipalsituacao": " "1,
"enderecoidInquilino": " ", /*Gerado no passo 1*/
"numeroidRetaguarda": "3 ", /*código da loja na retaguarda*/
"complementoidProprietario": " ", /*compartilhamento da loja*/
"bairroloteOrigem": " " ,/*Gerado no passo 3*/
"cidade": " ",
"estado": " ",
"siglaUf": " ",
"codigoUFIBGE": " ",
"codigoMunicipioIbge": " ",
"cep": "",
"telefone": "",
}
]
5º - Fechar lote de loja
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem}
metodo: PUT
{idInquilino} - Gerado no passo 01
{loteOrigem} - Gerado no passo 03
6º - Abrir Lote com Parâmetro 06 - Compartilhamento
Incluir Authorization OAuth2.0 conforme retornado no email.
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/retaguarda/inquilinolotesexternos
Post
{
"status": "InicioEnvio "codigoIdentificacaoLoja": "",
"modeloFiscaltipoLote": ""[
6
],
"regimeTributarioidInquilino": "" ,/*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"redesuccess": ""true,
"numeroLojamessage": "0",
"idRetaguardaRededata": "",{
"codigoMasterloteOrigem": "20221004175001554",
"nomeMastermensagem": null,
"status": 0,
"situacaotipoLote": 1[
6
],
"idInquilinoid": "DLoi3SX5HDoPOcDlyf0m", - Gerado no passo 1
"idRetaguardaidInquilino": "3 ", - Gerado no passo 4
"idProprietariodataAtualizacao": "2022-10-04T17:50:01.6441804Z",- Gerado no passo 4
"loteOrigemdataCadastro": " " - Gerado no passo 6
}
]
5º - Fechar lote de loja
2022-10-04T17:50:01.6442468Z",
"_expandables": []
}
}
7º - Criar Compartilhamento
endpoint: https://https:/pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem} {idInquilino} - Gerado no passo 01
{loteOrigem} - Gerado no passo 06
6º - Abrir Lote com Parâmetro 06 - Compartilhamento
Incluir Authorization OAuth2.0 conforme retornado no email.
...
compartilhamentos
Post
[
{
"IdRetaguardaLoja": "",
"IdRetaguarda": "32796d0b-8399-490e-b972-1db212c514fa",
"IdProprietario": "32796d0b-8399-490e-b972-1db212c514fa",
"IdInquilino
Response:
{
"success": true,
"message": "",
"data": {
"loteOrigemNomeCompartilhamento": "20221004175001554PDV Master",
"mensagemNivel": null0,
"statusIdRetaguardaPai": 0"",
"tipoLoteloteOrigem": ["20221004175001554"
6},
],{
"idIdRetaguardaLoja": "DLoi3SX5HDoPOcDlyf0m3f054f05-ee67-407b-935d-9db0fc5e7c58",
"idInquilinoIdRetaguarda": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"dataAtualizacaoIdProprietario": "2022-10-04T17:50:01.6441804Z3f054f05-ee67-407b-935d-9db0fc5e7c58",
"dataCadastroIdInquilino": "2022-10-04T17:50:01.6442468Z",
"_expandablesNomeCompartilhamento": []"PDV Loja",
}
}
7º - Criar Compartilhamento
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/compartilhamentos
Post
"Nivel": 1,[
{
"IdRetaguardaLojaIdRetaguardaPai": "",
"IdRetaguardaloteOrigem": "32796d0b-8399-490e-b972-1db212c514fa",
20221004175001554"
}
]
Response:
{
"success": true,
"message": "compartilhamento inserido com sucesso: [{\"IdRetaguarda\":\ "IdProprietario": "32796d0b-8399-490e-b972-1db212c514fa\",
"IdInquilino\"IdProprietario\":\"32796d0b-8399-490e-b972-1db212c514fa\",
\"NomeCompartilhamento\":\"PDV Master\",
\"Nivel\":0,
\"IdRetaguardaPai\":\"\",
"loteOrigem\"LoteOrigem\":\"20221004175001554\"
},
{
"IdRetaguardaLoja": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdRetaguarda": ,\"Lote\":null,\"IdRetaguardaLoja\":\"\",\"Id\":null,\"IdInquilino\":\"\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"0001-01-01T00:00:00\",\"_expandables\":[]},{\"IdRetaguarda\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",
\"IdProprietario\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",
"IdInquilino": "",
"NomeCompartilhamento": "PDV Loja",
"Nivel\"NomeCompartilhamento\":\"PDV Loja\",\"Nivel\":1,
"IdRetaguardaPai": "",
"loteOrigem": "20221004175001554"
}
]Response:{
"success": true,
"message": "compartilhamento inserido com sucesso: [{\"IdRetaguarda\"IdRetaguardaPai\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"IdProprietarioLoteOrigem\":\"32796d0b-8399-490e-b972-1db212c514fa20221004175001554\",\"NomeCompartilhamentoLote\":\"PDV Master\"null,\"NivelIdRetaguardaLoja\":0,\"IdRetaguardaPai\":\"\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"\",\"\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"Id\":null,\"IdInquilino\":\"\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"0001-01-01T00:00:00\",\"_expandables\":[]},{\"IdRetaguarda\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"IdProprietario\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"NomeCompartilhamento\":\"PDV Loja\",\"Nivel\":1,\"IdRetaguardaPai\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58\",\"Id\":null,\"IdInquilino\":\"\",\"DataAtualizacao\":\"0001-01-01T00:00:00\",\"DataCadastro\":\"0001-01-01T00:00:00\",\"_expandables\":[]}].",
"data": null
}
8º - Fechar o Lote
https:/pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem}
...
].",
"data": null
}
8º - Fechar o Lote
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/inquilinolotesexternos/{idInquilino}/{loteOrigem}
metodo: PUT
{idInquilino} - Gerado no passo 01
{loteOrigem} Gerado no passo anterior
9º - Cadastrar os parâmetros comerciais para a consulta de operações de vendas e caixa
URL: https://pdvsync.varejo.totvs.com.br/comercial/api/pdvsyncserver/parametros
Post
[
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 1,
"tipo": 1,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 2,
"tipo": 2,
"valor": "10"
},
9º - Cadastrar os parâmetros comerciais para a consulta de operações de vendas e caixa
URL: https://pdvsync.varejo.totvs.com.br/comercial/api/pdvsyncserver/parametros
Post
[
{
"idInquilino": "", - /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 13,
"tipo": 13,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 0101*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 24,
"tipo": 24,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 35,
"tipo": 30,
"valor": "10https://pdvsync-core-fila-prd-q6yz66olca-rj.a.run.app/api/stub/historicovenda"
},
{
"idInquilino": "", Gerado no passo 01
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 4,
"tipo": 4,
"valor": "10"
},
{
"idInquilino": "", Gerado no passo 01
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 5,
"tipo": 0,
"valor": "https://pdvsync-core-fila-prd-q6yz66olca-rj.a.run.app/api/stub/historicovenda"
}
10º Baixar Serviços Clients
...
]
10º Baixar Serviços Clients
Instalação dos Serviços UP, DOWN, CONTROLE e API:
Desinstalação dos Serviços UP, DOWN, CONTROLE e API:
18.1. Configuração do PDV Sync Server para a loja via Postman
Para realizar as configurações para a utilização do PDV Sync no PDV Omnishop, é necessário realizar os cadastros abaixo através das APIs de Parâmetros.
O passo a passo do Postman se encontra no Google Drive no caminho: https://drive.google.com/drive/folders/1KriEZNs0ofg2uBF8u3TLniozko3IA063
Lá se encontra o arquivo com as Collections montadas para a configuração e com as variáveis para a utilização da criação de parâmetros.
1º - Criação do Inquilino
Para a criação do inquilino, utilizar o request 01. Criar Inquilino, informar os valores de acordo com as informações do cliente, realizar a autenticação e em seguida realizar o POST.
Após a criação, utilizar o valor do campo IdInquilino na variável para a configuração dos próximos passos.
2º - Criação dos Parâmetros Controle
Para a criação dos parâmetros do controle, basta apenas realizar a autenticação e realizar o POST.
3º - Criação dos Parâmetros Comercial
Para a criação dos parâmetros comerciais, basta apenas realizar a autenticação e realizar o POST.
4º - Criação do Parâmetro para a subida de Clientes
Para a criação do parâmetro de subida de cliente, basta apenas realizar a autenticação e realizar o POST.
Obs.: Para realizar esses procedimentos nos ambientes de desenvolvimento e homologação, seguir os mesmos passos acima, mas utilizar sua respectiva pasta (Passo a Passo - Homologação e Passo a Passo - Desenvolvimento).
Instalação dos Serviços UP, DOWN, CONTROLE e API:
Desinstalação dos Serviços UP, DOWN, CONTROLE e API:
...