v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Catálogo - Categorias

Atualizar categoria

Atualiza os detalhes de uma categoria específica

put/{alias}/catalog/categories/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID da categoria

Request body

activeboolean required

namestring required

parent_idinteger nullable

homeboolean nullable

featuredboolean

price_factornumber float

slugstring

seo_titlestring

O valor é sanitizado e normalizado automaticamente.

seo_keywordsstring

seo_descriptionstring

O valor é sanitizado e normalizado automaticamente.

external_urlstring url

canonical_urlstring url

orderinteger

sort_bystring

banners_idsinteger[]

Example request

{
  "active": true,
  "name": "Categoria",
  "price_factor": 1,
  "slug": "categoria",
  "seo_title": "Título SEO para categoria",
  "seo_keywords": "palavras, chave, SEO",
  "seo_description": "Descrição SEO",
  "external_url": "https://www.link.com",
  "canonical_url": "https://www.link.com",
  "order": 1,
  "sort_by": "relevance",
  "create_redirect": {
    "url_from": "/categoria-antiga",
    "url_to": "/categoria-nova"
  }
}

Response

Categoria atualizada com sucesso

idinteger

merchant_idinteger

parent_idinteger

activeboolean

featuredboolean

price_factornumber float

total_bannersinteger

sort_bystring

namestring

slugstring

urlstring url

descriptionstring

external_urlstring

canonical_urlstring

orderinteger

is_parentboolean

Indica se a categoria é principal.

url_pathstring

Caminho relativo para a URL da categoria.

slug_pathstring

Slug completo da categoria, incluindo hierarquia.

filters_values_idsinteger[]

Lista de IDs de filtros associados à categoria.

category_coverstring url

URL da imagem de capa da categoria.

Example response

{
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}