Skip to main content
POST
/
{alias}
/
pricing
/
promocodes
Criar cupom
curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/pricing/promocodes \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '{
  "active": true,
  "for_the_price_of": true,
  "accumulate": true,
  "once_per_customer": true,
  "abandoned_cart": true,
  "newsletter": true,
  "free_shipment": true,
  "ignore_promotion_products": true,
  "discount_type": "p",
  "value": 10,
  "code": "10OFF",
  "quantity": 100000,
  "min_value": 99.99,
  "start_at": {
    "date": "2016-05-09 09:51:00",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2016-12-31 09:51:00",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}'
{
  "id": 123,
  "code": "TEST",
  "description": "",
  "customer_id": 123,
  "active": true,
  "expired": true,
  "discount_type": "p",
  "for_the_price_of": true,
  "cart_default": true,
  "type_increment_value": "",
  "value": 10,
  "price_products": 123,
  "percent_products": 123,
  "quantity": "100000",
  "total_customers_used": "22",
  "product_quantity": 123,
  "product_max_quantity": 123,
  "used": 22,
  "items_count": 123,
  "min_value": 99.99,
  "use_percent": 0.02,
  "shipment_percent": 123,
  "accumulate": true,
  "once_per_customer": true,
  "abandoned_cart": true,
  "newsletter": true,
  "payments_ids": "<any>",
  "free_shipment": true,
  "ignore_promotion_products": true
}
Esta API possui limites de requisições (rate limits) para garantir estabilidade. Cada endpoint tem um limite específico de chamadas por minuto. Este endpoint em específico tem um limite de requisições por minuto.

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Parâmetros para criar um cupom de desconto

active
boolean

Ativação do cupom

for_the_price_of
boolean

Cupom para o preço de

accumulate
boolean

Acumulação do cupom

once_per_customer
boolean

Válido apenas uma vez por cliente

abandoned_cart
boolean

Cupom para carrinho abandonado

newsletter
boolean

Cupom para assinatura de newsletter

free_shipment
boolean

Cupom para frete grátis

ignore_promotion_products
boolean

Ignorar produtos promocionais

discount_type
enum<string>

Tipo de desconto

Available options:
p,
v
value
number

Valor do desconto

Example:

10

code
string

Código do cupom

Example:

"10OFF"

quantity
integer

Quantidade disponível do cupom

Example:

100000

min_value
number

Valor mínimo para aplicação do cupom

Example:

99.99

start_at
object

Data de início da validade do cupom

end_at
object

Data de término da validade do cupom

Response

Cupom criado com sucesso

Representa um código promocional

id
integer
code
string
Example:

"TEST"

description
string
Example:

""

customer_id
integer
active
boolean
expired
boolean
discount_type
enum<string>
Available options:
p,
v
for_the_price_of
boolean
cart_default
boolean
type_increment_value
string
Example:

""

value
number
Example:

10

price_products
number
percent_products
number
quantity
integer
Example:

"100000"

total_customers_used
integer
Example:

"22"

product_quantity
integer
product_max_quantity
integer
used
integer
Example:

22

items_count
integer
min_value
number
Example:

99.99

use_percent
number
Example:

0.02

shipment_percent
number
accumulate
boolean
once_per_customer
boolean
abandoned_cart
boolean
newsletter
boolean
payments_ids
any
free_shipment
boolean
ignore_promotion_products
boolean
I