API Yampi
Search…
Marketing

Banners

Includes disponíveis: categories, collections, promotions, product

Listar banners

GET https://api.dooki.com.br/v2/{alias}/marketing/banners
Request
{
"active": true,
"home": true,
"name": "Banner test",
"link": "http://link.com",
"image_url": "https://image-url.com/image.jpg",
"start_at": "2017-05-06 00:00:00",
"end_at": "2017-05-06 00:00:00",
"categories_ids": [1, 2, 3],
"collections_ids": [1, 2, 3],
"promotions_ids": [1, 2, 3]
}
Response
{
"data": {
"id": 41,
"active": true,
"home": true,
"name": "Banner test",
"slug": "banner-test",
"image_url": "https://image-url.com/image.jpg",
"link": "http://link.com",
"expired": true,
"start_at": {
"date": "2014-06-03 23:57:00.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
"end_at": {
"date": "2020-06-03 23:57:00.000000",
"timezone_type": 3,
"timezone": "America/Sao_Paulo"
},
}
}

Criar banner

POST https://api.dooki.com.br/v2/{alias}/marketing/banners
Parâmetro
Tipo
Obrigatório
Descrição
active
boolean
Sim
Status do banner.
home
boolean
Sim
Marca se o banner aparecerá no slide principal da home.
name
string
Sim
Nome do banner.
image_url
string
Sim
URL do arquivo do banner.
link
string
Não
Link do banner.
start_at
datetime
Sim
Início da validade do banner. Formato: yyyy-mm-dd H:i:s.
end_at
datetime
Sim
Fim da validade do banner. Formato: yyyy-mm-dd H:i:s.
collections_ids
array
Não
Lista de coleções que o banner estará presente.
categories_ids
array
Não
Lista de categorias que o banner estará presente.
promotions
array
Não
Lista de promoções que o banner estará presente.
product_id
int
Não
ID do produto, caso o banner seja composto por um produto.
stopwatch
string
Não
Tipo de cronômetro. Valores aceitos: null, daily ou expiration_date

Ordenar banners

PUT https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}
Request de ordenação de banners
{
"sorting": [
{
"group": "categories",
"resource_id": 1,
"orders": [1234, 123, 12334]
},
{
"group": "promotions",
"resource_id": 5,
"orders": [1234, 123, 12334]
}
]
}
Parâmetro
Tipo
Obrigatório
Descrição
sorting
array
Sim
Status do banner.
sorting[group]
string
Sim
Nome do grupo em que o banner está. Valores aceitos: collections, categories, promotions, home
sorting[resource_id]
int
Sim
ID do recurso que o banner pertence. Exemplo: se o banner estiver em uma categoria com ID 5, deverá ser passado resource_id:5
sorting[orders]
array
Sim
IDs dos banners já nas posições ordenadas.

Visualizar banner

GET https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}

Atualizar banner

PUT https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}

Excluir banner

DELETE https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}

Lista de promoções que o banner pertence

GET https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}/promotions

Lista de coleções que o banner pertence

GET https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}/collections

Lista de categorias que o banner pertence

GET https://api.dooki.com.br/v2/{alias}/marketing/banners/{id}/categories