Depois de carregados seus Produtos, é importante categorizá-los.
O que são as categorias? As Categorias na YOM organizam os Produtos em grupos lógicos, facilitando a navegação e a gestão de inventários.
Existem Categorias Pai, que podem ter Categorias Filho, permitindo uma estrutura hierárquica simples de um nível.
Estas Categorias são representadas na entidade Category. Uma Category contém as informações de cada grupo de Produtos, incluindo seu nome, descrição e relações com outros Produtos.
O endpoint de Categorias permite à YOM acessar informações detalhadas sobre cada Categoria registrada.
GET /api/categories
ARQUIVO <fecha>_<hora>_category.csv
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplos |
|---|---|---|---|---|
categoryId |
📝 Texto | 🟢 Obrigatório | A chave única que identifica a Categoria. | |
| *Deve conter apenas caracteres alfanuméricos. | "harinas" |
|||
name |
📝 Texto | 🟢 Obrigatório | Nome que será exibido para a Categoria do Produto. Deve ser reconhecível pelos usuários. | "Harinas" |
parentCategoryId |
📝 Texto | ⚪ Opcional | A chave única da Categoria pai. | |
*Deve ser o categoryId de uma categoria existente. |
||||
| *Ficará vazia para Categorias pai. | "alimentos" |
|||
description |
📝 Texto | ⚪ Opcional | Descrição da Categoria. | "Productos de harina disponibles en la tienda." |
tags |
🔡 Lista de Textos | 🟢 Obrigatório | Lista de strings para unir Categorias com Produtos. | |
| Permite ter keys opcionais para a mesma Categoria. | ||||
| *Se for usado para categorizar produtos, devem coincidir com as tags de Produto. | ["harinas", "orgánico", "integral", "ecológico"] |
|||
priority |
🔢 Número | ⚪ Opcional | Ordem em que são exibidas no B2B. | 1 |
isInactive |
🔘 Bool | ⚪ Opcional | A Categoria está desabilitada? | true |
false |
A resposta do endpoint de Categorias devolve um JSON que contém as informações detalhadas de cada categoria registrada na YOM, incluindo nome, descrição, relações de hierarquia e outros detalhes.
{
"categoryId": "harinas",
"name": "Harinas",
"parentCategoryId": "Alimentos",
"description": "Productos de harina disponibles en la tienda.",
"tags": ["harinas", "orgánico", "integral", "ecológico"],
"isInactive": true,
"priority": 1
}
Com este formato, você poderá gerenciar as categorias de seus produtos na YOM de maneira eficiente e organizada.