/api_campanha_disponivel

Este endpoint marca o início da segunda etapa do fluxo, a bonificação. Aqui retornamos as informações que definirão quanto o cliente poderá receber para a próxima compra, baseado em regras acordadas previamente com nosso contratante.

Introdução à /api_campanha_disponivel

🚧

Pontos de atenção

Ao enviar o card_own_store como true retornaremos apenas as campanhas configuradas como tal, sendo assim, caso não hajam campanhas configuradas o retorno será de um array vazio.

Dicionário de Dados | Resposta

❗️

Não Bonificar

A campanha de não bonificação pode ou não retornar na response da API. Observe que essa campanha, em específico, não possui o parâmetro "tipo" dentro de sua estrutura.

CampoDescrição
loja_idID da loja na CRMBonus.
campanhasArray de objetos com as campanhas disponíveis e seus dados.
campanhas[id]ID da campanha CRMBonus.
campanhas[name]Nome da campanha CRMBonus.
campanhas[texto]Texto informativo sobre o bônus para a próxima compra.
campanhas[valor]Valor de bônus a ser gerado para a próxima compra.
campanhas[data_inicio]Data em que o bônus a ser gerado estará disponível para resgate.
campanhas[data_fim]Data em que o bônus a ser gerado deixará de estar disponível para resgate.
Body Params
int32
required
Defaults to 100164

ID da loja na CRM&Bônus.

float
required
Defaults to 500

Valor da compra após o desconto do bônus.

boolean
Defaults to false

Informa se o pagamento foi realizado com o cartão da loja.

boolean
Defaults to false
boolean
Defaults to false
Headers
string
required
Defaults to Base64

Token de autenticação.

string
required
Defaults to Base64

Código da empresa enviado pela CRMBonus.

int32
required
Defaults to null

Celular do cliente em base64.

string
required
Defaults to {pdvSystemName}

Nome do sistema PDV que está enviando a requisição

string
required
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json