/finaliza_compra

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

Dicionário de Dados | Requisição

{
    "user_id": 27056298,
    "valor_bruto": 500.50,
    "bonus_resgatado": 125.50,
    "ids_bonus": "136473650,136473651",
    "ticket": "CRM-TESTE-001",
    "campanha_id": 20263,
    "items": [
        {
            "sku": "abc1234",
            "value_of": 100,
            "value_per": 100,
            "quantity": 1
        }
    ],
    "payments": [
         {
            "id": "1",
            "system_id": "1",
            "system_name": "CASH",
            "type": "CASH",
            "value": 100,
            "installments": 1
        }
    ],
    "delivery": {
        "type": "STANDARD",
        "fee": 5
    },
    "totals": {
        "subtotal": 100,
        "fee": 0,
        "taxes": 0,
        "crm_discounts": 0,
        "other_discounts": 0,
        "total": 100
    }
  }
CampoDescrição
user_idID do cliente na CRMBonus.
valor_brutoValor da compra antes da aplicação do saldo de bônus.
bonus_resgatadoValor do bônus resgatado nesta compra.
ids_bonusIDs dos bônus disponíveis nesta compra. Campo retornado no endpoint /consulta_bonus.
ticketIdentificador da compra ou pedido no sistema.
campanha_idId da campanha
[items] skuIdentificador do produto.
[items] value_ofValor base de referência do produto.
[items] value_perValor do produto com desconto.
[items] quantityQuantidade do produto.
[delivery] typeTipo da entrega (ENUM).
[delivery] feeTaxa da entrega
[payments] idIdentificador do pagamento.
[payments] system_idIdentificador do sistema.
[payments] system_nameBandeira do sistema.
[payments] typeTipo de pagamento (ENUM).
[payments] valueValor do pagamento.
[payments] installmentsParcela do pagamento.
[totals] feeTaxas adicionais.
[totals] taxesImpostos.
[totals] subtotalValor bruto da compra.
[totals] crm_discountsDescontos aplicados na CRMBonus.
[totals] other_discountsOutros descontos.
[totals] totalValor líquido da compra.

Dicionário de Dados | Resposta

{
    "status": true,
    "message": "sucesso",
    "data": {
        "bonus_id": 136473654,
        "order_id": 129898024,
        "ticket": "CRM-TESTE-001"
    }
}
CampoDescrição
bonus_idID do bônus gerado a partir desta venda;
order_idID do pedido gerado na CRMBonus a partir desta venda.
ticketIdentificador da compra ou pedido no sistema.
Body Params
int32
required
Defaults to 27126798

ID do cliente na CRMBonus.

float
required
Defaults to 500.5

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

int32
required
Defaults to 125.5

Valor de bônus resgatado nesta compra.

string
Defaults to 136473650,136473651

Obrigatório quando houver resgate. ID do bônus que será resgatado. Se múltiplos, separe-os por vírgula.

💡 Tip: Valore(s) retornado(s) no endpoint /consulta_bonus.

string
required
Defaults to CRM-TESTE-001

Identificador da compra ou pedido no sistema.

string
required
Defaults to 20263

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

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

items
array of objects

⚠️Importante: Este parâmetro torna-se obrigatório quando a feature flag Motor v2 está ativa.

Produtos selecionados na compra

items
payments
array of objects

⚠️Importante: Este parâmetro torna-se obrigatório quando a feature flag Motor v2 está ativa.

Dados do pagamento

payments
delivery
array of objects

⚠️Importante: Este parâmetro torna-se obrigatório quando a feature flag Motor v2 está ativa.

Dados da entrega

delivery
totals
array of objects

⚠️Importante: Este parâmetro torna-se obrigatório quando a feature flag Motor v2 está ativa.

Subtotal da compra e descontos aplicados.

totals
Headers
string
required
Defaults to base64

Token de autenticação.

string
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