Logo da Plataforma Yep
API REST · Plataforma Yep Documentação técnica para integrações homologadas

Categorias

Criação, atualização, consulta, movimentação na árvore e exclusão de categorias do catálogo.

Árvore URL key Display mode

Visão geral

As rotas de categoria cobrem o ciclo completo: criar uma nova categoria na árvore, atualizar metadados, consultar por ID, mover dentro da hierarquia e excluir.

POST/api2/category

Criar nova categoria.

{
  "parent_id": 2,
  "name": "Especialidades",
  "position": 5,
  "is_active": 1,
  "is_anchor": 1,
  "include_in_menu": 1,
  "description": "Categoria de especialidades odontológicas",
  "display_mode": "PRODUCTS",
  "url_key": "especialidades"
}
PATCH/api2/category

Atualizar categoria existente.

{
  "name": "Especialidades",
  "categoria": {
    "name": "Novo nome",
    "description": "Nova descrição",
    "is_anchor": 1
  }
}
GET/api2/category?id=61

Consultar categoria por ID.

PATCH/api2/category/categoryMove

Mover categoria na árvore.

{
  "name": "Especialidades",
  "parent_name": "Produtos",
  "after_id": null
}
DELETE/api2/category

Excluir categoria.

{
  "category_id": 546
}