Skip to main content
GET
Listar categorias

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

Body

application/json
active
boolean
required

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

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

name
string

Nome da categoria.

slug
string

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

seo_title
string

Título usado para SEO da página da categoria. O valor é sanitizado e normalizado automaticamente.

seo_keywords
string

Palavras-chave usadas para SEO da página da categoria.

seo_description
string

Descrição usada para SEO da página da categoria. O valor é sanitizado e normalizado automaticamente.

banners_ids
integer[]

IDs dos banners vinculados à categoria.

external_url
string<url>

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

canonical_url
string<url>

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

Response

200 - application/json

Lista de categorias obtida com sucesso

data
SimplePaginatorWithMeta · object[]

Lista de categorias do catálogo.