Skip to main content
POST
/
{alias}
/
pricing
/
cashbacks
/
rules
Criar regra de cashback
curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/pricing/cashbacks/rules \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "max_order_percent": 10,
  "expires_if_order_cancelled": true,
  "allow_cashback_with_balance": true
}
'
{
  "max_order_percent": 123,
  "expires_if_order_cancelled": true,
  "cumulative": true,
  "active": true,
  "allow_cashback_with_balance": "Exemplo de cashback",
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Path Parameters

​
alias
string
required

Alias da loja

Body

application/json
​
max_order_percent
number<integer>
required

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

Example:

10

​
expires_if_order_cancelled
boolean
required

Expira o cashback se o pedido for cancelado

Example:

true

​
allow_cashback_with_balance
boolean
required

Permite que pedidos com cashback acumulem saldo

Example:

true

Response

Regra de cashback criada com sucesso

Representa as regras de um cashback

​
max_order_percent
integer
​
expires_if_order_cancelled
boolean
​
cumulative
boolean
​
active
boolean
​
allow_cashback_with_balance
string
Example:

"Exemplo de cashback"

​
created_at
object
​
updated_at
object