---
title: "Detalhe do complemento"
description: "GET /v1/catalog/complements/{complementId} — detalhe de um complemento no cardápio da BeeFood."
method: "GET"
path: "/v1/catalog/complements/{complementId}"
url: "https://developer.beefood.com.br/docs/catalogo/complemento"
group: "Catálogo"
scope: "catalog:read"
lang: "pt"
---
# Detalhe do complemento

`GET /v1/catalog/complements/{complementId}`

- Produção: `https://api.beefood.app/v1/catalog/complements/{complementId}`
- Sandbox: `https://api-sandbox.beefood.app/v1/catalog/complements/{complementId}`

Retorna o detalhe de um complemento.

## Autenticação

Envie o access token no header `Authorization: Bearer <accessToken>`. Escopo necessário: `catalog:read`. Limite: 300 requisições a cada 3 minutos.


## Parâmetros de path

- `complementId` *integer* **obrigatório** — Identificador do complemento. Exemplo: `2587090`.





## Exemplos de requisição

### cURL

```bash
curl -X GET "https://api.beefood.app/v1/catalog/complements/{complementId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
```


## Exemplos de resposta

### 200 OK

```json
{
  "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"
    }
  ]
}
```


## Campos da resposta

- `complementId` *number* — Identificador do complemento.

- `storeId` *number* — Identificador da empresa.

- `name` *string* — Nome do complemento.

- `description` *string* — Descrição do complemento.

- `label` *string* — Selo do cardápio: new, recommended, bestSeller, limitedEdition ou soldOut.

- `price` *number* — Preço de venda.

- `code` *string* — Código interno.

- `barcode` *string* — Código de barras.

- `unit` *string* — Unidade de medida (Default: UN): UN, KG, G, L, ML, PCT, CX, DZ, FD, BD, SC, PT, CP, PC, FT, PQ, GF, LT ou BN.
  - *Valores:* `UN`, `KG`, `G`, `L`, `ML`, `PCT`, `CX`, `DZ`, `FD`, `BD`, `SC`, `PT`, `CP`, `PC`, `FT`, `PQ`, `GF`, `LT`, `BN`

- `active` *boolean* — Indica se está ativo em pelo menos um cardápio da empresa. Somente leitura.

- `featuredPrint` *boolean* — Indica se tem destaque na impressão.

- `cost` *object* — Custos do complemento.

- `cost.base` *number* — Custo base.

- `cost.supply` *number* — Custo da ficha técnica. Somente leitura.

- `cost.total` *number* — Soma do custo base com o custo da ficha técnica. Somente leitura.

- `image` *object* — URLs da imagem do complemento. Somente leitura. Para enviar ou remover, use Enviar imagem e Remover imagem com resourceType = complements.

- `image.original` *string* — Imagem original.

- `image.thumbnail60` *string* — Miniatura de 60 px.

- `image.thumbnail120` *string* — Miniatura de 120 px.

- `image.thumbnailWeb` *string* — Miniatura para web.

- `menus` *array* — Configurações do complemento por cardápio.

- `menus[].merchantId` *number* — Identificador do cardápio.

- `menus[].name` *string* — Nome do cardápio. Somente leitura.

- `menus[].active` *boolean* — Indica se está ativo neste cardápio.

- `menus[].delivery` *boolean* — Indica se aparece no delivery.

- `menus[].deliveryPrice` *number* — Preço no delivery.

- `menus[].dineIn` *boolean* — Indica se aparece no presencial.

- `menus[].dineInPrice` *number* — Preço no presencial.

- `menus[].totem` *boolean* — Indica se aparece no totem.

- `menus[].promotionPrice` *number* — Preço promocional.

- `menus[].sortOrder` *number* — Posição de exibição.

- `menus[].featuredOrder` *number* — Posição entre destaques.

- `menus[].cashbackEnabled` *boolean* — Indica se o cashback está ativo neste cardápio.

- `groups` *array* — Grupos de opções em que o complemento aparece. Somente leitura.

- `groups[].optionId` *number* — Identificador da opção no grupo.

- `groups[].name` *string* — Nome do grupo.



## Erros

| Status | Mensagem |
| --- | --- |
| 401 | Authentication token is missing |
| 401 | Invalid or expired access token |
| 403 | This credential does not include the catalog:read scope |
| 429 | Too many requests |
| 404 | Complement not found |


## Vocabulários usados neste endpoint

## Catálogo · unit

Valores aceitos no campo unit dos produtos do catálogo.

| Valor | Significado | Uso |
| --- | --- | --- |
| `UN` | Unidade | /v1/catalog/products |
| `KG` | Quilograma | /v1/catalog/products |
| `G` | Grama | /v1/catalog/products |
| `L` | Litro | /v1/catalog/products |
| `ML` | Mililitro | /v1/catalog/products |
| `PCT` | Pacote | /v1/catalog/products |
| `CX` | Caixa | /v1/catalog/products |
| `DZ` | Dúzia | /v1/catalog/products |
| `FD` | Fardo | /v1/catalog/products |
| `BD` | Balde | /v1/catalog/products |
| `SC` | Saco | /v1/catalog/products |
| `PT` | Pote | /v1/catalog/products |
| `CP` | Copo | /v1/catalog/products |
| `PC` | Peça | /v1/catalog/products |
| `FT` | Fátia | /v1/catalog/products |
| `PQ` | Porção | /v1/catalog/products |
| `GF` | Garrafa | /v1/catalog/products |
| `LT` | Lata | /v1/catalog/products |
| `BN` | Bandeja | /v1/catalog/products |