Sign in

v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Marketing

Criar banner

Cria um novo banner

post/{alias}/marketing/banners

Path parameters

aliasstring required

Alias da loja

Request body

activeboolean

Indica se o banner está ativo

homeboolean

Indica se o banner aparece na home

namestring

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

linkstring

Link do banner

image_urlstring

URL da imagem do banner

start_atstring date-time

Data e hora de início

end_atstring date-time

Data e hora de término

categories_idsinteger[]

IDs das categorias

collections_idsinteger[]

IDs das coleções

promotions_idsinteger[]

IDs das promoções

Example request

{
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00"
}

Response

Banner criado com sucesso

idinteger
product_idinteger
activeboolean
typestring
namestring
slugstring
linkstring
expiredboolean
image_urlstring
mobile_image_urlstring
homeboolean
stopwatchstring

Example response

{
  "stopwatch_expires_in": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "start_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "end_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}