Sign in

v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/bonus/submit

Finalização da compra (resgate do bônus e geração de um novo bônus)

post/bonus/submit

Headers

Content-Typestring required
System-Namestring required

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

User-Agentstring required
Request-Hashstring required

request_hash obtido na requisição /user/verify

Request body

sales_type'IN_STORE' | 'ONLINE' | 'PRE-SALE' | 'WHOLESALE' | 'TELESALES' | 'MARKETPLACE' | 'RETAIL' | 'POSTPAID_SALES'

Tipo de venda

user_idstring required

Id do cliente na CRMBonus

campaign_idstring required

Id da campanha

pin_masterboolean required

O PIN master foi utilizado?

seller_namestring

Nome do vendedor

bonus_idsstring[] required

Ids dos bônus que serão resgatados (parâmetro com mesmo nome retornado no /bonus/available)

invoicestring

Nota fiscal do pedido

terminalstring

Identificação do terminal ou caixa onde a venda foi realizada

internal_order_idstring required

Identificador do pedido — Informe o mesmo valor informado na requisição à /total/sales.

referential_order_idstring

Referência do pedido (opcional)

Response

200

statusboolean
messagestring

Example response

{
  "status": true,
  "message": "Successfully generated bonus",
  "data": {
    "bonus_id": "6m6AU/VuGMZablszkpr8/w==",
    "order_id": "N1zy1v2v+p4BdT/TyHCRAg==",
    "bonus_sku": [
      "ZVBycxzxb+p4BaTTyHSSAg=="
    ]
  }
}