Listar complementos

GET

Markdown (LLM)

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

Enum

ascCrescente
descDecrescente (padrão)

desc

activeboolean

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

true

namestring

Filtra pelo nome do complemento.

Molho

codestring[]

Filtra pelo código interno.

MN1

barcodestring[]

Filtra pelo código de barras.

7891000315507

labelstring[]

Filtra pelos selos: new, recommended, bestSeller, limitedEdition, soldOut.

new

Parâmetros da resposta

complementIdnumber

Identificador do complemento.

2589008

storeIdnumber

Identificador da empresa.

38311

namestring

Nome do complemento.

"Molho Lemon Fresh"

descriptionstring

Descrição do complemento.

"Azeite, Limão Tahiti e Sal."

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

pricenumber

Preço de venda.

3

codestring

Código interno.

"ABC123"

barcodestring

Código de barras.

"ABC123"

unitstring

Unidade de medida (Default: UN).

Enum

UNUnidade
KGQuilograma
GGrama
LLitro

"UN"

activeboolean

Indica se está ativo em pelo menos um cardápio da empresa. Somente leitura.

true

featuredPrintboolean

Indica se tem destaque na impressão.

false

pagenumber

page da paginação.

1

limitnumber

limit da paginação.

2

totalnumber

total da paginação.

152

pagesnumber

pages da paginação.

76

Linguagem

Produção

Requisição

GET /v1/catalog/complements

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

Resposta

json

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102{
  "items": [
    {
      "complementId": 2589008,
      "storeId": 38311,
      "name": "Molho Lemon Fresh",
      "description": "Azeite, Limão Tahiti e Sal.",
      "price": 3,
      "unit": "UN",
      "active": true,
      "featuredPrint": false,
      "cost": {
        "base": 0,
        "supply": 0,
        "total": 0
      },
      "image": {
        "original": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411082010_1X5.webp",
        "thumbnail60": "https://beetech-imagens.beefood-r2.work/38311/p/60/202411082010_1X5.jpg",
        "thumbnail120": "https://beetech-imagens.beefood-r2.work/38311/p/120/202411082010_1X5.jpg",
        "thumbnailWeb": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411082010_1X5.webp"
      },
      "menus": [
        {
          "merchantId": 39202,
          "name": "Restaurante Exemplo",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "cashbackEnabled": true
        },
        {
          "merchantId": 50502,
          "name": "Restaurante Exemplo - Sushi",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "cashbackEnabled": true
        }
      ],
      "groups": [
        {
          "optionId": 5673284,
          "name": "Deseja algum molho?"
        }
      ]
    },
    {
      "complementId": 2589007,
      "storeId": 38311,
      "name": "Molho Shoyu Spicy",
      "description": "Shoyu, Óleo de Gergelim e Tabasco.",
      "price": 3,
      "unit": "UN",
      "active": true,
      "featuredPrint": false,
      "cost": {
        "base": 0,
        "supply": 0,
        "total": 0
      },
      "image": {
        "original": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411082010_R05.webp",
        "thumbnail60": "https://beetech-imagens.beefood-r2.work/38311/p/60/202411082010_R05.jpg",
        "thumbnail120": "https://beetech-imagens.beefood-r2.work/38311/p/120/202411082010_R05.jpg",
        "thumbnailWeb": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202411082010_R05.webp"
      },
      "menus": [
        {
          "merchantId": 39202,
          "name": "Restaurante Exemplo",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "cashbackEnabled": true
        },
        {
          "merchantId": 50502,
          "name": "Restaurante Exemplo - Sushi",
          "active": true,
          "delivery": true,
          "dineIn": true,
          "totem": true,
          "cashbackEnabled": true
        }
      ],
      "groups": [
        {
          "optionId": 5673281,
          "name": "Deseja algum molho?"
        }
      ]
    }
  ],
  "page": 1,
  "limit": 2,
  "total": 152,
  "pages": 76
}