Detalhe do complemento

GET

Markdown (LLM)

Retorna o detalhe de um complemento.

Escopo:catalog:read

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

Parâmetros de path

complementIdinteger

Identificador do complemento.

2587090

Parâmetros da resposta

complementIdnumber

Identificador do complemento.

2515324

storeIdnumber

Identificador da empresa.

38311

namestring

Nome do complemento.

"Onion rings"

descriptionstring

Descrição do complemento.

"Porção c/ 08 onion (cebola empanada)"

labelstring

Selo do cardápio: newrecommendedbestSellerlimitedEdition

"new"

pricenumber

Preço de venda.

4

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

Linguagem

Produção

Requisição

GET /v1/catalog/complements/{complementId}

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/catalog/complements/{complementId}",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051{
  "complementId": 2515324,
  "storeId": 38311,
  "name": "Onion rings",
  "description": "Porção c/ 08 onion (cebola empanada)",
  "price": 4,
  "unit": "UN",
  "active": true,
  "featuredPrint": false,
  "cost": {
    "base": 0,
    "supply": 0,
    "total": 0
  },
  "image": {
    "original": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202608181109_832.webp",
    "thumbnail60": "https://beetech-imagens.beefood-r2.work/38311/p/60/202608181109_832.jpg",
    "thumbnail120": "https://beetech-imagens.beefood-r2.work/38311/p/120/202608181109_832.jpg",
    "thumbnailWeb": "https://beetech-imagens.beefood-r2.work/38311/p/webp/202608181109_832.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": 5616517,
      "name": "Acompanhamentos"
    },
    {
      "optionId": 5616578,
      "name": "Acompanhamentos"
    }
  ]
}