...
...
endpoint: https://pdvsync.varejo.totvs.com.br/controle/api/pdvsyncserver/parametros
Post
[{
"idInquilino": "IdDoInquilino01-01", → /*O código do IdInquilino IdInquilino conforme retornado no email.*/
"QuantidadeRegistrostipoProcesso": 100,1,/* OnLine = 0, Descida = 1, Subida = 2*/
"TempoChamadaquantidadeRegistros": 21000,
"TempoExpurgoLogstempoChamada": 1300002000,
"TipoDadotempoExpurgoLogs": {365,
"CodigoTipotipoDado": 14,{
"DescricaoTipo"codigoTipo": 1,
"descricaoTipo": "EstoqueLoja",
"TipoUtilizadortipoUtilizador": 0,/*ClienteDown = 0, Server = 1, ClienteUp = 2, ClienteOnLine = 3 */
},
"TipoProcessotipoProcesso": 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 |
...
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
{
"status": "InicioEnvio",
"tipoLote": [{
"success": true,
"message": "",
"data": [
{
"tipoProcesso": 1,
"quantidadeRegistros": 10000,
1
],
"tempoChamadaidInquilino": 2.0,"" /*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"tempoExpurgoLogssuccess": 130000.0true,
"tipoDado": {
"id": null"message": "",
"codigoTipo"data": 14,{
"descricaoTipoloteOrigem": "Estoque20221004175001554",
"tipoUtilizadormensagem": 1null,
"tipoProcessostatus": 0,
"_expandablestipoLote": []
},6
],
"id": "DLoi3SX5HDoPOcDlyf0m",
"idInquilino": "",
"dataAtualizacao": "2022-0810-05T1504T17:1050:2101.604886Z6441804Z",
"dataCadastro": "2022-0810-05T1504T17:1050:2101.604888Z6442468Z",
"_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
]" ",
"idInquilinocnpj": " ", O código do IdInquilino conforme retornado no email.
}
Response:
{
/*obrigatório e valido - 14 caracteres*/
"successinscricaoEstadual": true," ", /*obrigatório - 2 e 14 caracteres*/
"messageinscricaoMunicipal": " ",
"data": {/*obrigatório - até 15 caracteres*/
"loteOrigemendereco": " 20221004175001554 ",
"mensagemnumero": null" ",
"statuscomplemento": 0" ",
"tipoLotebairro": [
6
]" ",
"idcidade": " DLoi3SX5HDoPOcDlyf0m ",
"idInquilinoestado": " ",
"dataAtualizacaosiglaUf": " 2022-10-04T17:50:01.6441804Z ",
"dataCadastrocodigoUFIBGE": " 2022-10-04T17:50:01.6442468Z ", /*obrigatório - 2 caracteres*/
"_expandables": []
}
}
4º - Cadastro de uma Loja
endpoint: https://pdvsync-core-dadosbasicos-prd-q6yz66olca-rj.a.run.app/api/retaguarda/lojas
Post
codigoMunicipioIbge": " ", /*obrigatório - 7 caracteres*/[
{
"razaoSocialcep": "", /*obrigatorio*/
"nomeFantasiatelefone": "", /*obrigatório - 6 e 14 caracteres*/
"cnpjcodigoIdentificacaoLoja": "",
"inscricaoEstadualmodeloFiscal": " "0, --
"inscricaoMunicipalregimeTributario": " "1,
"enderecorede": "", /*obrigatório*/
"numeronumeroLoja": "0",
"complementoidRetaguardaRede": "",
"bairrocodigoMaster": " ",
"cidadenomeMaster": " ",
"estadosituacao": " "1,
"siglaUfidInquilino": " ", /*Gerado no passo 1*/
"codigoUFIBGEidRetaguarda": "3 ", /*código da loja na retaguarda*/
"codigoMunicipioIbgeidProprietario": " ", /*compartilhamento da loja*/
"ceploteOrigem": " " ,
"telefone": "",
"codigoIdentificacaoLoja": "",
"modeloFiscal": "",
"regimeTributario": "",
"rede": "",
"numeroLoja": "0",
"idRetaguardaRede": "/*Gerado no passo 3*/
}
]
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",
"codigoMastertipoLote": " ",
"nomeMaster[
6
],
"idInquilino": "" ,/*O código do IdInquilino conforme retornado no email.*/
}
Response:
{
"situacaosuccess": 1true,
"idInquilinomessage": "", - Gerado no passo 1
"data": {
"idRetaguardaloteOrigem": "3 20221004175001554", - Gerado no passo 4
"idProprietariomensagem": null,
"status": 0,- Gerado no passo 4
"loteOrigemtipoLote": " " - Gerado no passo [
6
}
],
5º - Fechar lote de loja
"id": "DLoi3SX5HDoPOcDlyf0m",
"idInquilino": "",
"dataAtualizacao": "2022-10-04T17:50:01.6441804Z",
"dataCadastro": "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": "",
"NomeCompartilhamento": "PDV Master",
"Nivel": 0,
"IdRetaguardaPai
Response:
{
"success": true,
"message": "",
"dataloteOrigem": "20221004175001554"
},
{
"loteOrigemIdRetaguardaLoja": "202210041750015543f054f05-ee67-407b-935d-9db0fc5e7c58",
"mensagemIdRetaguarda": null"3f054f05-ee67-407b-935d-9db0fc5e7c58",
"statusIdProprietario": 0"3f054f05-ee67-407b-935d-9db0fc5e7c58",
"tipoLoteIdInquilino": ["",
6"NomeCompartilhamento": "PDV Loja",
]"Nivel": 1,
"idIdRetaguardaPai": "DLoi3SX5HDoPOcDlyf0m",
"idInquilinoloteOrigem": "20221004175001554",
}
]
Response:
{
"dataAtualizacaosuccess": "2022-10-04T17:50:01.6441804Z"true,
"dataCadastro": "2022-10-04T17:50:01.6442468Z",
"_expandables": []
}
}
7º - Criar Compartilhamento
endpoint: https://pdvsync-core-controle-prd-q6yz66olca-rj.a.run.app/api/retaguarda/compartilhamentos
Post
[
{
"IdRetaguardaLoja": "",
"IdRetaguarda": "32796d0b-8399-490e-b972-1db212c514fa",
"IdProprietario": "32796d0b-8399-490e-b972-1db212c514fa",
"IdInquilino": "",
"NomeCompartilhamento": "PDV Master",
"Nivel": 0,
"IdRetaguardaPai": "",
"loteOrigem": "20221004175001554"
},
{
"IdRetaguardaLoja": "message": "compartilhamento inserido com sucesso: [{\"IdRetaguarda\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"IdProprietario\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"NomeCompartilhamento\":\"PDV Master\",\"Nivel\":0,\"IdRetaguardaPai\":\"\",\"LoteOrigem\":\"20221004175001554\",\"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\",
"IdRetaguarda\"IdProprietario\":\"3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdProprietario": "3f054f05-ee67-407b-935d-9db0fc5e7c58",
"IdInquilino": "",
"NomeCompartilhamento": "PDV Loja",
"Nivel": 1,
"IdRetaguardaPai": "",
"loteOrigem": "20221004175001554"
}
]Response:{
"success": true,
"message": "compartilhamento inserido com sucesso: [{\"IdRetaguarda\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"IdProprietario\":\"32796d0b-8399-490e-b972-1db212c514fa\",\"NomeCompartilhamento\":\"PDV Master\",\"Nivel\":0,\"IdRetaguardaPai\":\"\",\"LoteOrigem\":\"20221004175001554\",\"Lote\":null,\"IdRetaguardaLoja\":\"\",\"\",\"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\":[]},{\"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",
"
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": 12,
"tipo": 12,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 23,
"tipo": 23,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 34,
"tipo": 34,
"valor": "10"
},
{
"idInquilino": "", /*Gerado no passo 01*/
"dataAtualizacao": "2022-10-07T18:59:54.530Z",
"dataCadastro": "2022-10-07T18:59:54.530Z",
"codigo": 45,
"tipo": 40,
"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
...
: "https://pdvsync-core-fila-prd-q6yz66olca-rj.a.run.app/api/stub/historicovenda"
}
]
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:
...