Skip to main content
GET
Visualizar Regra de Cashback

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Response

Retorna os detalhes das regras de um cashback

Representa as regras de um cashback

max_order_percent
integer

Percentual máximo do pedido que pode ser quitado com saldo de cashback.

expires_if_order_cancelled
boolean

Indica se o cashback do pedido expira quando o pedido é cancelado.

cumulative
boolean

Indica se o saldo de cashback é cumulativo. Campo legado: não há coluna correspondente e a resposta traz sempre false.

active
boolean

Indica se as regras de cashback da loja estão ativas.

allow_cashback_with_balance
boolean

Permite que pedidos pagos com saldo de cashback gerem novo saldo.

Example:

true

min_order_amount
number<float>

Valor mínimo do pedido, em reais, para permitir o uso de saldo de cashback. Nulo significa sem valor mínimo.

created_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.

updated_at
object

Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.