latestOpenAPI 3.1.02026-08-04650218.3 KB

7f3ebb042f1a

/campanha_disponivel

API responsável pela validação do PIN enviado ao número de celular do cliente.

post/campanha_disponivel

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring required

Código da empresa enviado pela CRMBonus.

Content-Typestring required

System-Namestring required

Nome do sistema que está realizando a requisição.

User-Agentstring required

Request body

total_liquidonumber float required

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

celularstring required

Número de celular do cliente com DDD e sem o uso da máscara.

card_own_storeboolean

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

first_purchaseboolean

Informa se é a primeira compra do cliente.

is_partnerboolean

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "loja_id": 100164,
    "campanhas": [
      {
        "id": 20723,
        "name": "Fidelidade",
        "tipo": "fidelidade",
        "texto": "R$ 10,00 para a próxima compra",
        "valor": 10,
        "data_inicio": "2024-11-20 00:00:00",
        "data_fim": "2024-12-20 23:59:59"
      }
    ]
  }
}