Download OpenAPI specification:Download
Seja bem-vindo a nossa documentação. Aqui vocẽ poderá navegar por todos os endpoints disponibilizados por nossa equipe.
Para mais informações em como integrar sua solução conosco, acesse nosso site.
O serviço de Login é utilizado para cadastrar, trocar senha e gerar códigos de autenticação de um usuário
Esse endpoint serve para autenticar um usuário.
Campos para autenticação
Informações de acesso fornecidas pela equipe de Onboarding
usuario required | string Nome do usuário. |
senha required | string Senha do usuário. |
{- "usuario": "polgo",
- "senha": "123456789"
}
{- "status": 200,
- "mensagem": "Usuário autenticado com sucesso!",
- "retorno": {
- "ativo": true,
- "email": "",
- "emailVerificado": false,
- "id": "817fca90-4c24-4c83-bc7a-4ac0c0c6547d",
- "loginSocial": null,
- "nome": "Grupo Polgo",
- "tipo": "consumidor",
- "usuario": "polgo",
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJRUkRPQ1VNRU5UQUNBTyIsImlhdCI6MTUxNjIzOTAyMn0"
}
}
Esse endpoint serve para criar um login.
Campos para a criação de um login.
usuario required | string CPF/CNPJ do novo usuário. |
nome required | string Nome do novo usuário. |
tipo required | string Enum: "consumidor" "lojista" Tipo de permissão para novo usuário. |
senha required | string Senha do novo usuário. |
string E-mail do novo usuário. | |
telefoneContato | string Telefone de contato do usuário que indicou este cadastro. |
resposta | string Campo livre, identificando resposta preenchida pelo usuário. |
extra | string Campo livre para informações adicionais do usuário. |
object Estrutura com informações de endereço deste novo usuário. | |
object Estrutura com informações do consumidor que indicou este novo usuário. |
{- "usuario": "51525032984",
- "nome": "POLGO DA SILVA",
- "tipo": "consumidor",
- "senha": "123456",
- "email": "teste@mail.com.br",
- "extra": "CAMPO LIVRE",
- "resposta": "SIM",
- "endereco": {
- "endereco": "RUA",
- "bairro": "BAIRRO",
- "numero": "1000",
- "cidade": "SÃO PAULO",
- "cep": "00000-000",
- "estado": "SP"
}, - "consumidor": {
- "indicacao": "1aad69e9-1a50-4851-b020-15cce883e273",
- "aceites": [ ],
- "telefoneContato": "19912345678"
}
}
{- "status": 201,
- "mensagem": "Login inserido com sucesso.",
- "retorno": {
- "id": "f6d726bc-a21e-49b9-b13c-2a4b7987603f",
- "usuario": "27345834026",
- "nome": "TESTE123456",
- "tipo": "consumidor",
- "ativo": true,
- "loginSocial": null,
- "senha": "d21b5ecf5da538ed74f72f55e6b6da1a",
- "senhaJaCriptografada": true,
- "email": "",
- "emailVerificado": false,
- "eventos": [
- {
- "id": "072452eb-47b4-4a1e-b961-2cee394c632b",
- "tipo": "EMISSOR",
- "dataHora": "2022-09-14 09:55:45",
- "idLogin": "27345834026",
- "servico": "Login",
- "evento": "LoginCadastrado",
- "conteudo": {
- "id": "f6d726bc-a21e-49b9-b13c-2a4b7987603f",
- "usuario": "27345834026",
- "nome": "TESTE123456",
- "tipo": "consumidor",
- "loginSocial": null,
- "email": null,
- "emailVerificado": false,
- "imgUrl": null,
- "consumidor": {
- "indicacao": {
- "id": "1aad69e9-1a50-4851-b020-15cce883e273",
- "nome": "TESTE123456",
- "usuario": "62410794092"
}, - "aceites": null,
- "telefoneContato": ""
}, - "participarSemCompletarCadastro": "1"
}
}
]
}
}
O serviço de Consumidor permite o cadastro e consulta de consumidores dentro de nossa plataforma.
Endpoint para listar os consumidores cadastrados em nossa base.
totalPorPagina required | integer [ 1 .. 100 ] Example: 10 Indicador da quantidade total de itens por página. |
paginaAtual required | integer >= 1 Example: 1 Indicador da pagina atual. |
filtroNome | string Example: filtroNome=POLGO Parâmetro de filtragem pelo nome do consumidor. |
filtroBairros | string Example: filtroBairros=Jardim, Recanto Parâmetro de filtragem pelos bairros do consumidor, separados por vírgula. |
filtroCpf | string Example: filtroCpf=16286538576 Parâmetro de filtragem pelo CPF do consumidor. |
filtroRg | string Example: filtroRg=637627637 Parâmetro de filtragem pelo RG do consumidor. |
filtroTelefone | string Example: filtroTelefone=19972638765 Parâmetro de filtragem pelo telefone do consumidor. |
filtroIdadeMaxima | string Example: filtroIdadeMaxima=78 Parâmetro de filtragem pela idade máxima do consumidor. |
filtroIdadeMinima | string Example: filtroIdadeMinima=18 Parâmetro de filtragem pela idade mínima do consumidor. |
filtroEmail | string Example: filtroEmail=grupo@polgo.com.br Parâmetro de filtragem pelo e-mail do consumidor. |
filtroDataHoraInicial | string Example: filtroDataHoraInicial=2022-08-19 00:00:00 Data-hora inicial de cadastro de usuários, no formato |
filtroDataHoraAtualizacaoInicial | string Example: filtroDataHoraAtualizacaoInicial=2022-08-15 00:00:00 Data-hora inicial de atualização de usuários, no formato |
filtroDataHoraAtualizacaoFinal | string Example: filtroDataHoraAtualizacaoFinal=2022-08-17 00:00:00 Data-hora final de atualização de usuários, no formato |
filtroCadastroInicial | string Example: filtroCadastroInicial=true Caso verdadeiro, retorna consumidores com o campo cadastroInicial true, se não false. |
Authorization required | string Token de autorização |
curl --request GET \ --url https://testews.polgo.com.br/polgo/consumidor/v1/consumidores/100/1 \ --header 'Content-Type: application/json' \ --header 'authorization: 000aaa999zzz'
{- "status": 200,
- "mensagem": "Lista de consumidores recuperadas.",
- "retorno": {
- "paginas": 1,
- "total": 1,
- "retorno": [
- {
- "id": "ff854acc-350c-49c2-8909-0858cc95d9e1",
- "telefone": "19999999999",
- "nome": "José Fernandes",
- "dataNascimento": "1999-01-10",
- "genero": "masculino",
- "cpf": "08382859887",
- "rg": "303871271",
- "endereco": {
- "endereco": "RUA QUATRO",
- "numero": "122",
- "complemento": "CASA 2",
- "bairro": "FÁTIMA",
- "cidade": "ARAGUARI",
- "cep": "38441424",
- "estado": "MG"
}, - "email": "teste@email.com",
- "urlFotoPerfil": "",
- "fotoPerfil": "",
- "uriFotoPerfil": "",
- "cadastroInicial": false,
- "tipo": "F",
- "telefoneContato": "",
- "documentoVariavel": "",
- "aceitaNotificacao": false,
- "dataHoraCadastro": "2021-11-23 09:55:27",
- "primeiraLoja": null,
- "indicacao": null,
- "resposta": "",
- "vendedor": "",
- "aceites": [ ],
- "extra": "",
- "dataHoraUltimaAtualizacao": "2022-01-01 00:00:00"
}
]
}
}
O Serviço de Documentos Fiscais é responsável pela geração, processamento e listagem de vendas. Ele se comunica com serviços de Cashback
, Cupom
e Raspadinha Alternativa
Endpoint responsável em gravar novas vendas.
Authorization required | string Token de autorização |
usuario required | string CPF/CNPJ do usuário da venda |
numeroDocumento required | string Identificador único da venda. |
dataHoraEmissao required | string Data e hora da emissão no formato |
valorTotal required | number <double> Valor total da venda |
cnpjEmitente required | string CNPJ do emitente. |
codigoEmitente required | string Código interno do emitente. |
object Estrutura com informações da campanha. | |
object Grupo de produtos utilizados na venda | |
formaPagamento | string Formas de pagamentos utilizadas na venda. |
extra | string Campo livre para informações complementares da venda |
object Estrutura para informações do vendedor | |
object Estrutura para informações complementares do consumidor | |
urlImagem | string Link com o comprovante da venda |
{- "campanha": {
- "ano": 2021,
- "identificacao": "CAMPANHAPOLGO"
}, - "usuario": "11122233399",
- "urlImagem": "",
- "extra": "Documento de origem em São Paulo - SP",
- "cnpjEmitente": "111222333000199",
- "codigoEmitente": "12345",
- "dataHoraEmissao": "2021-01-01 00:00:00",
- "valorTotal": "123.45,",
- "cnpjCpf": "11122233399",
- "numeroDocumento": "35542315348534897845315458945643154687456341",
- "formaPagamento": "DINHEIRO",
- "produtosServicos": [
- {
- "descricao": "Produto 1",
- "unidade": "LT",
- "quantidade": 1,
- "valor": 100.04,
- "codigo": "123456"
}, - {
- "descricao": "Produto 2",
- "unidade": "KG",
- "quantidade": 2,
- "valor": 10.1,
- "codigo": "321456"
}, - {
- "descricao": "Produto 3",
- "unidade": "KG",
- "quantidade": 1.563,
- "valor": 3.21,
- "codigo": "321654"
}
], - "vendedor": {
- "codigo": "123123",
- "nome": "VENDEDOR polgo"
}, - "consumidor": {
- "nome": "CONSUMIDOR POLGO"
}
}
{- "status": 201,
- "mensagem": "Documento processado com sucesso.",
- "retorno": {
- "id": "1e7fc3ab-a333-4562-b92c-ddb225fb42d7",
- "campanha": {
- "ano": 2024,
- "identificacao": "CAMPANHAPOLGO"
}, - "usuario": "11122233399",
- "cabecalho": {
- "chaveAcesso": "1648820993048",
- "coo": "35542315348534897",
- "dataHoraEmissao": "2021-01-01 00:00:00",
- "valorTotal": 123.45,
- "numSerieImpressora": "",
- "formaPagamento": "DINHEIRO",
- "vendedor": {
- "codigo": "111",
- "nome": "VENDEDOR POLGO"
}
}, - "emitente": {
- "cnpj": "11122233000199",
- "nome": "",
- "nomeFantasia": "",
- "telefone": "",
- "municipio": "",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": ""
}, - "destinatario": {
- "cnpjCpf": "11122233399",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [
- {
- "descricao": "Produto 1",
- "quantidade": 1,
- "unidade": "LT",
- "valor": 100.04,
- "ncm": "",
- "codigo": "123456",
- "cfop": "",
- "codigoEAN": ""
}, - {
- "descricao": "Produto 2",
- "quantidade": 2,
- "unidade": "KG",
- "valor": 10.1,
- "ncm": "",
- "codigo": "321456",
- "cfop": "",
- "codigoEAN": ""
}, - {
- "descricao": "Produto 3",
- "quantidade": 1.563,
- "unidade": "KG",
- "valor": 3.21,
- "ncm": "",
- "codigo": "321654",
- "cfop": "",
- "codigoEAN": ""
}
], - "extra": "Documento de origem em São Paulo - SP",
- "dataHoraLeitura": "2021-07-14 11:03:16",
- "dataLeitura": "2021-07-14",
- "dataHoraProcessamento": null,
- "imagem": "",
- "uriImagem": "",
- "eventos": [ ],
- "cancelado": false,
- "apuracao": [
- {
- "status": "VALIDO",
- "observacao": "",
- "historico": [
- {
- "status": "INVALIDO",
- "observacao": "Imagem borrada.",
- "dataHora": "2022-10-17 09:41:09",
- "usuarioLogado": "root"
}, - {
- "status": "VALIDO",
- "observacao": "",
- "dataHora": "2022-10-17 11:04:39",
- "usuarioLogado": "lojista"
}
]
}
], - "consumidor": {
- "nome": "CONSUMIDOR POLGO"
}
}
}
Endpoint serve para cancelar uma venda.
Authorization required | string Token de autorização |
Dados para cancelar uma venda.
idDocumentoFiscal required | string Identificador único da venda |
{- "idDocumentoFiscal": "31b83745-3d5b-4a1a-b533-dd670ca9079a"
}
{- "status": 200,
- "mensagem": "Documento Fiscal cancelado.",
- "retorno": {
- "id": "31b83745-3d5b-4a1a-b533-dd670ca9079a",
- "campanha": {
- "ano": 2019,
- "identificacao": "CAMPESTORNODOC"
}, - "usuario": "11122233399",
- "cabecalho": {
- "chaveAcesso": "12345678901234567890123456789012345678901234",
- "coo": "",
- "dataHoraEmissao": "2019-10-15 15:00:58",
- "valorTotal": 125.43,
- "numSerieImpressora": "",
- "formaPagamento": "",
- "vendedor": null
}, - "emitente": {
- "cnpj": "11122233000199",
- "nome": "EMPRESA QUE DÁ PRÊMIOS",
- "nomeFantasia": "",
- "telefone": "11984542221",
- "municipio": "1454545 - MOGI GUAÇU",
- "uf": "PI",
- "inscricaoEstadual": "1231321",
- "inscricaoMunicipal": "",
- "cnae": "131212222",
- "regimeTributario": ""
}, - "destinatario": {
- "cnpjCpf": "11122233399",
- "nome": "",
- "telefone": "1935455447",
- "municipio": "",
- "uf": "",
- "email": "consumi@dor.com.br"
}, - "produtosServicos": [
- {
- "descricao": "PRODUTO 1",
- "quantidade": 2,
- "unidade": "",
- "valor": 25.43,
- "ncm": "",
- "codigo": "123",
- "cfop": "",
- "codigoEAN": ""
}, - {
- "descricao": "PRODUTO 2",
- "quantidade": 1,
- "unidade": "KG",
- "valor": 100,
- "ncm": "",
- "codigo": "321",
- "cfop": "",
- "codigoEAN": ""
}
], - "extra": null,
- "dataHoraLeitura": "2021-12-01 09:13:00",
- "dataLeitura": "2021-12-01",
- "dataHoraProcessamento": null,
- "imagem": "",
- "uriImagem": "",
- "cancelado": true
}
}
Endpoint serve para obter a listagem de vendas.
totalPorPagina required | integer [ -1 .. 100 ] Example: 100 Indicador da quantidade total de itens por página |
paginaAtual required | integer >= 1 Example: 1 Indicador da pagina atual |
anoCampanha | integer Example: anoCampanha=2022 Ano da campanha |
identificacaoCampanha | string Example: identificacaoCampanha=GRUPOPOLGO Identificação da campanha |
numeroDocumento | string Example: numeroDocumento=5555 Número de identificação da venda |
cnpjEmitente | string Example: cnpjEmitente=11122233000199 CNPJ do emitente da venda |
codigoInternoEmitente | string Example: codigoInternoEmitente=182b1456-7562-11ec-b8e2-43291dcfc479 Código interno do emitente |
usuario | string Example: usuario=11122233399 CPF/CNPJ do usuário da venda |
Authorization required | string Token de autorização |
curl --request GET \ --url https://testews.polgo.com.br/polgo/documentoFiscal/v1/documentos/1/1 \ --header 'Content-Type: application/json' \ --header 'authorization: 000aaa999zzz'
{- "status": 200,
- "mensagem": "lista recuperada",
- "retorno": {
- "total": 100,
- "paginas": 1,
- "retorno": [
- {
- "id": "1e7fc3ab-a333-4562-b92c-ddb225fb42d7",
- "campanha": {
- "ano": 2021,
- "identificacao": "CAMPANHAQRSORTEIOS"
}, - "usuario": "11122233399",
- "extra": null,
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "35542315348534897845315458945643154687456341",
- "numeroDocumento": "",
- "dataHoraEmissao": "2021-01-01 00:00:00",
- "valorTotal": 123.45,
- "numSerieImpressora": "",
- "formaPagamento": "DINHEIRO",
- "vendedor": {
- "codigo": "53340632736337",
- "nome": "VENDEDOR POLGO"
}
}, - "emitente": {
- "cnpj": "11122233000199",
- "nome": "",
- "nomeFantasia": "",
- "telefone": "",
- "municipio": "",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "182b1456-7562-11ec-b8e2-43291dcfc479"
}, - "destinatario": {
- "cnpjCpf": "11122233399",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [
- {
- "descricao": "Produto 1",
- "quantidade": 1,
- "unidade": "LT",
- "valor": 100.04,
- "ncm": "",
- "codigo": "123456",
- "cfop": "",
- "codigoEAN": ""
}, - {
- "descricao": "Produto 2",
- "quantidade": 2,
- "unidade": "KG",
- "valor": 10.1,
- "ncm": "",
- "codigo": "321456",
- "cfop": "",
- "codigoEAN": ""
}, - {
- "descricao": "Produto 3",
- "quantidade": 1.563,
- "unidade": "KG",
- "valor": 3.21,
- "ncm": "",
- "codigo": "321654",
- "cfop": "",
- "codigoEAN": ""
}
], - "dataHoraLeitura": "2021-07-14 11:03:16",
- "dataLeitura": "2021-07-14",
- "dataHoraProcessamento": null,
- "imagem": "",
- "uriImagem": "",
- "consumidor": {
- "nome": "CONSUMIDOR POLGO"
}
}
]
}
}
O serviço de Cupom é utilizado para a premiação dos usuários, permitindo que cupons sejam gerados, listados e premiados. Ele se comunica com o serviço de Documento Fiscal
Esse endpoint serve para listar os cupons gerados com base em uma campanha.
anoCampanha required | |
identificacaoCampanha required | string Example: CAMPANHAPOLGO Identificação da campanha. Informação fornecedida pela equipe de Onboarding |
totalPorPagina required | integer [ -1 .. 100 ] Example: 10 Indicador da quantidade total de itens por página. |
paginaAtual required | integer >= 1 Example: 1 Indicador da pagina atual. |
Authorization required | string Token de autorização |
object Estrutura com parâmetros de filtragem. |
{- "filtro": {
- "numeracao": {
- "inicial": 1,
- "final": 2
}, - "periodo": {
- "inicial": "2022-09-12 00:00:00",
- "final": "2022-09-15 00:00:00"
}, - "soDistribuido": false,
- "soEscaneado": true,
- "soPremiado": true,
- "loteID": "960e2388-eac5-4b9d-937c-c6a4f5257837",
- "associado": "94435534000194",
- "consumidor": "99059662008"
}
}
{- "status": "200,",
- "mensagem": "Lista dos cupons recuperada.",
- "retorno": {
- "paginas": 1,
- "total": 1,
- "retorno": [
- {
- "id": "dca71a41-1ea6-4d66-8f88-30e0bbecc2aa",
- "campanha": {
- "ano": 2021,
- "identificacao": "MERCADO PADRÃO"
}, - "numeroSequencial": 0,
- "numeroAleatorio": "dca71a41-1ea6-4d66-8f88-30e0bbecc2aa",
- "lote": {
- "id": "85e5eb48-5196-45fb-b13d-8cd2b0a2fea9",
- "campanha": {
- "ano": 2021,
- "identificacao": "MERCADO PADRÃO"
}, - "associado": {
- "cnpjCpf": "94435534000194",
- "nome": ""
}, - "numeracaoInicial": 0,
- "numeracaoFinal": 1,
- "data": "2022-09-05",
- "envioCancelado": false,
- "eventos": [ ]
}, - "documentoFiscal": {
- "campanha": {
- "ano": 2021,
- "identificacao": "MERCADO PADRÃO"
}, - "usuario": "55557009892",
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "543645645",
- "dataHoraEmissao": "2022-09-05 13:32:41",
- "valorTotal": 200,
- "numSerieImpressora": "",
- "formaPagamento": "",
- "vendedor": {
- "codigo": "123",
- "nome": "tew"
}
}, - "emitente": {
- "cnpj": "94435534000194",
- "nome": "",
- "nomeFantasia": "",
- "telefone": "",
- "municipio": "",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "100"
}, - "destinatario": {
- "cnpjCpf": "55557009892",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [ ],
- "extra": null,
- "dataHoraLeitura": "2022-09-05 13:32:43",
- "uriImagem": "",
- "id": "43ff7af3-210f-41b2-9cf0-c807dac4df13"
}, - "consumidor": {
- "id": "e8148f3c-e549-47f6-84ec-1b4e21ff5ed5",
- "telefone": "55557009892",
- "telefoneContato": "",
- "nome": "TESTE CASH",
- "dataNascimento": "",
- "genero": "",
- "cpf": "55557009892",
- "rg": "",
- "endereco": { },
- "email": "testecashbk@teste.com",
- "dinamicaCupom": [ ],
- "indicacao": null,
- "eventos": [ ]
}, - "numeroDaSorte": {
- "serie": 13,
- "numero": 90968,
- "dataHoraGeracao": "2022-09-05 13:32:43",
- "dataGeracao": "2022-09-05"
}, - "sorteio": null,
- "premio": null,
- "entrega": null,
- "integradoCC": null
}
]
}
}
Esse endpoint serve para listar os cupons de um determinado usuário em uma campanha.
anoCampanha required | |
identificacaoCampanha required | string Example: CAMPANHAPOLGO Identificação da campanha. Informação fornecedida pela equipe de Onboarding |
usuario required | string Example: 99059662008 CPF do consumidor. |
totalPorPagina required | integer [ 1 .. 100 ] Example: 10 Total de cupons por página. |
paginaAtual required | integer >= 1 Example: 1 Página atual. |
Authorization required | string Token de autorização |
curl --request GET \ --url https://testews.polgo.com.br/polgo/cupom/v2/cupons/consumidor/2024/CAMPANHAPOLGO/12312312300/10/1 \ --header 'Content-Type: application/json' \ --header 'authorization: 000aaa999zzz' \
{- "status": 200,
- "mensagem": "Quantidade de cupons obtida.",
- "retorno": {
- "paginas": 1,
- "total": 1,
- "retorno": {
- "lista": [
- {
- "id": "8d7bf267-189c-4829-8c36-228173273199",
- "campanha": {
- "ano": 2021,
- "identificacao": "MERCADINHO"
}, - "numeroSequencial": 0,
- "numeroAleatorio": "7d2bf200-186f-4889-8c36-668173273124",
- "lote": {
- "id": "3c01f773-e54e-46ee-b8a2-1c37a841b3cd",
- "campanha": {
- "ano": 2021,
- "identificacao": "MERCADINHO"
}, - "associado": {
- "cnpjCpf": "86107442000157",
- "nome": "MERCADO - UNIDADE 02"
}, - "numeracaoInicial": 0,
- "numeracaoFinal": 1,
- "data": "2022-09-09",
- "envioCancelado": false,
- "eventos": [ ]
}, - "documentoFiscal": {
- "campanha": {
- "ano": 2021,
- "identificacao": "MERCADINHO"
}, - "usuario": "58863123879",
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "A11234578BACAADA1AAA",
- "dataHoraEmissao": "2022-08-23 11:04:00",
- "valorTotal": 100000,
- "numSerieImpressora": "",
- "formaPagamento": "ACELERADOR",
- "vendedor": {
- "codigo": "1",
- "nome": "Augusto Mangusto Fernandes"
}
}, - "emitente": {
- "cnpj": "86107442000157",
- "nome": "MERCADO - UNIDADE 02",
- "nomeFantasia": "",
- "telefone": "",
- "municipio": "",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "90"
}, - "destinatario": {
- "cnpjCpf": "58863123879",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [
- {
- "descricao": "Cerveja",
- "quantidade": 10,
- "unidade": "LT",
- "valor": 15,
- "ncm": "",
- "codigo": "A3",
- "cfop": "",
- "codigoEAN": "A3"
}
], - "extra": "Documento de origem em São Paulo - SP",
- "dataHoraLeitura": "2022-09-09 15:17:25",
- "uriImagem": "",
- "id": "dffa6e65-14a8-4839-b7cb-bb8f2edcd2ab"
}, - "consumidor": {
- "id": "e3644878-9bb6-4dd0-8832-5a6f5216cc80",
- "telefone": "58863123879",
- "telefoneContato": "19964826610",
- "nome": "JOAO CONSUMIDOR",
- "dataNascimento": "2002-09-15",
- "genero": "",
- "cpf": "58863123879",
- "rg": "",
- "endereco": {
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "cidade": "",
- "cep": "",
- "estado": ""
}, - "email": "consumidor@email.com",
- "dinamicaCupom": [ ],
- "indicacao": null,
- "eventos": [ ]
}, - "numeroDaSorte": {
- "serie": 17,
- "numero": 75258,
- "dataHoraGeracao": "2022-09-09 15:17:27",
- "dataGeracao": "2022-09-09"
}, - "sorteio": null,
- "premio": null,
- "entrega": null,
- "integradoCC": null,
- "associado": {
- "_id": "61d8b13a7dceea86189271ea",
- "id": "be6e79e9-5b65-4a2e-9795-42ba7f78c4e9",
- "cnpjCpf": "86107442000157",
- "nome": "MERCADO - UNIDADE 02",
- "endereco": {
- "endereco": "AV MERCADO",
- "numero": "73",
- "cep": "00000-000",
- "bairro": "SÃO PEDRO",
- "complemento": "",
- "cidade": "SÃO PAULO",
- "estado": "SP"
}, - "telefone": "1111111111",
- "email": "emailmercado@email.com",
- "eventos": [ ],
- "codigoInterno": "90"
}
}
], - "formasPagamento": [
- {
- "total": 2058,
- "formaPagamento": "ACELERADOR"
}, - {
- "total": 4,
- "formaPagamento": "DINHEIRO"
}
]
}
}
}
O serviço de Raspadinha Alternativa é outra modalidade de premiação oferecida pela plataforma Polgo, sendo possível que Raspadinhas sejam geradas, listadas, raspadas e entregues via PicPay ou Cashback Polgo. Ele se comunicando com o serviço de Documento Fiscal
Esse endpoint serve para listar raspadinhas digitais.
anoCampanha required | |
identificacaoCampanha required | string Example: CAMPANHATESTE Identificação da campanha. Informação fornecedida pela equipe de Onboarding |
totalPorPagina required | integer [ 1 .. 100 ] Example: 10 Indicador da quantidade total de itens por página. |
paginaAtual required | integer >= 1 Example: 1 Indicador da pagina atual. |
dataInicial | string Example: dataInicial=2024-01-31 Data inicial da raspadinha, no formato |
dataFinal | string Example: dataFinal=2024-12-31 Data final da raspadinha, no formato |
tipoFiltro | string Enum: "dataRaspada" "dataCriada" Tipo de filtro para data inicial e final |
usuario | string Example: usuario=73699266488 Consumidor |
nomeUsuario | string Example: nomeUsuario=Eugênio Nome do consumidor |
raspadas | boolean Example: raspadas=true Filtrar apenas raspadinhas já raspadas |
premiadas | boolean Example: premiadas=false Filtrar apenas raspadinhas premiadas |
canceladas | boolean Example: canceladas=false Filtrar apenas raspadinhas canceladas |
entregues | boolean Example: entregues=true Filtrar apenas raspadinhas entregues |
numeroDocumentoFiscal | string Example: numeroDocumentoFiscal=d42d9545-bfe6-4bd6-b58e-b3452236b894 Filtro por número de identificação do documento fiscal |
id | string Example: id=d42d9545-bfe6-4bd6-b58e-b3452236b894 Filtro por identificador único da raspadinha |
statusApuracao | string Enum: "APURADO" "FALTA INFORMAÇÃO" "PENDENTE" Example: statusApuracao=APURADO Filtro por status de apuração |
nomePremio | string Example: nomePremio=VALE COMPRAS Filtro por nome de prêmio |
loja | string Example: loja=79743543000159 Filtro pelo CNPJ que originou a raspadinha, sem caracteres especiais ou pontuação |
ordemPor | string Enum: "dataCriada" "dataRaspada" "dataEntregue" Example: ordemPor=dataCriada Campo para ordenação das raspadinhas a serem retornadas na listagem |
ordemSentido | string Enum: "ASC" "DESC" Example: ordemSentido=DESC Sentido para ordenação das raspadinhas a serem retornadas na listagem |
Authorization required | string Token de autorização |
{- "status": 200,
- "mensagem": "Lista de raspadinhas obtidas com sucesso!",
- "retorno": {
- "paginas": 1,
- "total": 2,
- "retorno": [
- {
- "id": "5ab51b0a-75d4-4c66-bb82-358ade363809",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "raspada": {
- "dataHora": "2022-09-15 11:38:15",
- "usuario": "74273774003",
- "valorDebitado": 0,
- "cedula": null,
- "cupom": {
- "id": "4ea17076-d9c9-4cb3-83b7-24472b27dce3",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "numeroSequencial": 0,
- "numeroAleatorio": "4ea17076-d9c9-4cb3-83b7-24472b27dce3",
- "lote": {
- "id": "4ea17076-d9c9-4cb3-83b7-24472b27dce3",
- "associado": {
- "cnpjCpf": "85985425000150",
- "nome": ""
}, - "numeracaoInicial": 0,
- "numeracaoFinal": 1,
- "data": "2021-01-01",
- "envioCancelado": false
}, - "documentoFiscal": {
- "id": "9b27432d-407c-4c14-b622-e688aa13c786",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "usuario": "74273774003",
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "778899999999",
- "dataHoraEmissao": "2022-08-23 11:04:00",
- "valorTotal": 1000,
- "numSerieImpressora": "",
- "formaPagamento": "ACELERADOR",
- "vendedor": {
- "codigo": "1",
- "nome": "Augusto Fernandes"
}
}, - "emitente": {
- "cnpj": "85985425000150",
- "nome": "",
- "nomeFantasia": "",
- "telefone": "",
- "municipio": "",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "4"
}, - "destinatario": {
- "cnpjCpf": "74273774003",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [ ],
- "extra": "Documento de origem em São Paulo - SP",
- "dataHoraLeitura": "2022-09-15 11:38:09",
- "dataLeitura": "2022-09-15",
- "dataHoraProcessamento": "2022-09-15 11:38:09",
- "imagem": "",
- "uriImagem": "",
- "eventos": [ ],
- "cancelado": false
}, - "consumidor": {
- "id": "b90cfcea-73d7-4ecc-95c1-69fa08a2df2b",
- "telefone": "74273774003",
- "telefoneContato": "19971321834",
- "nome": "João Cleber",
- "dataNascimento": "",
- "genero": "",
- "cpf": "74273774003",
- "rg": "",
- "endereco": {
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "cidade": "",
- "cep": "",
- "estado": ""
}, - "email": "joao@email.com.br",
- "dinamicaCupom": [ ],
- "indicacao": null
}, - "numeroDaSorte": null,
- "sorteio": null,
- "premio": null,
- "entrega": null,
- "integradoCC": null
}, - "compra": null,
- "associado": {
- "cnpjCpf": "85985425000150",
- "nome": ""
}, - "dataHoraRaspada": null,
- "dataRaspada": null
}, - "dataCriada": "2022-09-15",
- "entrega": {
- "dataHora": "2022-09-15 19:12:11",
- "picpay": {
- "transfer_id": "60919c8a6191ba43a451a93a",
- "status": "SUCCEEDED",
- "value": 70,
- "transfered_at": "2022-09-15T19:12:11.333000Z",
- "transaction_id": 22993230,
- "created_at": "2021-05-04T19:12:11.333000Z",
- "erro": false,
- "operacao": "transferencia"
}
}, - "premio": {
- "codigo": "9",
- "descricao": "Prêmio documentação",
- "cashback": true,
- "configuracaoCashback": {
- "tipoCashback": "picpay",
- "campanhaCashbackID": null,
- "diasParaLiberacao": null,
- "diasParaExpiracao": null
}, - "valor": 10,
- "textoOculto": ""
}, - "votada": null,
- "premioCancelado": false,
- "premioCancelamento": null
}, - {
- "id": "6675f283-c247-40de-88c3-a83ed3a2e876",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "raspada": {
- "dataHora": "2022-09-16 08:20:09",
- "usuario": "27616793002",
- "valorDebitado": 0,
- "cedula": null,
- "cupom": {
- "id": "f982e70f-eb88-4051-b72d-d2ae4101836a",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "numeroSequencial": 0,
- "numeroAleatorio": "f982e70f-eb88-4051-b72d-d2ae4101836a",
- "lote": {
- "id": "f982e70f-eb88-4051-b72d-d2ae4101836a",
- "associado": {
- "cnpjCpf": "03995515000400",
- "nome": ""
}, - "numeracaoInicial": 0,
- "numeracaoFinal": 1,
- "data": "2021-01-01",
- "envioCancelado": false
}, - "documentoFiscal": {
- "id": "e925aafa-82e7-4bf6-b44b-5441233ddb97",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "usuario": "27616793002",
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "7788999999999",
- "dataHoraEmissao": "2022-08-23 11:04:00",
- "valorTotal": 1000,
- "numSerieImpressora": "",
- "formaPagamento": "ACELERADOR",
- "vendedor": {
- "codigo": "1",
- "nome": "Augusto Fernandes"
}
}, - "emitente": {
- "cnpj": "03995515000400",
- "nome": "LOJA DO TARDEU",
- "nomeFantasia": "LOJA DO TARDEU",
- "telefone": "19964728465",
- "municipio": "Mogi Guaçu",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "4"
}, - "destinatario": {
- "cnpjCpf": "27616793002",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [ ],
- "extra": "Documento de origem em São Paulo - SP",
- "dataHoraLeitura": "2022-09-16 08:20:02",
- "dataLeitura": "2022-09-16",
- "dataHoraProcessamento": "2022-09-16 08:20:02",
- "imagem": "",
- "uriImagem": "",
- "eventos": [ ],
- "cancelado": false
}, - "consumidor": {
- "id": "b90cfcea-73d7-4ecc-95c1-69fa08a2df2b",
- "telefone": "27616793002",
- "telefoneContato": "19953872910",
- "nome": "HUGO DEL CABRON",
- "dataNascimento": "",
- "genero": "",
- "cpf": "27616793002",
- "rg": "",
- "endereco": {
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "cidade": "",
- "cep": "",
- "estado": ""
}, - "email": "hugodelc@email.com",
- "dinamicaCupom": [ ],
- "indicacao": null
}, - "numeroDaSorte": null,
- "sorteio": null,
- "premio": null,
- "entrega": null,
- "integradoCC": null
}, - "compra": null,
- "associado": {
- "cnpjCpf": "03995515000400",
- "nome": "LOJA DO TARDEU"
}, - "dataHoraRaspada": "2022-09-16 08:21:27",
- "dataRaspada": "2022-09-16"
}, - "dataCriada": "2022-09-16",
- "entrega": {
- "dataHora": "2022-09-16 08:22:04",
- "picPay": null,
- "polgo": null
}, - "premio": {
- "codigo": "9",
- "descricao": "Prêmio lojinha",
- "cashback": true,
- "configuracaoCashback": {
- "tipoCashback": "picpay",
- "campanhaCashbackID": null,
- "diasParaLiberacao": null,
- "diasParaExpiracao": null
}, - "valor": 50,
- "textoOculto": "Vale R$50 na lojinha"
}, - "votada": null,
- "premioCancelado": false,
- "premioCancelamento": null,
- "consumidor": {
- "id": "b90cfcea-73d7-4ecc-95c1-69fa08a2df2b",
- "telefone": "27616793002",
- "telefoneContato": "19953872910",
- "nome": "HUGO DEL CABRON",
- "dataNascimento": "",
- "cpf": "27616793002",
- "email": "hugodelc@email.com"
}
}
]
}
}
Esse endpoint serve para raspar uma raspadinha digital.
idRaspadinha required | string Example: a1b83025-8816-4a49-9c58-6c02a63a8a2c Identificador único da raspadinha digital. |
Authorization required | string Token de autorização |
curl --request GET \ --url https://testews.polgo.com.br/polgo/raspadinhaAlternativa/v1/raspadinhas/raspar/123456789 \ --header 'Content-Type: application/json' \ --header 'authorization: 000aaa999zzz' \
{- "status": 200,
- "mensagem": "Raspadinha raspada com sucesso",
- "retorno": {
- "id": "6675f283-c247-40de-88c3-a83ed3a2e876",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "raspada": {
- "dataHora": "2022-09-16 08:20:09",
- "usuario": "27616793002",
- "valorDebitado": 0,
- "cedula": null,
- "cupom": {
- "id": "f982e70f-eb88-4051-b72d-d2ae4101836a",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "numeroSequencial": 0,
- "numeroAleatorio": "f982e70f-eb88-4051-b72d-d2ae4101836a",
- "lote": {
- "id": "f982e70f-eb88-4051-b72d-d2ae4101836a",
- "associado": {
- "cnpjCpf": "03995515000400",
- "nome": ""
}, - "numeracaoInicial": 0,
- "numeracaoFinal": 1,
- "data": "2021-01-01"
}, - "documentoFiscal": {
- "id": "e925aafa-82e7-4bf6-b44b-5441233ddb97",
- "campanha": {
- "ano": 2021,
- "identificacao": "ALPHA"
}, - "usuario": "27616793002",
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "7788999999999",
- "dataHoraEmissao": "2022-08-23 11:04:00",
- "valorTotal": 1000,
- "numSerieImpressora": "",
- "formaPagamento": "ACELERADOR",
- "vendedor": {
- "codigo": "1",
- "nome": "Augusto Fernandes"
}
}, - "emitente": {
- "cnpj": "03995515000400",
- "nome": "LOJA DO TARDEU",
- "nomeFantasia": "LOJA DO TARDEU",
- "telefone": "19964728465",
- "municipio": "Mogi Guaçu",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "4"
}, - "destinatario": {
- "cnpjCpf": "27616793002",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [ ],
- "extra": "Documento de origem em São Paulo - SP",
- "dataHoraLeitura": "2022-09-16 08:20:02",
- "dataLeitura": "2022-09-16",
- "dataHoraProcessamento": "2022-09-16 08:20:02",
- "imagem": "",
- "uriImagem": "",
- "eventos": [ ],
- "cancelado": false
}, - "consumidor": {
- "id": "b90cfcea-73d7-4ecc-95c1-69fa08a2df2b",
- "telefone": "27616793002",
- "telefoneContato": "19953872910",
- "nome": "HUGO DEL CABRON",
- "dataNascimento": "",
- "genero": "",
- "cpf": "27616793002",
- "rg": "",
- "endereco": {
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "cidade": "",
- "cep": "",
- "estado": ""
}, - "email": "hugodelc@email.com",
- "dinamicaCupom": [ ],
- "indicacao": null
}, - "numeroDaSorte": null,
- "sorteio": null,
- "premio": null,
- "entrega": null,
- "integradoCC": null
}, - "compra": null,
- "associado": {
- "cnpjCpf": "03995515000400",
- "nome": "LOJA DO TARDEU"
}, - "dataHoraRaspada": "2022-09-16 08:21:27",
- "dataRaspada": "2022-09-16"
}, - "dataCriada": "2022-09-16",
- "entrega": {
- "dataHora": "2022-09-16 08:22:04",
- "picPay": null,
- "polgo": null
}, - "premio": {
- "codigo": "9",
- "descricao": "Prêmio lojinha",
- "cashback": true,
- "configuracaoCashback": {
- "tipoCashback": "picpay",
- "campanhaCashbackID": null,
- "diasParaLiberacao": null,
- "diasParaExpiracao": null
}, - "valor": 50,
- "textoOculto": "Vale R$50 na lojinha"
}, - "votada": null,
- "premioCancelado": false,
- "premioCancelamento": null,
- "consumidor": {
- "id": "b90cfcea-73d7-4ecc-95c1-69fa08a2df2b",
- "telefone": "27616793002",
- "telefoneContato": "19953872910",
- "nome": "HUGO DEL CABRON",
- "dataNascimento": "",
- "genero": "",
- "cpf": "27616793002",
- "rg": "",
- "endereco": {
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "cidade": "",
- "cep": "",
- "estado": ""
}, - "email": "hugodelc@email.com",
- "eventos": [ ]
}
}
}
Esse endpoint serve para marcar como entregue o prêmio de uma raspadinha digital.
idRaspadinha required | string Example: a3fa0918-de19-4616-a417-ddfa4bf76490 Identificador único da raspadinha digital. |
Authorization required | string Token de autorização |
{- "status": 200,
- "mensagem": "Prêmio de raspadinha entregue com sucesso!",
- "retorno": {
- "id": "a3fa0918-de19-4616-a417-ddfa4bf76490",
- "campanha": {
- "ano": 2021,
- "identificacao": "CAMPANHATESTE"
}, - "raspada": {
- "dataHora": "2021-07-12 10:00:00",
- "usuario": "77739267198",
- "valorDebitado": 50,
- "cedula": null,
- "cupom": {
- "id": "2c01caa1-d009-4612-b166-69711e77e7a5",
- "campanha": {
- "ano": 2021,
- "identificacao": "CAMPANHATESTE"
}, - "numeroSequencial": 0,
- "numeroAleatorio": "2c01caa1-d009-4612-b166-69711e77e7a5",
- "lote": {
- "id": "2c01caa1-d009-4612-b166-69711e77e7a5",
- "associado": {
- "cnpjCpf": "98962959085698",
- "nome": "ASSOCIADO DE TESTE"
}, - "numeracaoInicial": 0,
- "numeracaoFinal": 1,
- "data": "2021-01-01",
- "envioCancelado": false
}, - "documentoFiscal": {
- "id": "048fc872-6704-49f1-ab0c-0bbaa3f9a92c",
- "campanha": {
- "ano": 2021,
- "identificacao": "CAMPANHATESTE"
}, - "usuario": "77739267198",
- "cabecalho": {
- "chaveAcesso": "",
- "coo": "12345",
- "dataHoraEmissao": "2021-04-01 11:03:44",
- "valorTotal": 111.11,
- "numSerieImpressora": "",
- "formaPagamento": "",
- "vendedor": {
- "codigo": "0310",
- "nome": "Edward Elric"
}
}, - "emitente": {
- "cnpjCpf": "98962959085698",
- "nome": "ASSOCIADO DE TESTE",
- "nomeFantasia": "",
- "telefone": "",
- "municipio": "",
- "uf": "SP",
- "inscricaoEstadual": "",
- "inscricaoMunicipal": "",
- "cnae": "",
- "regimeTributario": "",
- "codigoInterno": "7"
}, - "destinatario": {
- "cnpjCpf": "51556845529",
- "nome": "",
- "telefone": "",
- "municipio": "",
- "uf": "",
- "email": ""
}, - "produtosServicos": [
- {
- "descricao": "DUCHA PRETO/CR 127V",
- "quantidade": "1.000",
- "unidade": "",
- "valor": 529.9,
- "ncm": "",
- "codigo": "12345",
- "cfop": "",
- "codigoEAN": ""
}, - {
- "descricao": "CONECTOR 6MM",
- "quantidade": "1.000",
- "unidade": "",
- "valor": 6.9,
- "ncm": "",
- "codigo": "54321",
- "cfop": "",
- "codigoEAN": ""
}
], - "extra": null,
- "dataHoraLeitura": "2021-07-13 08:57:40",
- "dataLeitura": "2021-07-13",
- "dataHoraProcessamento": "2021-07-13 08:57:40",
- "imagem": "",
- "uriImagem": "",
- "eventos": [ ],
- "cancelado": false
}, - "consumidor": {
- "id": "4df0a833-a6a2-4cd8-93ce-3e3f9d14bd8e",
- "telefone": "77739267198",
- "telefoneContato": "19999999999",
- "nome": "CONSUMIDORA DE TESTE",
- "dataNascimento": "1970-03-12",
- "genero": "feminino",
- "cpf": "77739267198",
- "rg": "12.345.678-9",
- "endereco": {
- "endereco": "RUA DE TESTE",
- "numero": "100",
- "complemento": "CASA",
- "bairro": "JD. DE TESTE",
- "cidade": "TESTE",
- "cep": "13999-000",
- "estado": "SP"
}, - "email": "consu@midora.com.br",
- "dinamicaCupom": [ ],
- "indicacao": null
}, - "numeroDaSorte": null,
- "sorteio": null,
- "premio": null,
- "entrega": null,
- "integradoCC": null
}, - "compra": null,
- "associado": {
- "cnpjCpf": "98962959085698",
- "nome": "ASSOCIADO DE TESTE"
}, - "dataHoraRaspada": "2021-07-12 10:13:08",
- "dataRaspada": "2021-07-12"
}, - "dataCriada": "2021-07-12",
- "entrega": {
- "dataHora": "2021-07-12 10:06:51",
- "picPay": null,
- "polgo": null
}, - "premio": {
- "codigo": "9",
- "descricao": "Prêmio documentação",
- "cashback": true,
- "configuracaoCashback": {
- "tipoCashback": "picpay",
- "campanhaCashbackID": null,
- "diasParaLiberacao": null,
- "diasParaExpiracao": null
}, - "valor": 10,
- "textoOculto": ""
}, - "votada": null,
- "premioCancelado": false,
- "premioCancelamento": null,
- "eventos": [ ]
}
}