Polgo | Documentação (1.98.14)

Download OpenAPI specification:Download

Introdução 🧑‍💻

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.

Login

Cadastro, autenticação e troca de senha.

Pré-cadastro consumidor: o administrador cria o login com preCadastro: true (sem senha). O PWA verifica o usuário, envia OTP, valida o código e conclui o cadastro em POST /logins.

Login sem senha (passwordless): OTP por e-mail ou SMS quando a campanha vigente tem login2FA ou preRegistro ativo e os gatilhos CRM enviarcodigootp:email / enviarcodigootp:sms estão configurados no ServicoNotificacao.

Autenticação de usuários

Esse endpoint serve para autenticar um usuário.

Request Body schema: application/json

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.

Responses

Request samples

Payload
cURL

Content type

application/json

{"usuario": "polgo",
"senha": "123456789"
}

Response samples

200
401

Content type

application/json

{"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",
"autenticacao2FA": {"configurado": true,
"permissoes": ["polgo_entregar_premio"
]
}
}
}

Criação de usuário

Cria um login na plataforma.

Pré-cadastro (admin): com token de administrador e preCadastro: true, cria consumidor sem senha e sem disparar eventos. O consumidor conclui o cadastro no PWA após validar OTP (POST /logins/preCadastro/validarCodigo) enviando codigo, canal, senha e demais campos obrigatórios.

Conclusão de pré-cadastro (PWA): envie codigo (OTP validado) e canal junto aos dados do cadastro. A senha passa a ser obrigatória neste fluxo.

Importação em massa (Dashboard): cada linha da planilha vira um POST com token admin. Colunas: usuario, senha, nome, tipo, email, telefoneContato, preCadastro (apenas consumidor; sim/true/1 cria sem senha — exige e-mail e/ou telefoneContato).

Request Body schema: application/json

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. Obrigatória quando tipoAutenticacao for senha (padrão).
tipoAutenticacao	string Enum: "senha" "codigo" Método de autenticação. "senha" (padrão) ou "codigo" (passwordless — senha pode ser omitida).
preCadastro	boolean Quando true e token admin, cria pré-cadastro sem senha e sem disparar eventos.
codigo	string Código OTP de 6 dígitos para conclusão de pré-cadastro pelo PWA.
canal	string Enum: "email" "sms" Canal utilizado no envio do OTP (email ou sms).
email	string E-mail do novo usuário.
telefoneContato	string Telefone de contato (DDD + número). Obrigatório no pré-cadastro de consumidor quando não houver e-mail. Usado na importação de planilha e no cadastro manual pelo Dashboard.
resposta	string Campo livre, identificando resposta preenchida pelo usuário.
extra	string Campo livre para informações adicionais do usuário.
utm_source	string Representa a origem do tráfego, indicando de qual site, anunciante ou publicação o usuário veio. Limitado a 64 caracteres
utm_medium	string Representa a mídia de publicidade ou marketing usada para chegar ao site. Limitado a 64 caracteres
utm_campaign	string Define o nome da campanha que contextualiza a origem do tráfego. Limitado a 64 caracteres
utm_term	string Representa a palavra-chave utilizado na origem do tráfego. Limitado a 128 caracteres
	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.

Responses

Request samples

Payload
cURL

Content type

application/json

{"usuario": "51525032984",
"nome": "POLGO DA SILVA",
"tipo": "consumidor",
"senha": "123456",
"email": "teste@mail.com.br",
"extra": "CAMPO LIVRE",
"utm_source": "google",
"utm_medium": "banner",
"utm_campaign": "megaganhos",
"utm_term": "campanha+promocional+polgo",
"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"
}
}

Response samples

201

Content type

application/json

{"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"
}
}
]
}
}

Trocar senha pelo usuario

Esse endpoint serve para trocar a senha pelo usuario.

header Parameters

Authorization

required

string

Token de autorização.

Request Body schema: application/json

Campos para conseguir redefinir senha.

senhaAtual	string non-empty Senha atual do usuário.
novaSenha	string non-empty Nova senha do usuário.

Responses

Request samples

Payload

Content type

application/json

{"senhaAtual": "abcdef",
"novaSenha": "123456"
}

Response samples

200
400
401

Content type

application/json

{"status": 200,
"mensagem": "Senha trocada com sucesso.",
"retorno": true
}

Verificar usuário

Verificar se usuário está cadastrado no sistema. Quando o login está em pré-cadastro, retorna preCadastro: true e canais de contato mascarados.

Para consumidores existentes, também informa o tipo de autenticação e se é necessário definir senha inicial (migração quando passwordless=false e o login foi cadastrado com OTP sem senha).

path Parameters

usuario

required

any

Usuário que será consultado nesta operação.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Response samples

200
401
403

Content type

application/json

{"status": 200,
"mensagem": "Login encontrado.",
"retorno": {"existe": true,
"preCadastro": false,
"tipoAutenticacao": "codigo",
"possuiSenha": false,
"requerDefinirSenhaInicial": true,
"campanhaPasswordless": false,
"campanhaLogin2FA": false,
"exigeEscolhaMetodoLogin": false,
"canais": {"email": "j***@gmail.com",
"telefoneContato": "(**) *****-1234"
}
}
}

Definir senha inicial com código OTP

Valida um código OTP previamente enviado e define a senha inicial do consumidor.

Destinado a campanhas com passwordless desligado (passwordless=false) em que o login foi cadastrado com tipoAutenticacao: codigo e ainda não possui senha (requerDefinirSenhaInicial: true em GET /logins/verificar/{usuario}).

Fluxo típico no PWA:

GET /logins/verificar/{usuario} → requerDefinirSenhaInicial: true
POST /passwordless/login/solicitar → envia OTP de migração
POST /logins/definir-senha-inicial → valida OTP, grava senha e retorna JWT

Retorna 400 se a campanha vigente tiver passwordless ativo (deve usar POST /passwordless/login/validar). Retorna 403 se o usuário já possuir senha cadastrada.

Request Body schema: application/json

usuario required	string CPF/CNPJ do login.
codigo required	string = 6 characters Código OTP de 6 dígitos.
senha required	string Nova senha a ser definida.

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"codigo": "string",
"senha": "string"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"token": "string",
"login": { }
}
}

Enviar código OTP de pré-cadastro

Envia ou reenvia OTP para conclusão de pré-cadastro criado pelo administrador (preCadastro: true).

O contato é obtido do cadastro do login conforme o canal (email ou sms).

Aceita canalEnvio ou canal no body.

Pré-requisitos: gatilhos CRM enviarcodigootp:email / enviarcodigootp:sms configurados no ServicoNotificacao.

Fluxo típico no PWA:

GET /logins/verificar/{usuario} → preCadastro: true e canais mascarados
Este endpoint → OTP
POST /logins/preCadastro/validarCodigo → valida OTP e retorna dados para pré-preenchimento
POST /logins com codigo, canal e demais campos → conclui o cadastro

Request Body schema: application/json

usuario required	string CPF/CNPJ do login em pré-cadastro.
canal required	string Enum: "email" "sms" Canal de envio do OTP.
canalEnvio	string Enum: "email" "sms" Alias de `canal`.

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"canal": "email",
"canalEnvio": "email"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"segundosRestantes": 0
}
}

Validar código OTP de pré-cadastro

Valida o OTP enviado para um login em pré-cadastro e retorna os dados para pré-preenchimento do formulário de cadastro no PWA.

Limite de 5 tentativas por código; após isso é necessário solicitar novo envio em POST /logins/preCadastro/enviarCodigo.

Não retorna JWT — a conclusão do cadastro ocorre em POST /logins com codigo, canal, senha e demais campos obrigatórios.

Request Body schema: application/json

usuario required	string CPF/CNPJ do login em pré-cadastro.
codigo required	string Código OTP de 6 dígitos.

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"codigo": "string"
}

Response samples

200

Content type

application/json

{"status": 200,
"mensagem": "Código validado com sucesso.",
"retorno": {"codigoValido": true,
"nome": "MARIA SILVA",
"email": "maria@email.com",
"telefoneContato": "11999887766"
}
}

Listar canais OTP do tenant (cadastro)

Retorna os canais de envio de OTP configurados no cliente via gatilhos CRM do ServicoNotificacao.

enviarcodigootp:sms — habilita canal sms
enviarcodigootp:email — habilita canal email

Requer campanha vigente com login2FA ou preRegistro ativo. Endpoint público (sem JWT), com rate limit do fluxo passwordless.

O PWA cruza esta lista com e-mail/telefone preenchidos no formulário de cadastro.

Responses

Request samples

cURL

curl --request GET \
--url 'https://testews.polgo.com.br/polgo/login/v1/passwordless/canais-configurados'

Response samples

200

Content type

application/json

Example

habilitado

{"status": 200,
"mensagem": "Canais OTP do tenant obtidos com sucesso.",
"retorno": {"habilitado": true,
"canais": ["email",
"sms"
]
}
}

Listar canais OTP do usuário (login)

Retorna canais elegíveis para um login existente com tipoAutenticacao codigo, com contato mascarado.

O identificador em {usuario} pode ser CPF/CNPJ, e-mail ou telefone cadastrado.

envioAutomatico: true quando há exatamente um canal elegível (tenant + contatos do login).

Requer gatilhos CRM enviarcodigootp:sms e/ou enviarcodigootp:email ativos. Endpoint público, com rate limit.

path Parameters

usuario

required

string

CPF/CNPJ, e-mail ou telefone do login.

Responses

Request samples

cURL

curl --request GET \
--url 'https://testews.polgo.com.br/polgo/login/v1/passwordless/canais/03825768023'

Response samples

200

Content type

application/json

{"status": 200,
"mensagem": "Canais obtidos com sucesso.",
"retorno": {"canais": [{"tipo": "email",
"contatoMascarado": "t***@exemplo.com"
}
],
"envioAutomatico": true
}
}

Iniciar cadastro passwordless

Gera código OTP de 6 dígitos e dispara envio pelo canal informado.

Pré-requisitos

Campanha vigente com login2FA ativo
Gatilho CRM correspondente ativo: enviarcodigootp:email ou enviarcodigootp:sms
Mensagem do gatilho com placeholder #codigo (no e-mail, assunto obrigatório)

Canais suportados: email e sms (WhatsApp não faz parte deste fluxo).

Endpoint público (sem JWT), com rate limit.

Request Body schema: application/json

canal required	string Enum: "email" "sms" Canal de envio do OTP.
contato required	string E-mail (canal email) ou telefone (canal sms).
usuario	string Identificador do login; se omitido, usa o valor de contato.

Responses

Request samples

Payload
cURL

Content type

application/json

{"canal": "email",
"contato": "string",
"usuario": "string"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"segundosRestantes": 0,
"usuario": "string"
}
}

Confirmar cadastro passwordless

Valida o código OTP, cria login com tipoAutenticacao codigo (senha nula), cria consumidor e retorna JWT.

Em ambiente de teste, o código master pode ser utilizado conforme INTERNO_LOGIN_CODIGO_AUTENTICACAO_MASTER_TEST.

Endpoint público, com rate limit.

Request Body schema: application/json

usuario required	string
codigo required	string Código OTP de 6 dígitos.
nome required	string
email	string
telefoneContato	string
consumidor	object
endereco	object
dataNascimento	string
genero	string
rg	string
documentoVariavel	string
aceitaNotificacao	boolean
primeiraLoja	string
resposta	string
extra	string
utm_source	string
utm_medium	string
utm_campaign	string
utm_term	string

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"codigo": "string",
"nome": "string",
"email": "string",
"telefoneContato": "string",
"consumidor": { },
"endereco": { },
"dataNascimento": "string",
"genero": "string",
"rg": "string",
"documentoVariavel": "string",
"aceitaNotificacao": true,
"primeiraLoja": "string",
"resposta": "string",
"extra": "string",
"utm_source": "string",
"utm_medium": "string",
"utm_campaign": "string",
"utm_term": "string"
}

Response samples

201

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"token": "string",
"login": {"tipoAutenticacao": "senha"
}
}
}

Reenviar código do cadastro passwordless

Gera novo OTP após o cooldown de 60 segundos. Exige gatilho CRM ativo para o canal informado.

Aceita canalEnvio ou canal no body (mesmo significado).

Request Body schema: application/json

usuario required	string
canalEnvio required	string Enum: "email" "sms"
canal	string Enum: "email" "sms" Alias de canalEnvio.
contato	string E-mail ou telefone de destino do OTP. Obrigatório quando `usuario` for CPF/CNPJ e o canal for `email` ou `sms`. Se omitido, `usuario` é usado como contato (compatível com cadastros em que o identificador já é o e-mail ou telefone).

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"canalEnvio": "email",
"canal": "email",
"contato": "string"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"segundosRestantes": 0
}
}

Solicitar código de login passwordless

Envia OTP para login existente. O contato é obtido do cadastro do login conforme o canal.

Com passwordless=true: qualquer consumidor ativo pode solicitar OTP (inclusive quem já possui senha; a senha é ignorada no login).

Com passwordless=false: apenas consumidores com tipoAutenticacao: codigo sem senha (migração) podem solicitar OTP. Usuários com senha devem usar POST /autenticacao ou login 2FA.

Aceita canalEnvio ou canal no body.

Pré-requisitos: gatilho CRM enviarcodigootp:* do canal.

Request Body schema: application/json

usuario required	string CPF/CNPJ, e-mail ou telefone do login.
canalEnvio required	string Enum: "email" "sms"
canal	string Enum: "email" "sms" Alias de canalEnvio.

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"canalEnvio": "email",
"canal": "email"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"segundosRestantes": 0
}
}

Validar código de login passwordless

Valida OTP e retorna JWT. Limite de 5 tentativas por código; após isso é necessário reenviar.

Com passwordless=true: aceita qualquer consumidor ativo, inclusive tipoAutenticacao: senha.

Com passwordless=false: retorna 403 orientando o fluxo de criação de senha (POST /logins/definir-senha-inicial) para usuários codigo sem senha.

Request Body schema: application/json

usuario required	string
codigo required	string

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"codigo": "string"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"token": "string",
"login": { }
}
}

Reenviar código de login passwordless

Reenvia OTP para login passwordless após cooldown de 60 segundos.

Aceita canalEnvio ou canal no body.

Request Body schema: application/json

usuario required	string
canalEnvio required	string Enum: "email" "sms"
canal	string Enum: "email" "sms"

Responses

Request samples

Payload

Content type

application/json

{"usuario": "string",
"canalEnvio": "email",
"canal": "email"
}

Response samples

200

Content type

application/json

{"status": 0,
"mensagem": "string",
"retorno": {"segundosRestantes": 0
}
}

Consumidor

O serviço de Consumidor permite o cadastro e consulta de consumidores dentro de nossa plataforma.

Listar consumidores

Endpoint para listar os consumidores cadastrados em nossa base.

path Parameters

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.

query Parameters

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 `YYYY-MM-DD HH:mm:ss`.
filtroDataHoraAtualizacaoInicial	string Example: filtroDataHoraAtualizacaoInicial=2022-08-15 00:00:00 Data-hora inicial de atualização de usuários, no formato `YYYY-MM-DD HH:mm:ss`.
filtroDataHoraAtualizacaoFinal	string Example: filtroDataHoraAtualizacaoFinal=2022-08-17 00:00:00 Data-hora final de atualização de usuários, no formato `YYYY-MM-DD HH:mm:ss`.
filtroCadastroInicial	string Example: filtroCadastroInicial=true Caso verdadeiro, retorna consumidores com o campo cadastroInicial true, se não false.
filtro[status]	string Default: "ativos" Enum: "ativos" "inativos" "todos" Example: filtro[status]=todos Filtra consumidores pelo status de ativação. Valores aceitos: `ativos` (padrão) - retorna apenas consumidores ativos. `inativos` - retorna apenas consumidores inativos. `todos` - retorna todos os consumidores, independente do status.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Request samples

cURL

curl --request GET \
--url https://testews.polgo.com.br/polgo/consumidor/v1/consumidores/100/1 \
--header 'Content-Type: application/json' \
--header 'authorization: 000aaa999zzz'

Response samples

200
401
403

Content type

application/json

{"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",
"inativo": false,
"dataHoraInativacao": null,
"motivoInativacao": "",
"usuarioInativacao": ""
}
]
}
}

Documento Fiscal

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

Inserir nova venda

Endpoint responsável em gravar novas vendas.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Request Body schema: application/json

usuario required	string CPF/CNPJ do usuário da venda
numeroDocumento required	string Identificador único da venda. Exemplo: Chave de acesso ou código de controle interno'
dataHoraEmissao required	string Data e hora da emissão no formato `YYYY-MM-DD HH:mm:ss`
valorTotal required	number <double> Valor total da venda
cnpjEmitente required	string CNPJ do emitente. Informar campo `cnpjEmitente` ou `codigoEmitente`
codigoEmitente required	string Código interno do emitente. Informar campo `cnpjEmitente` ou `codigoEmitente`
	object Estrutura com informações da campanha. Informação fornecida pela equipe de Onboarding
	object Grupo de produtos utilizados na venda
formaPagamento	string Formas de pagamentos utilizadas na venda. Agrupar informações por vírgula. Exemplo: `DINHEIRO,CARTAO`'
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

Responses

Request samples

Payload
cURL

Content type

application/json

{"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",
"categoria": ["BEBIDAS",
"ALCOOLICAS"
]
},
{"descricao": "Produto 2",
"unidade": "KG",
"quantidade": 2,
"valor": 10.1,
"codigo": "321456",
"categoria": ["ALIMENTOS"
]
},
{"descricao": "Produto 3",
"unidade": "KG",
"quantidade": 1.563,
"valor": 3.21,
"codigo": "321654"
}
],
"vendedor": {"codigo": "123123",
"nome": "VENDEDOR polgo"
},
"consumidor": {"nome": "CONSUMIDOR POLGO"
}
}

Response samples

201
401
403

Content type

application/json

{"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": "",
"categoria": ["BEBIDAS",
"ALCOOLICAS"
],
"extra": ""
},
{"descricao": "Produto 2",
"quantidade": 2,
"unidade": "KG",
"valor": 10.1,
"ncm": "",
"codigo": "321456",
"cfop": "",
"codigoEAN": "",
"categoria": ["ALIMENTOS"
],
"extra": ""
},
{"descricao": "Produto 3",
"quantidade": 1.563,
"unidade": "KG",
"valor": 3.21,
"ncm": "",
"codigo": "321654",
"cfop": "",
"codigoEAN": "",
"extra": ""
}
],
"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"
}
}
}

Cancelar venda

Endpoint serve para cancelar uma venda. Pode ser informado o ID do documento fiscal ou o número de identificação da venda (COO ou Número de Identificação).

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Request Body schema: application/json

Dados para cancelar uma venda.

idDocumentoFiscal	string Identificador único da venda Fornecido pelo endpoint de inserir uma nova venda
numeroIdentificacao	string Número da venda. COO ou Número de Identificação do documento fiscal

Responses

Request samples

Payload
cURL

Content type

application/json

{"idDocumentoFiscal": "31b83745-3d5b-4a1a-b533-dd670ca9079a"
}

Response samples

200
401
403

Content type

application/json

{"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": "",
"extra": ""
},
{"descricao": "PRODUTO 2",
"quantidade": 1,
"unidade": "KG",
"valor": 100,
"ncm": "",
"codigo": "321",
"cfop": "",
"codigoEAN": "",
"extra": ""
}
],
"extra": null,
"dataHoraLeitura": "2021-12-01 09:13:00",
"dataLeitura": "2021-12-01",
"dataHoraProcessamento": null,
"imagem": "",
"uriImagem": "",
"cancelado": true
}
}

Listagem de vendas

Endpoint serve para obter a listagem de vendas.

path Parameters

totalPorPagina required	integer [ -1 .. 100 ] Example: 100 Indicador da quantidade total de itens por página Ao utilizar o valor `-1`, todos os registros serão listados
paginaAtual required	integer >= 1 Example: 1 Indicador da pagina atual

query Parameters

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
dataInicioEmissao	string <date> Example: dataInicioEmissao=2024-06-01 Data inicial da emissão da venda
dataFimEmissao	string <date> Example: dataFimEmissao=2024-06-30 Data final da emissão da venda
dataInicioProcessamento	string <date> Example: dataInicioProcessamento=2024-06-01 Data inicial de processamento da venda
dataFinalProcessamento	string <date> Example: dataFinalProcessamento=2024-06-30 Data final de processamento da venda
dataInicioLeitura	string <date> Example: dataInicioLeitura=2024-06-01 Data inicial da leitura da venda
dataFinalLeitura	string <date> Example: dataFinalLeitura=2024-06-30 Data final da leitura da venda
codigoProduto	string Example: codigoProduto=123456 Código do produto da venda
apenasProcessadas	boolean Example: apenasProcessadas=true Indica se deve retornar apenas vendas processadas
formaPagamento	string Example: formaPagamento=DINHEIRO Forma de pagamento da venda

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Request samples

cURL

curl --request GET \
--url https://testews.polgo.com.br/polgo/documentoFiscal/v1/documentos/1/1 \
--header 'Content-Type: application/json' \
--header 'authorization: 000aaa999zzz'

Response samples

200
401
403

Content type

application/json

{"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": "",
"extra": ""
},
{"descricao": "Produto 2",
"quantidade": 2,
"unidade": "KG",
"valor": 10.1,
"ncm": "",
"codigo": "321456",
"cfop": "",
"codigoEAN": "",
"extra": ""
},
{"descricao": "Produto 3",
"quantidade": 1.563,
"unidade": "KG",
"valor": 3.21,
"ncm": "",
"codigo": "321654",
"cfop": "",
"codigoEAN": "",
"extra": ""
}
],
"dataHoraLeitura": "2021-07-14 11:03:16",
"dataLeitura": "2021-07-14",
"dataHoraProcessamento": null,
"imagem": "",
"uriImagem": "",
"consumidor": {"nome": "CONSUMIDOR POLGO"
}
}
]
}
}

Cupom

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

Listar cupons por campanha

Esse endpoint serve para listar os cupons gerados com base em uma campanha.

path Parameters

anoCampanha required	integer Example: 2024 Ano da campanha. Informação fornecedida pela equipe de Onboarding
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. Ao passar `-1`, todos os registros serão retornados
paginaAtual required	integer >= 1 Example: 1 Indicador da pagina atual.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Request Body schema: application/json

object

Estrutura com parâmetros de filtragem.

Responses

Request samples

Payload
cURL

Content type

application/json

{"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"
}
}

Response samples

200
401
403

Content type

application/json

{"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
}
]
}
}

Listar cupons de um consumidor

Lista os cupons de um consumidor em uma campanha. O parâmetro de rota usuario é o usuário do consumidor (identificador usado na plataforma), em geral CPF (pessoa física) ou CNPJ (pessoa jurídica), somente números, sem máscara.

path Parameters

anoCampanha required	integer Example: 2022 Ano da campanha. Informação fornecedida pela equipe de Onboarding
identificacaoCampanha required	string Example: CAMPANHAPOLGO Identificação da campanha. Informação fornecedida pela equipe de Onboarding
usuario required	string Example: 33893529020 Usuário do consumidor (identificador na plataforma), em geral CPF ou CNPJ, somente números, sem pontuação.
totalPorPagina required	integer [ 1 .. 100 ] Example: 10 Total de cupons por página.
paginaAtual required	integer >= 1 Example: 1 Página atual.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Request samples

cURL

curl --request GET \
--url https://testews.polgo.com.br/polgo/cupom/v2/cupons/consumidor/2024/CAMPANHAPOLGO/33893529020/10/1 \
--header 'Content-Type: application/json' \
--header 'authorization: 000aaa999zzz' \

Response samples

200
401
403

Content type

application/json

{"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": "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"
}
]
}
}
}

Raspadinha Alternativa

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 comunica com o serviço de Documento Fiscal

Listar raspadinhas por campanha

Esse endpoint serve para listar raspadinhas digitais.

path Parameters

anoCampanha required	integer Example: 2024 Ano da campanha. Informação fornecedida pela equipe de Onboarding
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.

query Parameters

dataInicial	string Example: dataInicial=2024-01-31 Data inicial da raspadinha, no formato `YYYY-MM-DD`
dataFinal	string Example: dataFinal=2024-12-31 Data final da raspadinha, no formato `YYYY-MM-DD`.
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

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Response samples

200
401
403

Content type

application/json

{"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": "19999999999",
"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"
}
}
]
}
}

Raspar raspadinha digital

Esse endpoint serve para raspar uma raspadinha digital.

path Parameters

idRaspadinha

required

string

Example: a1b83025-8816-4a49-9c58-6c02a63a8a2c

Identificador único da raspadinha digital.

query Parameters

extra

string

Example: extra=Raspadinha entregue por um lojista

Quando informado, irá ficar dentro das informações de entrega da raspadinha.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Request samples

cURL

curl --request GET \
--url https://testews.polgo.com.br/polgo/raspadinhaAlternativa/v1/raspadinhas/raspar/123456789 \
--header 'Content-Type: application/json' \
--header 'authorization: 000aaa999zzz' \

Response samples

200
401
403

Content type

application/json

{"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": [ ]
}
}
}

Marcar prêmio da raspadinha como entregue

Esse endpoint serve para marcar como entregue o prêmio de uma raspadinha digital.

path Parameters

idRaspadinha

required

string

Example: a3fa0918-de19-4616-a417-ddfa4bf76490

Identificador único da raspadinha digital.

header Parameters

Authorization

required

string

Token de autorização
Fornecido pelo endpoint de autenticação de usuários.

Responses

Response samples

200
401
403

Content type

application/json

{"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": "",
"extra": "127v"
},
{"descricao": "CONECTOR 6MM",
"quantidade": "1.000",
"unidade": "",
"valor": 6.9,
"ncm": "",
"codigo": "54321",
"cfop": "",
"codigoEAN": "",
"extra": "6mm"
}
],
"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": [ ]
}
}

Campanha

Consulta de campanhas cadastradas na plataforma (ano e identificação usados em Cupom, Documento Fiscal e demais serviços).

Listar campanhas cadastradas

Esse endpoint serve para retornar as campanhas cadastradas na plataforma Polgo.

header Parameters

Authorization

required

string

Token de autorização.

Responses

Response samples

200
404

Content type

application/json

{"status": 200,
"mensagem": "Lista de campanhas recuperada.",
"retorno": [{"id": "86a8389d-0459-4724-b61a-ce18728d94ba",
"ano": 2020,
"identificacao": "CAMPANHAQR2",
"descricao": "CAMPANHAQR2",
"series": [{"numero": 0,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 1,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 2,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 3,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 4,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 5,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 6,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 7,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 8,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 9,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
}
],
"dataInicial": "2020-01-01",
"dataFinal": "2020-12-31",
"dataFinalCompras": "2020-12-25",
"dataFinalCadastros": "2020-12-25",
"sorteios": [{"id": "fa5c77ce-87ac-481f-9660-18d8d2a153ac",
"data": "2022-07-22",
"serieSorteada": 0,
"numeroBase": 41234,
"premios": [{"numero": 1,
"descricao": "VALE 10 POLGO",
"cashback": {"tipoCashback": "polgo",
"valor": 10,
"campanhaCashbackID": "cca9770d-1166-4b5a-92a4-0416a6ef41c9",
"diasParaLiberacao": 10,
"diasParaExpiracao": 30
},
"valor": null,
"descricaoRecibo": null
}
],
"dataHoraCorteSorteio": "2022-07-21 23:59:59",
"sorteioLoteriaFederal": {"concurso": 5501,
"data": "2022-07-22"
},
"serie": {"inicial": 1,
"final": 2
},
"finalizado": true
}
],
"urlRegulamento": "",
"ativa": true,
"mandataria": null,
"certificadoAutorizacao": null,
"numeroProcesso": null,
"totalCupons": 1000000,
"eventos": [ ]
},
{"id": "fcf614dc-82e7-44e5-bab6-4c8b5700bc38",
"ano": 2019,
"identificacao": "CAMPANHAQR1",
"descricao"": "CAMPANHAQR1",
"series"": [{"numero": 0,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 1,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 2,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 3,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 4,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 5,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 6,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 7,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 8,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 9,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
}
],
"dataInicial": "2019-01-01",
"dataFinal": "2019-12-31",
"dataFinalCompras": "2019-12-25",
"dataFinalCadastros": "2019-12-25",
"sorteios": [{"id": "fa5c77ce-87ac-481f-9660-18d8d2a153ac",
"data": "2022-07-22",
"serieSorteada": 0,
"numeroBase": 41234,
"premios": [{"numero": 1,
"descricao": "VALE 10 POLGO",
"cashback": {"tipoCashback": "polgo",
"valor": 10,
"campanhaCashbackID": "cca9770d-1166-4b5a-92a4-0416a6ef41c9",
"diasParaLiberacao": 10,
"diasParaExpiracao": 30
},
"valor": null,
"descricaoRecibo": null
}
],
"dataHoraCorteSorteio": "2022-07-21 23:59:59",
"sorteioLoteriaFederal": {"concurso": 5501,
"data": "2022-07-22"
},
"serie": {"inicial": 1,
"final": 2
},
"finalizado": true
}
],
"urlRegulamento": "",
"ativa": true,
"mandataria": null,
"certificadoAutorizacao": null,
"numeroProcesso": null,
"totalCupons": 1000000,
"eventos": [ ]
}
]
}

Listar campanhas de um ano

Esse endpoint serve para retornar as campanhas do ano passado por parâmetro cadastradas na plataforma Polgo.

path Parameters

ano

required

integer

Example: 2021

Ano que será filtrado.

header Parameters

Authorization

required

string

Token de autorização.

Responses

Response samples

200
404

Content type

application/json

{"status": 200,
"mensagem": "Lista de campanhas recuperada.",
"retorno": [{"id": "6f6f87ba-07ba-4b84-ab39-d87c49fa9a7a",
"ano": 2022,
"identificacao": "CAMPANHAQR20221",
"descricao": "CAMPANHAQR20221",
"series": [{"numero": 0,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 1,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 2,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 3,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 4,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 5,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 6,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 7,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 8,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 9,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
}
],
"dataInicial": "2022-01-01",
"dataFinal": "2022-12-31",
"dataFinalCompras": "2022-12-25",
"dataFinalCadastros": "2022-12-25",
"sorteios": [{"id": "fa5c77ce-87ac-481f-9660-18d8d2a153ac",
"data": "2022-07-22",
"serieSorteada": 0,
"numeroBase": 41234,
"premios": [{"numero": 1,
"descricao": "VALE 10 POLGO",
"cashback": {"tipoCashback": "polgo",
"valor": 10,
"campanhaCashbackID": "cca9770d-1166-4b5a-92a4-0416a6ef41c9",
"diasParaLiberacao": 10,
"diasParaExpiracao": 30
}
}
],
"dataHoraCorteSorteio": "2022-07-21 23:59:59",
"sorteioLoteriaFederal": {"concurso": 5501,
"data": "2022-07-22"
},
"serie": {"inicial": 1,
"final": 2
},
"finalizado": true
}
],
"urlRegulamento": "",
"ativa": true,
"totalCupons": 1000000,
"eventos": [ ]
},
{"id": "ac69a118-f557-4763-8b84-5e214be831a1",
"ano": 2022,
"identificacao": "CAMPANHAQR20222",
"descricao"": "CAMPANHAQR20222",
"series"": [{"numero": 0,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 1,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 2,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 3,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 4,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 5,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 6,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 7,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 8,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
},
{"numero": 9,
"numeracaoInicial": 0,
"numeracaoFinal": 99999
}
],
"dataInicial": "2022-01-01",
"dataFinal": "2022-12-31",
"dataFinalCompras": "2022-12-25",
"dataFinalCadastros": "2022-12-25",
"sorteios": [{"id": "fa5c77ce-87ac-481f-9660-18d8d2a153ac",
"data": "2022-07-22",
"serieSorteada": 0,
"numeroBase": 41234,
"premios": [{"numero": 1,
"descricao": "VALE 10 POLGO",
"cashback": {"tipoCashback": "polgo",
"valor": 10,
"campanhaCashbackID": "cca9770d-1166-4b5a-92a4-0416a6ef41c9",
"diasParaLiberacao": 10,
"diasParaExpiracao": 30
}
}
],
"dataHoraCorteSorteio": "2022-07-21 23:59:59",
"sorteioLoteriaFederal": {"concurso": 5501,
"data": "2022-07-22"
},
"serie": {"inicial": 1,
"final": 2
},
"finalizado": true
}
],
"urlRegulamento": "",
"ativa": true,
"totalCupons": 1000000,
"eventos": [ ]
}
]
}

Fidelidade

Consultas de saldo, extrato e campanhas de cashback vinculadas ao consumidor. Pode ser integrado com o serviço de Documento Fiscal para as vendas.

Saldo de cashback do usuário

Endpoint para consultar saldo de cashback de um usuário.

path Parameters

usuario

required

string

Example: 17285685289

CPF do usuario (apenas números).

header Parameters

Authorization

required

string

Token de autorização.

Responses

Response samples

200
401
403

Content type

application/json

{"status": 200,
"mensagem": "Saldo obtido com sucesso",
"retorno": {"usuario": "28120615298",
"valorDisponivel": 15,
"valorDisponibilizar": 20,
"valorTotalDisponibilizar": 30,
"disponibilizaEm": "14/12/2021",
"valorExpirar": 15,
"expiraEm": "13/12/2021",
"valorTotalSaldoUtilizado": 10
}
}

Extrato de cashbacks usuário

Endpoint para consultar o extrato de cashbacks de um consumidor.

path Parameters

usuario required	string Example: 00293869076 CPF do consumidor.
totalPorPagina required	integer [ -1 .. 100 ] Example: 10 Total de campanhas por página (ao inserir seu valor como `-1`, todas as `campanhas` serão listadas).
paginaAtual required	integer >= 1 Example: 1 Página atual.

query Parameters

ordemPor

string

Example: ordemPor=dataHoraCriacao

Parâmetro de ordenação, aceita os valores dataHoraUltimaAtualizacao, dataHoraCriacao, dataDisponibilizacao e dataExpiracao. Por padrão é dataHoraCriacao.

header Parameters

Authorization

required

string

Token de autorização.

Responses

Response samples

200
401
403
404

Content type

application/json

{"status": "200,",
"mensagem": "Extrato de cashback obtido com sucesso",
"retorno": {"paginas": 1,
"total": 1,
"retorno": [{"id": "2ed4e1be-109a-11ec-82a8-0242ac130003",
"campanhaCashback": {"id": "3716f43e-109a-11ec-82a8-0242ac130003",
"slug": 1,
"nome": "CAMPANHA DE CASHBACK TESTE",
"tipo": "PRODUTO",
"justificativa": null
},
"cpf": "49793543000",
"valor": 10,
"saldo": 5,
"dataCriacao": "2021-09-30",
"dataHoraCriacao": "2021-09-30 10:00:00",
"dataDisponibilizacao": "2021-10-06",
"dataExpiracao": "2021-10-30",
"associado": {"nome": "ASSOCIADO DOS LANÇAMENTOS",
"cnpj": "91459765138761",
"bandeira": "BANDEIRA DO NORTE",
"regiao": "NORTE",
"cidade": "MANAUS",
"estado": "AM"
},
"colaborador": {"cpf": "14135180957",
"nome": "COLABORADOR DOS LANÇAMENTOS"
},
"documentoFiscal": {"numeroIdentificacao": "9879845G987O780",
"valorTotal": 22.25,
"dataEmissao": "2021-09-13",
"formaDePagamento": "DINHEIRO"
},
"produtos": [{"codigoIdentificacao": "123",
"descricao": "Produto 123",
"quantidadeCompra": 4,
"quantidadeContabilizada": 4,
"valorTotalPago": 49.96,
"valorGerouCashback": 1.96
},
{"codigoIdentificacao": "456",
"descricao": "Produto 456",
"quantidadeCompra": 10,
"quantidadeContabilizada": 4,
"valorTotalPago": 199,
"valorGerouCashback": 4
},
{"codigoIdentificacao": "789",
"descricao": "Produto 789",
"quantidadeCompra": 11,
"quantidadeContabilizada": 10,
"valorTotalPago": 155,
"valorGerouCashback": 5.5
}
],
"descricao": "",
"debitos": [{"codigoControle": "11234a03-cc1f-44c7-bc1d-5c00507e90cc",
"valor": 5.5,
"descricao": "Compra de Coca-Cola 2lts",
"dataHora": "2021-10-01 20:19:37",
"cancelado": false,
"cancelamento": null
},
{"codigoControle": "bc7327be-6d30-4bde-986d-8d4919263533",
"valor": 4.5,
"descricao": "Compra de KitKat Barra 200g",
"dataHora": "2021-10-03 15:12:55",
"cancelado": true,
"cancelamento": {"dataHoraCancelamento": "2021-09-22 09:00:00",
"colaborador": {"nome": "Colaborador Teste",
"cpf": "23598819064"
},
"associado": {"nome": "Associado Teste",
"cnpj": "27854473000102"
},
"descricao": "Teste descrição",
"usuarioLogado": "admin"
}
}
],
"cancelado": true,
"usuarioLogado": "admin",
"lancamentoManual": true,
"cancelamento": {"usuarioLogado": "admin",
"descricao": "Teste descrição...",
"dataHoraCancelamento": "2021-12-01 12:40:00"
},
"dataHoraUltimaAtualizacao": "2021-12-01 12:43:27"
}
]
}
}

Listar campanhas cashback

Endpoint para listar as campanhas de cashback ordenadas de forma decrescente pela data e hora de criação.

path Parameters

totalPorPagina required	integer [ -1 .. 100 ] Example: 15 Total de campanhas por página (ao inserir seu valor como `-1`, todos as `campanhas cashback` serão listadas).
paginaAtual required	integer >= 1 Example: 1 Página atual.

query Parameters

campanhaID	string Example: campanhaID=3716f43e-109a-11ec-82a8-0242ac130003 Parâmetro de filtragem que busca uma determinada campanha de cashback pelo id.
campanhaSlug	string Example: campanhaSlug=23 Parâmetro de filtragem que busca uma determinada campanha de cashback pelo slug (identificador único amigável).
listaAssociadoCNPJ	string Example: listaAssociadoCNPJ=40188780086165 Parâmetro de filtragem que busca campanhas de cashback que possuam determinados registros de CNPJ em sua segmentação de associados (separado por vírgula).
listaProdutos	string Example: listaProdutos=banana Parâmetro de filtragem que busca campanhas de cashback que possuam determinados produtos em sua lista de produtos (separado por vírgula).
retornarListaProdutos	boolean Example: retornarListaProdutos=false Parâmetro de filtragem que permite o retorno da lista de produtos cadastrados na campanha de cashback, e que por padrão é desabilitado.
listaTipos	string Example: listaTipos=produto, creditodireto Parâmetro de filtragem que busca campanhas de cashback que possuam o(s) tipo(s) da(s) campanha(s) (separado por vírgula).
responsavelCPF	string Example: responsavelCPF=73866833754 Parâmetro de filtragem que busca campanhas pelo CPF do seu responsável.
responsavelDepartamento	string Example: responsavelDepartamento=Inovações Parâmetro de filtragem que busca campanhas pelo departamento do seu responsável.
responsavelGerente	string Example: responsavelGerente=Carlos Parâmetro de filtragem que busca campanhas pelo gerente do seu responsável.
campanhaNome	string Example: campanhaNome=Natal Parâmetro de filtragem que busca campanhas pelo seu nome.
dataHoraInicial	string Example: dataHoraInicial=2022-06-16 12:35:55 Parâmetro de filtragem que busca campanhas com data hora inicial maior ou igual ao informado (YYYY-MM-DD HH:mm:ss).
dataHoraFinal	string Example: dataHoraFinal=2022-06-15 12:00:19 Parâmetro de filtragem que busca campanhas com data hora final menor ou igual ao informado (YYYY-MM-DD HH:mm:ss).
status	string Example: status=pausada Parâmetro de filtragem que busca campanhas pelo seu status, que podem ser ativa, encerrada, publicada, pausada ou rascunho.
listaAssociadoCodigo	string Example: listaAssociadoCodigo=172, 1823 Parâmetro de filtragem que busca campanhas de cashback que possuam determinados registros de código do associado em sua segmentação de associados código interno (separado por vírgula).
campanhaVinculada	string Example: campanhaVinculada=3916f43e-109a-11ec-82a8-0242abh130077 Parâmetro de filtragem que busca campanhas cujo campo campanhaVinculadaID tenha o mesmo o valor do informado. Caso o valor informado seja 'false', retorna campanhas que não tem esse campo preenchido.
campanhaVinculadaSlug	integer Example: campanhaVinculadaSlug=23 Parâmetro de filtragem que busca campanhas cujo campo campanhaVinculadaSlug tenha o mesmo o valor do informado.

header Parameters

Authorization

required

string

Token de autorização.

Responses

Response samples

200
401
403
404

Content type

application/json

{"status": 200,
"mensagem": "Campanhas cashback obtidas com sucesso!",
"retorno": {"paginas": 1,
"total": 1,
"retorno": [{"id": "3716f43e-109a-11ec-82a8-0242ac130003",
"nome": "Campanha compre 1 leve 2",
"tipo": "PRODUTO",
"dataHoraInicial": "2021-09-01 00:00:00",
"dataHoraFinal": "2021-09-30 23:59:59",
"investimentoTotal": 10000,
"segmentacaoAssociados": ["22692880000147",
"79865626000110"
],
"segmentacaoAssociadosCodigoInterno": ["a-2269288aaaa147-x",
"a-2269288aaaa147-x"
],
"segmentacaoConsumidores": [ ],
"descricao": "Campanha Cashback",
"textoRegulamento": "Oferta válida para compras realizadas por pessoas físicas com limite de R$ 10,00 por CPF, nas lojas Mateus Supermercados, Mix Atacarejo e Camiño do estado do Maranhão. Vigente até 12/09/2021 ou enquanto durarem os estoques.",
"diasParaLiberacaoCashback": 7,
"diasParaExpiracaoCashback": 90,
"descricaoSegmentacaoAssociados": "",
"logoUrl": null,
"listaProdutos": [{"codigoIdentificacao": "45612365",
"gatilho": 2,
"tipoPorcentagem": false,
"valorReceberCashback": 2.1,
"quantidadeMaximaProduto": 2,
"preco": 10,
"descricao": "",
"imagem": "",
"descricaoPackCashback": "A+B"
}
],
"percentualAvisoInvestimento": 75.5,
"industria": {"cnpjCpf": "23920647000137",
"razaoSocial": "INDUSTRIA NSC LTDA",
"nomeFantasia": "NSC VALORE",
"codigoInterno": "e37cdd6e-ed98-4013-9ddf-8daabf71afad"
},
"responsavel": {"nome": "João Roberto",
"cpf": "81697759572",
"departamento": "Financeiro",
"gerente": "Carlos Magno",
"estado": "SP",
"email": "exemplo@email.com",
"codigo": null
},
"status": "publicada",
"slug": 7,
"campanhaVinculadaID": null,
"campanhaVinculadaSlug": null,
"codigoContrato": "123456789",
"historicoStatus": [{"status": "rascunho",
"usuarioLogado": "admin",
"dataHora": "2021-11-24 12:34:10",
"descricao": null
}
],
"historicoContratos": [{"codigoContrato": null,
"usuarioLogado": "admin",
"dataHora": "2022-06-21 09:52:48",
"descricao": null
}
],
"justificativa": null,
"configuracaoCompra": {"maximoPorCPF": 20,
"valorCashback": 10,
"gatilho": 100,
"tipoPorcentagem": false
},
"tipoBeneficiados": ["CONSUMIDOR"
],
"listaCreditos": [ ],
"gerarCashbackSemCadastro": false,
"cashoutSegmentado": false,
"valorMinimo": null,
"integrado": false,
"metodoEnvio": "SMS"
}
]
}
}

Listar campanhas cashback por usuário

Endpoint para listar as campanhas de cashback a partir de um usuário.

path Parameters

usuario required	string Example: 88622477135 CPF do consumidor.
totalPorPagina required	integer [ 1 .. 100 ] Example: 15 Total de campanhas por página.
paginaAtual required	integer >= 1 Example: 1 Página atual.

header Parameters

Authorization

required

string

Token de autorização.

Responses

Response samples

200
401
403

Content type

application/json

{"status": 200,
"mensagem": "Campanhas cashback obtidas com sucesso!",
"retorno": {"paginas": 1,
"total": 1,
"retorno": [{"id": "3716f43e-109a-11ec-82a8-0242ac130003",
"nome": "Campanha compre 1 leve 2",
"tipo": "PRODUTO",
"dataHoraInicial": "2021-09-01 00:00:00",
"dataHoraFinal": "2021-09-30 23:59:59",
"investimentoTotal": 10000,
"segmentacaoAssociados": ["22692880000147",
"79865626000110"
],
"segmentacaoAssociadosCodigoInterno": ["a-2269288aaaa147-x",
"a-2269288aaaa147-x"
],
"segmentacaoConsumidores": [ ],
"descricao": "Campanha Cashback",
"textoRegulamento": "Oferta válida para compras realizadas por pessoas físicas com limite de R$ 10,00 por CPF, nas lojas Mateus Supermercados, Mix Atacarejo e Camiño do estado do Maranhão. Vigente até 12/09/2021 ou enquanto durarem os estoques.",
"diasParaLiberacaoCashback": 7,
"diasParaExpiracaoCashback": 90,
"descricaoSegmentacaoAssociados": "Estoque",
"logoUrl": null,
"listaProdutos": [{"codigoIdentificacao": "45612365",
"gatilho": 2,
"tipoPorcentagem": false,
"valorReceberCashback": 2.1,
"quantidadeMaximaProduto": 2,
"preco": 10,
"descricao": "",
"imagem": "",
"descricaoPackCashback": "A+B"
}
],
"percentualAvisoInvestimento": 75.5,
"industria": {"cnpjCpf": "23920647000137",
"razaoSocial": "INDUSTRIA NSC LTDA",
"nomeFantasia": "NSC VALORE",
"codigoInterno": "e37cdd6e-ed98-4013-9ddf-8daabf71afad"
},
"responsavel": {"nome": "João Roberto",
"cpf": "81697759572",
"departamento": "Financeiro",
"setor": "COMERCIAL",
"gerente": "Carlos Magno",
"estado": "SP",
"email": "exemplo@email.com"
},
"status": "publicada",
"slug": 7,
"campanhaVinculadaID": null,
"campanhaVinculadaSlug": null,
"historicoStatus": [{"status": "rascunho",
"usuarioLogado": "admin",
"dataHora": "2021-11-24 12:34:10",
"descricao": null
}
],
"historicoContratos": [{"codigoContrato": null,
"usuarioLogado": "admin",
"dataHora": "2022-06-21 09:52:48",
"descricao": null
}
],
"justificativa": null,
"configuracaoCompra": {"maximoPorCPF": 20,
"valorCashback": 10,
"gatilho": 100,
"tipoPorcentagem": false
},
"tipoBeneficiados": ["CONSUMIDOR"
],
"eventos": [ ],
"listaCreditos": [ ],
"gerarCashbackSemCadastro": false,
"cashoutSegmentado": false,
"valorMinimo": {"percentual": 2,
"fixo": 0
}
}
]
}
}