YAyampi
Promoções - Cashback

Criar regra de cashback

Changed on

Retorna a regra de cashback da loja

post/{alias}/pricing/cashbacks/rules

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/pricing/cashbacks/rules
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

max_order_percentnumber required

Defina aqui a porcentagem máxima do pedido que pode ser quitada com o cashback.

expires_if_order_cancelledboolean required

Expira o cashback se o pedido for cancelado

allow_cashback_with_balanceboolean required

Permite que pedidos com cashback acumulem saldo

min_order_amountnumber float

Valor mínimo do pedido para permitir uso de saldo de cashback. Ausente ou nulo = sem valor mínimo.

Example request

{
  "max_order_percent": 10,
  "expires_if_order_cancelled": true,
  "allow_cashback_with_balance": true,
  "min_order_amount": 50
}

Response

Regra de cashback criada com sucesso

max_order_percentinteger

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

expires_if_order_cancelledboolean

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

cumulativeboolean

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

activeboolean

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

allow_cashback_with_balanceboolean

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

min_order_amountnumber float

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

Example response

{
  "allow_cashback_with_balance": true,
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes

  • bbafb577e11cRevision changes
    • breaking

      the response's property type changed from string to boolean for status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status