YAyampi
Catálogo - Coleções

Criar coleção

Cria uma nova coleção com os parâmetros especificados

post/{alias}/catalog/collections

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/catalog/collections
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

activeboolean required

Indica se a coleção fica ativa e visível na loja.

show_bannersboolean

Indica se os banners vinculados à coleção são exibidos na página dela.

featuredboolean

Indica se a coleção é destacada na navegação da loja.

namestring required

Nome da coleção, único dentro da loja.

visible_productsinteger

Quantidade de produtos exibidos na vitrine da coleção.

homeboolean required

Indica se a coleção é exibida na página inicial da loja.

slugstring

Slug da coleção, usado na composição da URL; gerado a partir do nome quando não informado.

descriptionstring

Texto descritivo exibido na página da coleção.

seo_titlestring

Título usado para SEO (tag title) da página da coleção.

seo_descriptionstring

Descrição usada para SEO (meta description) da página da coleção.

seo_keywordsstring

Palavras-chave usadas para SEO da página da coleção.

start_atstring date-time required

Data e hora de início

end_atstring date-time required

Data e hora de término

stopwatchstring

Tipo da contagem regressiva exibida na coleção: daily (reinicia todo dia) ou expiration_date (conta até a data de término).

urlstring uri

URL completa da página da coleção na loja.

products_idsinteger[]

IDs dos produtos vinculados à coleção.

banners_idsinteger[]

IDs dos banners vinculados à coleção.

Example request

{
  "active": true,
  "show_banners": true,
  "featured": true,
  "name": "Collection Test",
  "visible_products": 4,
  "home": true,
  "slug": "collection-test",
  "description": "Test description",
  "seo_title": "Page Title for SEO",
  "seo_description": "Meta Tag Description",
  "seo_keywords": "seo, keywords",
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00",
  "stopwatch": "daily",
  "url": "https://www.domain.com/collection/l",
  "products_ids": [
    1,
    2,
    3,
    4
  ],
  "banners_ids": [
    1,
    2,
    3,
    4
  ],
  "restrictions": {
    "include": {
      "brands_ids": [
        1,
        2,
        3,
        4
      ],
      "categories_ids": [
        143
      ]
    },
    "exclude": {
      "categories_ids": [
        141
      ]
    }
  },
  "create_redirect": {
    "url_from": "/colecao-antiga",
    "url_to": "/colecao-nova"
  }
}

Response

Coleção criada com sucesso

idinteger

ID da coleção.

parent_idinteger

ID da coleção pai, quando a coleção for uma subcoleção.

activeboolean

Indica se a coleção está ativa e visível na loja.

show_bannersboolean

Indica se os banners vinculados à coleção são exibidos na página dela.

featuredboolean

Indica se a coleção é destacada na navegação da loja.

is_promotionalboolean

Indica se a coleção é promocional, com período de vigência definido por start_at e end_at.

namestring

Nome da coleção.

visible_productsinteger

Quantidade de produtos exibidos na vitrine da coleção.

homeboolean

Indica se a coleção é exibida na página inicial da loja.

expiredboolean

Indica se a data de término da coleção já passou.

slugstring

Slug da coleção, usado na composição da URL.

descriptionstring

Texto descritivo exibido na página da coleção.

seo_titlestring

Título usado para SEO (tag title) da página da coleção.

seo_keywordsstring

Palavras-chave usadas para SEO da página da coleção.

seo_descriptionstring

Descrição usada para SEO (meta description) da página da coleção.

pathstring

Caminho relativo para o recurso.

expire_instring

Tempo restante até a expiração, descrito em formato textual (ex.: 'dentro de 998 anos').

total_productsinteger

Número total de produtos relacionados ao recurso.

Changes

No recorded changes to this operation across all 3 revisions of this API.