Luego de cargados tus Productos, es importante categorizarlos.
¿Qué son las categorías? Las Categorías en YOM organizan los Productos en grupos lógicos, facilitando la navegación y la gestión de inventarios.
Existen Categorías Padre, las cuales pueden tener Categorías Hijo, permitiendo una estructura jerárquica sencilla de un nivel.
Estas Categorías se representan en la entidad Category. Una Category contiene la información de cada grupo de Productos, incluyendo su nombre, descripción, y relaciones con otros Productos.
El endpoint de Categorías le permite a YOM acceder a información detallada sobre cada Categoría registrada.
GET /api/categories
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
categoryId |
📝 Texto | 🟢 Requerido | La clave única que identifica la Categoría. | |
| *Solo debe contener caracteres alfanuméricos. | "harinas" |
|||
name |
📝 Texto | 🟢 Requerido | Nombre que se mostrará para la Categoría del Producto. Debe ser reconocible por los usuarios. | "Harinas" |
parentCategoryId |
📝 Texto | 🟡 Recomendado | La clave única de la Categoría padre. | |
*Debe ser el categoryId de una categoría existente. |
||||
| *Será vacía para Categorías padre. | "alimentos" |
|||
description |
📝 Texto | 🟡 Recomendado | Descripción de la Categoría. | "Productos de harina disponibles en la tienda." |
tags |
🔡 Lista de Textos | 🟡 Recomendado | Lista de strings para unir Categorías con Productos. | |
| Permite tener keys opcionales para la misma Categoría. |
["harinas", "orgánico", "integral", "ecológico"] |
| priority | 🔢 Número | 🟡 Recomendado | Orden en el que se muestran en el B2B. | 1 |
| isInactive | 🔘 Bool | 🟡 Recomendado | ¿Está deshabilitada la Categoría? | true
false |La respuesta del endpoint de Categorías devuelve un JSON que contiene la información detallada de cada categoría registrada en YOM, incluyendo nombre, descripción, relaciones de jerarquía y otros detalles.
{
"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
}
Con este formato, podrás gestionar y las categorías de tus productos en YOM de manera eficiente y organizada.
Pasos anteriores
<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Productos
</aside>
Siguientes pasos
<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Crédito
</aside>
Tabla de contenidos