v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/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.

post/api_campanha_disponivel

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring required

Código da empresa enviado pela CRMBonus.

Celularinteger required

Celular do cliente em base64.

Content-Typestring required

System-Namestring required

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

User-Agentstring required

Request body

loja_idinteger required

ID da loja na CRM&Bônus.

total_liquidonumber float required

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

card_own_storeboolean

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

is_partnerboolean

first_purchaseboolean

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "loja_id": 100164,
    "campanhas": [
      {
        "id": 20263,
        "name": "Ranges de Fidelidade",
        "tipo": "fidelidade",
        "texto": "R$ 100,00 para a próxima compra",
        "valor": 100,
        "data_inicio": "2024-03-04 00:00:00",
        "data_fim": "2024-04-03 23:59:59"
      }
    ]
  }
}