Skip to main content
POST
/
{alias}
/
pricing
/
promotions
Criar promoção
curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/pricing/promotions \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "active": true,
  "all_products": true,
  "utm_only": true,
  "price_attribute": "price_discount",
  "name": "Black Friday 2025",
  "value": 123,
  "start_at": "2025-11-25 00:00:00",
  "end_at": "2025-11-30 23:59:59",
  "highlight_on_menu": true,
  "accumulate": true,
  "utm_source": "google",
  "utm_campaign": "black_friday",
  "collections_ids": [
    1,
    2
  ],
  "brands_ids": [
    1,
    2
  ],
  "categories_ids": [
    1,
    2
  ],
  "banners_ids": [
    1,
    2
  ]
}
'
{
  "id": 123,
  "active": true,
  "all_products": true,
  "utm_only": true,
  "highlight_on_menu": true,
  "accumulate": true,
  "price_attribute": "<string>",
  "name": "Promoção relâmpago",
  "expired": true,
  "url": "https://www.domain.com/promocoes/test",
  "slug": "<string>",
  "value": 123,
  "utm_source": "google",
  "utm_campaign": "adwords"
}

Authorizations

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

Path Parameters

​
alias
string
required

Alias da loja

Body

application/json

Dados para criação ou atualização de uma promoção

​
active
boolean
required

Status da promoção

Example:

true

​
all_products
boolean
required

Aplicar em todos os produtos

Example:

true

​
utm_only
boolean
required

Exclusivo para UTM

Example:

true

​
price_attribute
enum<string>
required

Atributo de preço para aplicar desconto

Available options:
price_sale,
price_discount
Example:

"price_discount"

​
name
string
required

Nome da promoção

Example:

"Black Friday 2025"

​
value
number<float>
required

Valor do desconto

Example:

123

​
start_at
string<date-time>
required

Data e hora de início

Example:

"2025-11-25 00:00:00"

​
end_at
string<date-time>
required

Data e hora de término

Example:

"2025-11-30 23:59:59"

​
highlight_on_menu
boolean

Destacar no menu

Example:

true

​
accumulate
boolean

Permite acumular com outras promoções

Example:

true

​
utm_source
string

Origem UTM

Example:

"google"

​
utm_campaign
string

Campanha UTM

Example:

"black_friday"

​
collections_ids
integer[]

IDs das coleções

Example:
[1, 2]
​
brands_ids
integer[]

IDs das marcas

Example:
[1, 2]
​
categories_ids
integer[]

IDs das categorias

Example:
[1, 2]
​
banners_ids
integer[]

IDs dos banners

Example:
[1, 2]

Response

Promoção criada com sucesso

​
id
integer
​
active
boolean
​
all_products
boolean
​
utm_only
boolean
​
highlight_on_menu
boolean
​
accumulate
boolean
​
price_attribute
string
​
name
string
Example:

"Promoção relâmpago"

​
expired
boolean
​
url
string<uri>
Example:

"https://www.domain.com/promocoes/test"

​
slug
string
​
value
number<float>
​
utm_source
string
Example:

"google"

​
utm_campaign
string
Example:

"adwords"