YAyampi
Promoções - Cashbacks

Atualizar cashback

Atualiza os detalhes de um cashback específico

put/{alias}/pricing/cashbacks/{id}

Request

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

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do cashback

Request body

activeboolean required

Define se a regra de cashback está ativa.

namestring required

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

min_amountinteger required

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

max_amountinteger required

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

valid_forinteger required

Prazo de validade do saldo creditado, em dias.

percent_amountinteger required

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

has_expirationboolean required

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

starts_atstring date-time

Data de início

expires_atstring date-time

Data de término

Example request

{
  "active": true,
  "name": "Nome do cashback. Esse valor deve ser único.",
  "has_expiration": true
}

Response

Cashback atualizado com sucesso

idinteger

ID da regra de cashback.

store_idinteger

ID da loja dona da regra de cashback.

tokenstring

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

activeboolean

Indica se a regra de cashback está ativa.

namestring

Nome da regra de cashback, único na loja.

min_amountnumber float

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

max_amountnumber float

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

valid_forinteger

Dias de validade

percent_amountnumber float

Percentual de cashback

has_expirationboolean

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

Example response

{
  "name": "Exemplo de cashback",
  "starts_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "expires_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "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

No recorded changes to this operation across all 3 revisions of this API.