post
https://giftback-sandbox.crmbonus.com/apiEcommerce/campanha_disponivel
API responsável pela validação do PIN enviado ao número de celular do cliente.
Dicionário de Dados | Requisição
{
"total_liquido": 500,
"celular": "11985728710",
"card_own_store": false,
"first_purchase": false,
"is_partner": false,
"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
}
}| Campo | Descrição |
|---|---|
| total_liquido | Valor da compra após o desconto do bônus. |
| celular | Número de celular do cliente com DDD e sem o uso da máscara. |
| card_own_store | Informa se o pagamento foi realizado com o cartão da loja. |
| first_purchase | Informa se é a primeira compra do cliente. |
| is_partner | |
| [items] sku | Identificador do produto. |
| [items] value_of | Valor base de referência do produto. |
| [items] value_per | Valor do produto com desconto. |
| [items] quantity | Quantidade do produto. |
| [delivery] type | Tipo da entrega (ENUM). |
| [delivery] fee | Taxa da entrega |
| [payments] id | Identificador do pagamento. |
| [payments] system_id | Identificador do sistema. |
| [payments] system_name | Bandeira do sistema. |
| [payments] type | Tipo de pagamento (ENUM). |
| [payments] value | Valor do pagamento. |
| [payments] installments | Parcela do pagamento. |
| [totals] fee | Taxas adicionais. |
| [totals] taxes | Impostos. |
| [totals] subtotal | Valor bruto da compra. |
| [totals] crm_discounts | Descontos aplicados na CRMBonus. |
| [totals] other_discounts | Outros descontos. |
| [totals] total | Valor líquido da compra. |
Dicionário de Dados | Resposta
{
"status": true,
"message": "sucesso",
"data": {
"loja_id": 100164,
"campanhas": [
{
"id": 20723,
"name": "Fidelidade",
"subtitle": "",
"tipo": "fidelidade",
"texto": "R$ 10,00 para a próxima compra",
"valor": 10,
"data_inicio": "2024-11-20 00:00:00",
"data_fim": "2024-12-20 23:59:59"
},
{
"id": -1,
"name": "Não Bonificar",
"texto": "Não Bonificar",
"subtitle": "Não Bonificar",
"valor": 0,
"data_inicio": "",
"data_fim": ""
}
]
}
}
Não BonificarA campanha de não bonificação pode ou não retornar na response da API. Observe que essa campanha, em específico, não possui o parâmetro "tipo" dentro de sua estrutura.
| Campo | Descrição |
|---|---|
| loja_id | ID da loja na CRMBonus. |
| campanhas | Array de objetos com as campanhas disponíveis e seus dados. |
| campanhas[id] | ID da campanha CRMBonus. |
| campanhas[name] | Nome da campanha CRMBonus. |
| campanhas[texto] | Texto informativo sobre o bônus para a próxima compra. |
| campanhas[valor] | Valor de bônus a ser gerado para a próxima compra. |
| campanhas[data_inicio] | Data em que o bônus a ser gerado estará disponível para resgate. |
| campanhas[data_fim] | Data em que o bônus a ser gerado deixará de estar disponível para resgate. |