Categorías
GET /v1/category Listar registros ▶
| Parám. | Descripción | Defecto |
|---|---|---|
page | Número de página | 1 |
per_page | Registros por página (máx. 1000) | 20 |
since | Inicio del rango de creación (columna entered). Solo fecha = desde las 00:00:00 | — |
until | Fin del rango de creación. Solo fecha = hasta las 23:59:59 | — |
q | Búsqueda de texto en los campos indicados en cada recurso: name | — |
s / o | Campo de ordenamiento · Sentido: asc o desc | según recurso |
f | Filtros exactos en JSON | — |
# página 2, 20 por página
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://pionono-sandbox.extranet.business/v1/category?page=2&per_page=20"
# creados en un rango de fechas, más recientes primero
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://pionono-sandbox.extranet.business/v1/category?since=2026-07-01&until=2026-07-31&s=entered&o=desc"
Respuesta
{
"status": "success",
"code": "200",
"message": "LIST",
"data": {
"a1b2c3d4-5e6f-7890-abcd-ef1234567890": {
"id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"name": "Nombre de ejemplo",
"mnu_id": "MNU-01",
"description": "Descripción de ejemplo",
"parent": "texto",
"order": 10,
"color": "texto",
"ico": "texto",
"slug": "nombre-de-ejemplo",
"sync": "texto",
"required": 1
}
},
"meta": {
"page": 1,
"per_page": 20,
"count": 1,
"total": 134
}
}
GET /v1/category/{id} Obtener un registro ▶
curl -H "X-SYNCS-API-TOKEN: TU_TOKEN" "https://pionono-sandbox.extranet.business/v1/category/ID"
Respuesta
{
"status": "success",
"code": "200",
"message": "GET",
"data": {
"id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"name": "Nombre de ejemplo",
"mnu_id": "MNU-01",
"description": "Descripción de ejemplo",
"parent": "texto",
"order": 10,
"color": "texto",
"ico": "texto",
"slug": "nombre-de-ejemplo",
"sync": "texto",
"required": 1
}
}
POST /v1/category Crear un registro ▶
Solo se graban las columnas de la lista blanca de cada recurso (los campos grabables que aparecen en cada endpoint); cualquier otra clave del JSON se ignora en silencio. Los componentes de la clave primaria que no se envíen toman el valor ---. El id puede enviarse (máximo 45 caracteres alfanuméricos, _, - y .); si se omite, la API genera un UUID.
Requeridos en POST
name mnu_id
Componentes de la clave — si no se envían toman ---
lng_id mnu_id
Campos grabables name description parent order color ico slug sync required
curl -X POST "https://pionono-sandbox.extranet.business/v1/category" \
-H "X-SYNCS-API-TOKEN: TU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Nombre de ejemplo",
"mnu_id": "MNU-01",
"description": "Descripción de ejemplo",
"parent": "texto",
"order": 10,
"color": "texto",
"ico": "texto",
"slug": "nombre-de-ejemplo",
"sync": "texto",
"required": 1
}'
Respuesta
{
"status": "success",
"code": "201",
"message": "ADD",
"data": {
"id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"name": "Nombre de ejemplo",
"mnu_id": "MNU-01",
"description": "Descripción de ejemplo",
"parent": "texto",
"order": 10,
"color": "texto",
"ico": "texto",
"slug": "nombre-de-ejemplo",
"sync": "texto",
"required": 1
}
}
PATCH /v1/category/{id} Actualizar un registro ▶
Ambos hacen exactamente lo mismo: actualización parcial. Solo se modifican las columnas presentes en el JSON, el resto queda intacto — no hace falta reenviar el registro completo. Se usa PATCH por corrección semántica y PUT por compatibilidad con clientes que no lo soportan. La API graba modified y modified_by automáticamente.
Si el id no existe (o ya se eliminó) responden 404 NO_DATA; si el JSON no trae ninguna columna válida, 400 NO_VALID_FIELDS.
Campos grabables name description parent order color ico slug sync required
curl -X PATCH "https://pionono-sandbox.extranet.business/v1/category/ID" \
-H "X-SYNCS-API-TOKEN: TU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"description": "Descripción de ejemplo",
"parent": "texto"
}'
Respuesta
{
"status": "success",
"code": "200",
"message": "UPDATE",
"data": {
"id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
"description": "Descripción de ejemplo",
"parent": "texto"
}
}
PUT /v1/category/{id} Actualizar (compatibilidad) — idéntico a PATCH ▶
Campos grabables name description parent order color ico slug sync required
curl -X PUT "https://pionono-sandbox.extranet.business/v1/category/ID" \
-H "X-SYNCS-API-TOKEN: TU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"description": "Descripción de ejemplo",
"parent": "texto"
}'
DELETE /v1/category/{id} Eliminar un registro — Elimina el registro ▶
curl -X DELETE "https://pionono-sandbox.extranet.business/v1/category/ID" \
-H "X-SYNCS-API-TOKEN: TU_TOKEN"
Respuesta
{
"status": "success",
"code": "200",
"message": "DELETED",
"data": null
}