v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/finaliza_compra

API para finalização da compra e encerramento do processo de bonificação do e-commerce.

post/finaliza_compra

Headers

Authorizationstring required

Token de autenticação.

CodEmpresastring

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

user_idinteger required

ID do cliente na CRMBonus.

valor_brutonumber float required

Valor da compra antes da aplicação do saldo de bônus.

bonus_resgatadointeger required

Valor de bônus resgatado nesta compra.

ids_bonusstring

Obrigatório quando houver resgate. ID do bônus que será resgatado. Se múltiplos, separe-os por vírgula. <br><br>💡 Tip: Valore(s) retornado(s) no endpoint /consulta_bonus.

ticketstring required

Identificador da compra ou pedido no sistema.

campanha_idstring required

Id da campanha para geração do bônus.

💡 Tip: Valore(s) retornado(s) no endpoint /campanha_disponivel

Response

200

statusboolean

messagestring

Example response

{
  "status": true,
  "message": "sucesso",
  "data": {
    "bonus_id": 136473654,
    "order_id": 129898024,
    "ticket": "CRM-TESTE-001"
  }
}