Skip to main content
PUT
Atualizar cashback
Envie somente os campos obrigatórios e os que deseja alterar, para reduzir validações desnecessárias. Caso não envie um campo, o mesmo será mantido com o valor atual.

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID do cashback

Body

application/json

Estrutura de dados para criação e atualização de uma regra de cashback.

active
boolean
required

Define se a regra de cashback está ativa.

Example:

true

name
string
required

Nome da regra de cashback. Deve ser único na loja.

Example:

"Nome do cashback. Esse valor deve ser único."

min_amount
integer
required

Valor mínimo do pedido, em reais, para a regra valer.

max_amount
integer
required

Valor máximo do pedido, em reais, para a regra valer. Não pode ser menor que min_amount.

valid_for
integer
required

Prazo de validade do saldo creditado, em dias.

percent_amount
integer
required

Percentual do valor do pedido creditado como cashback, de 0 a 100.

has_expiration
boolean
required

Define se a regra tem vigência limitada. Quando verdadeiro, starts_at e expires_at passam a ser obrigatórios.

Example:

true

starts_at
string<date-time>

Data de início

expires_at
string<date-time>

Data de término

Response

Cashback atualizado com sucesso

Representa um cashback

id
integer

ID da regra de cashback.

store_id
integer

ID da loja dona da regra de cashback.

token
string

Identificador único (UUID) da regra, gerado pela API na criação.

active
boolean

Indica se a regra de cashback está ativa.

name
string

Nome da regra de cashback, único na loja.

Example:

"Exemplo de cashback"

min_amount
number<float>

Valor mínimo do pedido, em reais, para a regra valer.

max_amount
number<float>

Valor máximo do pedido, em reais, para a regra valer.

valid_for
integer

Dias de validade

percent_amount
number<float>

Percentual de cashback

has_expiration
boolean

Indica se a regra tem vigência limitada. Quando falso, vale sempre; quando verdadeiro, vale entre starts_at e expires_at.

starts_at
object

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

expires_at
object

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

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.