Skip to main content
GET
Visualizar coleção

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID da coleção

Response

Detalhes da coleção

Representa uma coleção a qual um produto pertence

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.