Listar categorías

curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?sort=order&branch_id=*" \
  -H "x-api-key: TU_CLAVE_API"

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas nuestras pizzas artesanales",
      "order": 1,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
      "parent_id": null,
      "created_at": "2026-02-19T15:30:00.000000Z",
      "updated_at": "2026-02-19T15:30:00.000000Z"
    },
    {
      "id": 2,
      "name": "Bebidas",
      "image": null,
      "description": "Bebidas frías y calientes",
      "order": 2,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": null,
      "parent_id": null,
      "created_at": "2026-02-19T15:35:00.000000Z",
      "updated_at": "2026-02-19T15:35:00.000000Z"
    }
  ],
  "links": {
    "first": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?page=1",
    "last": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

GET

ecommerce

apps

{app_id}

categories

curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?sort=order&branch_id=*" \
  -H "x-api-key: TU_CLAVE_API"

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas nuestras pizzas artesanales",
      "order": 1,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
      "parent_id": null,
      "created_at": "2026-02-19T15:30:00.000000Z",
      "updated_at": "2026-02-19T15:30:00.000000Z"
    },
    {
      "id": 2,
      "name": "Bebidas",
      "image": null,
      "description": "Bebidas frías y calientes",
      "order": 2,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": null,
      "parent_id": null,
      "created_at": "2026-02-19T15:35:00.000000Z",
      "updated_at": "2026-02-19T15:35:00.000000Z"
    }
  ],
  "links": {
    "first": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?page=1",
    "last": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

app_id

string

requerido

ID de tu tienda en Jelou Shop.

paginate

boolean

predeterminado:"true"

Envía false para obtener todas las categorías sin paginación.

include

string

Usa products para incluir los productos de cada categoría en la respuesta.

sort

string

Ordenamiento, como lista separada por comas. Antepón - para orden descendente (ej. sort=order,-name). Campos ordenables: order, name, created_at. Los campos no reconocidos se ignoran.

branch_id

string

Filtra las categorías por sucursal. Controla qué categorías se devuelven:

Omitido → solo categorías globales (sin sucursal, branch_id nulo).
branch_id=<uuid> → solo las categorías de esa sucursal.
branch_id=* → categorías de todas las sucursales (y las globales).

branch

string

Filtra las categorías por el código de una sucursal. Si el código no existe, la respuesta es vacía. Tiene prioridad sobre branch_id.

tree

boolean

predeterminado:"false"

Envía true para obtener las categorías como un árbol anidado por parent_id. Ver Modo árbol.

curl "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?sort=order&branch_id=*" \
  -H "x-api-key: TU_CLAVE_API"

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas nuestras pizzas artesanales",
      "order": 1,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": "9e3f2c1a-8b7d-4e6f-a5c4-d3b2a1e0f9c8",
      "parent_id": null,
      "created_at": "2026-02-19T15:30:00.000000Z",
      "updated_at": "2026-02-19T15:30:00.000000Z"
    },
    {
      "id": 2,
      "name": "Bebidas",
      "image": null,
      "description": "Bebidas frías y calientes",
      "order": 2,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": null,
      "parent_id": null,
      "created_at": "2026-02-19T15:35:00.000000Z",
      "updated_at": "2026-02-19T15:35:00.000000Z"
    }
  ],
  "links": {
    "first": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?page=1",
    "last": "https://gateway.jelou.ai/ecommerce/v2/apps/{app_id}/categories?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Campos filtrables: status, branch_id Campos buscables: name Campos ordenables: order, name, created_at

El campo parent_id indica la categoría padre (jerarquía). Es null para las categorías raíz. El conteo products_count solo se devuelve en el modo árbol, no en el listado plano.

Modo árbol

Con tree=true, la respuesta devuelve las categorías anidadas por parent_id. Cada nodo agrega:

children: arreglo de subcategorías (misma estructura, recursivo).
children_count: cantidad de hijos directos.
products_count: cantidad de productos activos en esa categoría.

Los filtros branch, branch_id, status y sort también aplican en este modo. La respuesta del árbol no se pagina.

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas nuestras pizzas artesanales",
      "order": 1,
      "status": true,
      "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
      "branch_id": null,
      "parent_id": null,
      "products_count": 12,
      "created_at": "2026-02-19T15:30:00.000000Z",
      "updated_at": "2026-02-19T15:30:00.000000Z",
      "children_count": 1,
      "children": [
        {
          "id": 5,
          "name": "Pizzas Premium",
          "order": 1,
          "status": true,
          "app_id": "8af29efb-9864-4f29-888c-b2dd0d7ac1dd",
          "branch_id": null,
          "parent_id": 1,
          "products_count": 4,
          "children_count": 0,
          "children": []
        }
      ]
    }
  ]
}

Reemplaza {app_id} con el ID de tu tienda y TU_CLAVE_API con tu clave API.

Crear y actualizar categorías

Obtener categoría

⌘I

Empezando

Agentes IA

Nodos

Variables

Mensajería Outbound

Gestión

Marketplace

Canales

Configuración

Facturación

Modo árbol

​Modo árbol

Modo árbol