Listar categorias

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

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas as nossas pizzas artesanais",
      "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 quentes e frias",
      "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: YOUR_API_KEY"

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas as nossas pizzas artesanais",
      "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 quentes e frias",
      "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
  }
}

string

obrigatório

O ID da sua loja no Jelou Shop.

boolean

padrão:"true"

Envie false para obter todas as categorias sem paginação.

string

Use products para incluir os produtos de cada categoria na resposta.

string

Ordenação, como lista separada por vírgulas. Prefixe com - para ordem decrescente (ex.: sort=order,-name). Campos ordenáveis: order, name, created_at. Campos não reconhecidos são ignorados.

string

Filtra as categorias por filial. Controla quais categorias são retornadas:

Omitido → apenas categorias globais (sem filial, branch_id nulo).
branch_id=<uuid> → apenas as categorias dessa filial.
branch_id=* → categorias de todas as filiais (e as globais).

string

Filtra as categorias pelo código de uma filial. Se o código não existir, a resposta é vazia. Tem prioridade sobre branch_id.

boolean

padrão:"false"

Envie true para obter as categorias como uma árvore aninhada por parent_id. Veja Modo árvore.

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

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas as nossas pizzas artesanais",
      "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 quentes e frias",
      "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 filtráveis: status, branch_id Campos pesquisáveis: name Campos ordenáveis: order, name, created_at

O campo parent_id indica a categoria pai (hierarquia). É null para as categorias raiz. O valor products_count só é retornado no modo árvore, não na listagem plana.

Modo árvore

Com tree=true, a resposta retorna as categorias aninhadas por parent_id. Cada nó adiciona:

children: array de subcategorias (mesma estrutura, recursivo).
children_count: quantidade de filhos diretos.
products_count: quantidade de produtos ativos nessa categoria.

Os filtros branch, branch_id, status e sort também se aplicam neste modo. A resposta da árvore não é paginada.

{
  "data": [
    {
      "id": 1,
      "name": "Pizzas",
      "image": "categories/664f1a2b3c4d5.jpg",
      "description": "Todas as nossas pizzas artesanais",
      "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": []
        }
      ]
    }
  ]
}

Substitua {app_id} pelo ID da sua loja e YOUR_API_KEY pela sua chave de API.

Primeiros Passos

Desenvolvedor

Jelou CLI

Mensagens Outbound

Caixa de entrada

Marketplace

Canais

Configuração

Faturamento

Modo árvore

​Modo árvore

Modo árvore