Skip to main content
GET
Visualizar categoria

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 categoria

Response

Detalhes da categoria

Recursos adicionais da categoria, retornados sob demanda via parâmetro include.

id
integer

ID da categoria.

merchant_id
integer
read-only

ID da loja dona da categoria.

parent_id
integer

ID da categoria pai, quando a categoria for uma subcategoria.

active
boolean

Indica se a categoria está ativa e visível na loja.

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

price_factor
number<float>

Fator de multiplicação aplicado aos preços dos produtos da categoria.

total_banners
integer

Quantidade de banners vinculados à categoria.

Example:

0

sort_by
string

Ordenação padrão dos produtos da categoria: relevance, highest_price, lowest_price, best_rating, name_asc, name_desc, newest, random ou best_sellers.

name
string

Nome da categoria.

slug
string

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

url
string<url>

URL completa da página da categoria na loja.

description
string

Texto descritivo exibido na página da categoria.

external_url
string

URL externa para onde a categoria aponta, em vez da página da loja.

canonical_url
string

URL canônica da página da categoria, usada para SEO.

order
integer

Ordem de exibição da categoria entre as categorias do mesmo nível.

is_parent
boolean

Indica se a categoria é principal.

url_path
string

Caminho relativo para a URL da categoria.

slug_path
string

Slug completo da categoria, incluindo hierarquia.

filters_values_ids
integer[]

Lista de IDs de filtros associados à categoria.

category_cover
string<url>

URL da imagem de capa da categoria.

created_at
object
updated_at
object