/cancelarBonusEcom

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

Dicionário de Dados | Requisição

{
    "num_pedido": "CRM-TESTE-001",
    "used_bonus": false
}
CampoDescrição
num_pedidoIdentificador do pedido. Parâmetro "ticket" enviado no /finaliza_compra ou /baixa_bonus.
used_bonus
  • *true**: Indica se está sendo feito aoenas um cancelamento da reserva do bônus através (/baixa_bonus).
  • *false**: Cancelamento de um bônus que foi gerado (após o /finaliza_compra), mas que ainda não foi usado.

Dicionário de Dados | Resposta

{
    "status": true,
    "message": "Sucesso: Bonus cancelado com sucesso."
}
CampoDescrição
messageMensagem de sucesso ou erro da API.
Body Params
string
required
Defaults to CRM-TESTE-001

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

boolean
required
Defaults to false

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

Headers
string
required
Defaults to base64

Token de autenticação.

string
required
Defaults to base64

Código da empresa enviado pela CRMBonus.

string
required
Defaults to {systemName}

Nome do sistema que está realizando 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