Listar setores

GET

Markdown (LLM)

Lista os setores 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 sectorId: asc ou desc (padrão desc).

Enum

ascCrescente
descDecrescente (padrão)

desc

namestring

Filtra pelo nome do setor.

Sobremesas

activeboolean

true: ativo em ao menos um cardápio; false: inativo em todos.

true

deliveryboolean

Filtra setores ativos para delivery.

true

dineInboolean

Filtra setores ativos para presencial.

true

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/sectors

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

Resposta

json

1234567891011121314151617181920212223242526272829{
  "items": [
    {
      "sectorId": 221145,
      "storeId": 107,
      "name": "Campanhas de Desconto",
      "publicName": "Campanhas",
      "delivery": true,
      "dineIn": true,
      "image": {
        "original": "https://beetech-imagens.s3-sa-east-1.amazonaws.com/107/001308e84.jpg",
        "thumbnail80": "https://beetech-imagens.beefood-r2.work/107/s/80/001308e84.jpg",
        "thumbnail180": "https://beetech-imagens.beefood-r2.work/107/s/180/001308e84.jpg"
      },
      "menus": [
        {
          "merchantId": 122,
          "name": "Restaurante Exemplo",
          "active": true,
          "sortOrder": 1
        }
      ]
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 1,
  "pages": 1
}