Listar grupos

GET

Markdown (LLM)

Lista os grupos da empresa.

Escopo:catalog:read

Limite:300 requisições a cada 3 minutos.

Parâmetros de query

pageinteger

Página (padrão 1).

1

limitinteger

Itens por página, de 1 a 100 (padrão 20).

20

sortstring

Ordem por groupId: asc ou desc (padrão desc).

Enum

ascCrescente
descDecrescente (padrão)

desc

namestring

Filtra pelo nome do grupo.

massa

activeboolean

Filtra grupos ativos ou inativos.

true

requiredboolean

Filtra grupos obrigatórios.

true

priceFormationstring

Filtra pela formação de preço: sumgifthighestproportional

gift

productIdinteger

Filtra grupos vinculados ao produto.

2585290

Parâmetros da resposta

pagenumber

page da paginação.

1

limitnumber

limit da paginação.

20

totalnumber

total da paginação.

1

pagesnumber

pages da paginação.

1

Linguagem

Produção

Requisição

GET /v1/catalog/groups

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/catalog/groups?page=1&limit=20&sort=desc",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

123456789101112131415161718192021222324252627282930313233{
  "items": [
    {
      "groupId": 264006,
      "name": "Acompanhamentos",
      "active": true,
      "delivery": true,
      "dineIn": true,
      "required": true,
      "pizza": false,
      "sortOrder": 0,
      "priceFormation": "gift",
      "minQuantity": 1,
      "maxQuantity": 1,
      "products": [
        {
          "productId": 2585290,
          "name": "Combo Supreme",
          "image": {
            "original": "https://cdn.beefood.com.br/products/2585290.jpg",
            "thumbnail60": "https://cdn.beefood.com.br/products/2585290_60.jpg",
            "thumbnail120": "https://cdn.beefood.com.br/products/2585290_120.jpg",
            "thumbnailWeb": "https://cdn.beefood.com.br/products/2585290_web.jpg"
          }
        }
      ]
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 1,
  "pages": 1
}