v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/cancelarBonusEcom

API para cancelar um bônus gerado pelo e-commerce.

post/cancelarBonusEcom

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

num_pedidostring required

Identificador do pedido. Parâmetro "ticket" enviado no /finaliza_compra ou /baixa_bonus.

used_bonusboolean required

Indica se foi realizado a reserva do bônus através do endpoint /baixa_bonus. Obs: Esse parâmetro não é um indicativo se o bônus foi utilizado ou não, mas sim se ele foi reservado no endpoint /baixa_bonus

Response

200

statusboolean
messagestring

Example response

{
  "status": true,
  "message": "Sucesso: Bonus cancelado com sucesso."
}