Skip to main content
GET
Listar promoções

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:
brands_ids
integer[]

IDs das marcas

Example:
categories_ids
integer[]

IDs das categorias

Example:
banners_ids
integer[]

IDs dos banners

Example:

Response

Lista de promoções

Representa uma paginação com meta

data
object[]
meta
object