Lista os banners

GET

/api/v2/banners

Servidor do ambiente de produção
Servidor do ambiente de testes

Retorna a lista de banners

Authorizations

Token
X-Shop-Host

Parameters

Query Parameters

only_valid

string

Example

true

Booleano indicando para filtrar banners fora do prazo de validade

only_expired

string

Example

true

Booleano indicando para filtrar banners com prazo de validade expirados

only_scheduled

string

Example

true

Booleano indicando para filtrar banners agendados

tag

string

Lista separada por vírgula com nomes de tags

title

string

Texto livre que permite filtrar os banners pelo título

no_paginate

string

Booleano indicando para não fazer paginação dos resultados

page

integer

>= 1

Número da página atual. Os dados de paginação estarão disponíveis, em formato JSON, no header X-Pagination no response da API, caso exista paginação

per_page

integer

default: 100 <= 100

Número máximo de registros que deve ser retornado por página

Responses

200

Resposta que representa uma lista de banners

Array<object>

Banner

Modelo que representa um banner na API

object

big_thumb

required

string

color

required

string

description

required

string

nullable

end_at

required

string format: date-time

nullable

external

required

boolean

file_name

required

string

file_uid

required

string

html_description

required

string

nullable

required

integer

norder

required

integer

nullable

plain_description

required

string

nullable

small_thumb

required

string

start_at

required

string format: date-time

subtitle

required

string

nullable

tag

required

string

title

required

string

updated_at

required

string format: date-time

url

required

string format: uri

nullable