YAyampi
Catálogo - Coleções

Visualizar coleção

Retorna os detalhes de uma coleção específica

get/{alias}/catalog/collections/{id}

Request

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

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da coleção

Response

Detalhes da coleção

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.