Skip to main content
POST
/
v1
/
app
/
discount
Create Discount
curl --request POST \
  --url https://api.centralcart.com.br/v1/app/discount/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "coupon": "<string>",
  "applies_to": [
    123
  ],
  "type": "<string>",
  "value": 123,
  "max_uses": 123,
  "expires_in": "<string>",
  "min_price": 123,
  "limit_criteria": "<string>",
  "restricted_to_criteria": "<string>",
  "restricted_to": [
    "<string>"
  ]
}
'
{
  "id": 3361,
  "store_id": 1,
  "coupon": "50OFF",
  "type": "PERCENTAGE",
  "value": 5,
  "applies_to": [10, 11],
  "uses": 0,
  "max_uses": null,
  "expires_in": "2024-10-16T00:00:00.000-03:00",
  "min_price": null,
  "limit_criteria": null,
  "restricted_to_criteria": null,
  "restricted_to": null,
  "created_at": "2023-05-10T21:47:17.000-03:00",
  "updated_at": "2023-09-14T12:04:46.000-03:00"
}
​
coupon
string
required
O cupom que será criado. Aceita apenas letras, números, hífens e underlines.
​
applies_to
number[]
required
Lista de ID dos produtos em que o cupom poderá ser aplicado. Use [-1] para aplicar a todos os produtos.
​
type
string
required
O tipo do desconto, podendo ser PRICE ou PERCENTAGE
​
value
number
required
O valor do desconto. Para PERCENTAGE, o valor é em porcentagem (ex: 50 = 50%). Para PRICE, o valor é em centavos da moeda.
​
max_uses
number
A quantidade máxima de usos que o desconto pode ter
​
expires_in
date
A data de expiração do desconto
​
min_price
number
Valor mínimo do pedido para que o cupom possa ser aplicado. Intervalo: 0 a 999999.
​
limit_criteria
string
Critério de limitação de uso por cliente. Quando definido, cada cliente só poderá usar o cupom uma vez com base no critério escolhido. Valores possíveis: CLIENT_IDENTIFIER, CLIENT_EMAIL, CLIENT_DISCORD
​
restricted_to_criteria
string
Tipo de restrição para limitar o cupom a clientes específicos. Deve ser usado junto com restricted_to. Valores possíveis: CLIENT_IDENTIFIER, CLIENT_EMAIL, CLIENT_DISCORD
​
restricted_to
string[]
Lista de identificadores dos clientes que poderão usar o cupom. Requer que restricted_to_criteria esteja definido. Ex: lista de e-mails, IDs Discord ou identificadores.
{
  "id": 3361,
  "store_id": 1,
  "coupon": "50OFF",
  "type": "PERCENTAGE",
  "value": 5,
  "applies_to": [10, 11],
  "uses": 0,
  "max_uses": null,
  "expires_in": "2024-10-16T00:00:00.000-03:00",
  "min_price": null,
  "limit_criteria": null,
  "restricted_to_criteria": null,
  "restricted_to": null,
  "created_at": "2023-05-10T21:47:17.000-03:00",
  "updated_at": "2023-09-14T12:04:46.000-03:00"
}