POST
/
{alias}
/
marketing
/
banners
Criar banner
curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/marketing/banners \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '{
  "active": true,
  "home": true,
  "name": "<string>",
  "link": "<string>",
  "image_url": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "categories_ids": "[1,2,3]",
  "collections_ids": "[1,2,3]",
  "promotions_ids": "[1,2,3]"
}'
{
  "id": 123,
  "product_id": 123,
  "active": true,
  "type": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "link": "<string>",
  "expired": true,
  "image_url": "<string>",
  "mobile_image_url": "<string>",
  "home": true,
  "stopwatch": "<string>",
  "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"
  }
}

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

Link do banner

image_url
string

URL da imagem do banner

start_at
string<date-time>

Data de início

end_at
string<date-time>

Data de término

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

Representa um banner

id
integer
product_id
integer
active
boolean
type
string
name
string
slug
string
expired
boolean
image_url
string
mobile_image_url
string
home
boolean
stopwatch
string
stopwatch_expires_in
object
start_at
object
end_at
object
created_at
object
updated_at
object