Listar produtos

GET

Markdown (LLM)

Lista os produtos 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 (padrão 20).

20

sortstring

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

Enum

ascCrescente
descDecrescente (padrão)

desc

activeboolean

Filtra produtos ativos ou inativos em algum cardápio da empresa.

true

sectorIdinteger[]

Filtra por IDs de setor (array).

1997

sectorNamestring

Filtra pelo nome do setor (contém).

Pizzas

namestring

Filtra pelo nome do produto (contém).

Pizza

codestring

Filtra pelo código interno.

25

barcodestring

Filtra pelo código de barras.

7891000315507

featuredboolean

Filtra produtos em destaque.

true

cashbackEnabledboolean

Filtra produtos com cashback ativo em algum cardápio da empresa.

true

comboboolean

Filtra combos.

false

labelstring[]

Filtra pelos selos: new, recommended, bestSeller, limitedEdition, soldOut (array).

new

Parâmetros da resposta

productIdnumber

Identificador do produto.

2589035

storeIdnumber

Identificador da empresa.

38311

barcodestring

Código de barras.

"ABC123"

codestring

Código interno.

"ABC123"

typestring

Tipo derivado do PDV: "product". Somente leitura.

"product"

namestring

Nome do produto.

"Água com Gás 500ml"

descriptionstring

Descrição do produto.

"Importante: imagem meramente ilustrativa…"

internalNotesstring

Observações internas.

"Disponível por tempo indeterminado."

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

unitstring

Unidade de medida (Default: UN).

Enum

UNUnidade
KGQuilograma
GGrama
LLitro

"UN"

pricenumber

Preço padrão.

6.9

featuredboolean

Indica se está em destaque.

false

featuredPrintboolean

Indica se tem destaque na impressão.

false

serviceFeeActiveboolean

Indica se a taxa de serviço está ativa.

true

scheduleOnlyboolean

Indica se a venda é apenas por agendamento.

false

scaleActiveboolean

Indica se a balança está ativa.

false

scaleShelfLifeDaysnumber

Validade em dias na balança.

sectorIdnumber

Identificador de um setor da mesma empresa.

213756

sectorNamestring

Nome do setor. Somente leitura.

"Bebidas"

comboboolean

Indica se é combo. Somente leitura: vira true quando o produto tem ao menos um grupo vinculado e volta a false quando o último é desvinculado.

false

pagenumber

page da paginação.

1

limitnumber

limit da paginação.

2

totalnumber

total da paginação.

166

pagesnumber

pages da paginação.

83

Linguagem

Produção

Requisição

GET /v1/catalog/products

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

Resposta

json

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108{
  "items": [
    {
      "productId": 2589035,
      "storeId": 38311,
      "type": "product",
      "name": "Água com Gás 500ml",
      "description": "Importante: imagem meramente ilustrativa. A marca do produto será enviada confirma disponibilidade do mesmo.",
      "unit": "UN",
      "price": 6.9,
      "featured": false,
      "featuredPrint": false,
      "serviceFeeActive": true,
      "scheduleOnly": false,
      "scaleActive": false,
      "sectorId": 213756,
      "sectorName": "Bebidas",
      "combo": false,
      "cost": {
        "base": 0,
        "supply": 0,
        "total": 0
      },
      "image": {
        "original": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411061918_7F7.webp",
        "thumbnail60": "https://beetech-imagens.beefood-r2.work/38311/p/60/202411061918_7F7.jpg",
        "thumbnail120": "https://beetech-imagens.beefood-r2.work/38311/p/120/202411061918_7F7.jpg",
        "thumbnailWeb": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411061918_7F7.webp"
      },
      "menus": [
        {
          "merchantId": 39202,
          "name": "Restaurante Exemplo",
          "active": false,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "sortOrder": 1,
          "cashbackEnabled": true
        },
        {
          "merchantId": 50502,
          "name": "Restaurante Exemplo - Sushi",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "sortOrder": 2,
          "cashbackEnabled": true
        }
      ]
    },
    {
      "productId": 2589034,
      "storeId": 38311,
      "type": "product",
      "name": "Água sem Gás 500ml",
      "description": "Importante: imagem meramente ilustrativa. A marca do produto será enviada confirma disponibilidade do mesmo.",
      "unit": "UN",
      "price": 6,
      "featured": false,
      "featuredPrint": false,
      "serviceFeeActive": true,
      "scheduleOnly": false,
      "scaleActive": false,
      "sectorId": 213756,
      "sectorName": "Bebidas",
      "combo": false,
      "cost": {
        "base": 0,
        "supply": 0,
        "total": 0
      },
      "image": {
        "original": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411061917_KAF.webp",
        "thumbnail60": "https://beetech-imagens.beefood-r2.work/38311/p/60/202411061917_KAF.jpg",
        "thumbnail120": "https://beetech-imagens.beefood-r2.work/38311/p/120/202411061917_KAF.jpg",
        "thumbnailWeb": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411061917_KAF.webp"
      },
      "menus": [
        {
          "merchantId": 39202,
          "name": "Restaurante Exemplo",
          "active": false,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "sortOrder": 2,
          "cashbackEnabled": true
        },
        {
          "merchantId": 50502,
          "name": "Restaurante Exemplo - Sushi",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "sortOrder": 3,
          "cashbackEnabled": true
        }
      ]
    }
  ],
  "page": 1,
  "limit": 2,
  "total": 166,
  "pages": 83
}