Skip to main content
POST
Criar banner

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 banner

Representa os dados necessários para criar ou atualizar um banner

active
boolean

Indica se o banner está ativo

home
boolean

Indica se o banner aparece na home

name
string

Nome do banner. O valor é sanitizado e normalizado automaticamente.

Link do banner

image_url
string

URL da imagem do banner

start_at
string<date-time>

Data e hora de início

Example:

"2025-06-01 00:00:00"

end_at
string<date-time>

Data e hora de término

Example:

"2025-08-10 00:00:00"

categories_ids
integer[]

IDs das categorias

Example:

"[1,2,3]"

collections_ids
integer[]

IDs das coleções

Example:

"[1,2,3]"

promotions_ids
integer[]

IDs das promoções

Example:

"[1,2,3]"

Response

Banner criado com sucesso

Recursos adicionais do banner, retornados sob demanda via parâmetro include.

id
integer

ID do banner.

product_id
integer

ID do produto vinculado ao banner, exigido quando type for product.

active
boolean

Indica se o banner está ativo.

type
string

Tipo do banner: image (banner de imagem) ou product (banner vinculado a um produto).

name
string

Nome de identificação do banner.

slug
string

Slug do banner, gerado a partir do nome.

URL de destino ao clicar no banner.

expired
boolean

Indica se a data de término de exibição do banner já passou.

image_url
string

URL da imagem do banner exibida em desktop.

mobile_image_url
string

URL da imagem do banner exibida em dispositivos móveis.

home
boolean

Indica se o banner é exibido na página inicial da loja.

stopwatch
string

Tipo da contagem regressiva exibida no banner: daily (reinicia todo dia) ou expiration_date (conta até a data de término).

stopwatch_expires_in
object
start_at
object
end_at
object
created_at
object
updated_at
object