Skip to main content
GET
Listar Coleções de uma loja

Path Parameters

alias
string
required

Alias da loja

Query Parameters

id[]
string
required

ID da coleção - exemplo: /{alias}/public/catalog/collections?id[]=5287&id[]=7821

Response

Retorna as Informações públicas de uma Coleção

Representa uma coleção do catálogo

id
integer

ID da coleção.

parent_id
integer

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

active
boolean

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

show_banners
boolean

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

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

is_promotional
boolean

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

name
string

Nome da coleção.

visible_products
integer

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

home
boolean

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

expired
boolean

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

slug
string

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

description
string

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

seo_title
string

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

seo_keywords
string

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

seo_description
string

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

path
string

Caminho relativo para o recurso.

expire_in
string

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

total_products
integer

Número total de produtos relacionados ao recurso.

restriced
boolean

Indica se a coleção tem regras de restrição de produtos (inclusão ou exclusão por marca e categoria).

url
string<uri>

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

stopwatch
string

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

stopwatch_expires_in
string

Data e hora em que a contagem regressiva termina: o fim do dia atual quando stopwatch for daily, ou a data de término da coleção.

start_at
object
end_at
object
created_at
object
updated_at
object
products
object[]
banners
object[]