Skip to main content
GET
Visualizar banner

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID do banner

Response

Detalhes do banner

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