--- title: "Listar complementos" description: "GET /v1/catalog/complements — complementos da empresa BeeFood, com filtros e paginação." method: "GET" path: "/v1/catalog/complements" url: "https://developer.beefood.com.br/docs/catalogo/complementos" group: "Catálogo" scope: "catalog:read" lang: "pt" --- # Listar complementos `GET /v1/catalog/complements` - Produção: `https://api.beefood.app/v1/catalog/complements` - Sandbox: `https://api-sandbox.beefood.app/v1/catalog/complements` Lista os complementos da empresa. ## Autenticação Envie o access token no header `Authorization: Bearer `. Escopo necessário: `catalog:read`. Limite: 300 requisições a cada 3 minutos. ## Parâmetros de query - `page` *integer* — Página (padrão 1). Exemplo: `1`. - `limit` *integer* — Itens por página, de 1 a 100 (padrão 20). Exemplo: `20`. - `sort` *string* — Ordem por complementId: asc ou desc (padrão desc). Exemplo: `desc`. - *Valores:* `asc`, `desc` - `active` *boolean* — Filtra complementos ativos ou inativos em algum cardápio da empresa. Exemplo: `true`. - `name` *string* — Filtra pelo nome do complemento. Exemplo: `Molho`. - `code` *string[]* — Filtra pelo código interno. Exemplo: `MN1`. - `barcode` *string[]* — Filtra pelo código de barras. Exemplo: `7891000315507`. - `label` *string[]* — Filtra pelos selos: new, recommended, bestSeller, limitedEdition, soldOut. Exemplo: `new`. ## Exemplos de requisição ### cURL ```bash curl -X GET "https://api.beefood.app/v1/catalog/complements?page=1&limit=20&sort=desc" \ -H "Authorization: Bearer $ACCESS_TOKEN" ``` ## Exemplos de resposta ### 200 OK ```json { "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 } ``` ## Campos da resposta - `items[].complementId` *number* — Identificador do complemento. - `items[].storeId` *number* — Identificador da empresa. - `items[].name` *string* — Nome do complemento. - `items[].description` *string* — Descrição do complemento. - `items[].label` *string* — Selo do cardápio: new, recommended, bestSeller, limitedEdition ou soldOut. - `items[].price` *number* — Preço de venda. - `items[].code` *string* — Código interno. - `items[].barcode` *string* — Código de barras. - `items[].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` - `items[].active` *boolean* — Indica se está ativo em pelo menos um cardápio da empresa. Somente leitura. - `items[].featuredPrint` *boolean* — Indica se tem destaque na impressão. - `items[].cost` *object* — Custos do complemento. - `items[].cost.base` *number* — Custo base. - `items[].cost.supply` *number* — Custo da ficha técnica. Somente leitura. - `items[].cost.total` *number* — Soma do custo base com o custo da ficha técnica. Somente leitura. - `items[].image` *object* — URLs da imagem do complemento. Somente leitura. Para enviar ou remover, use Enviar imagem e Remover imagem com resourceType = complements. - `items[].image.original` *string* — Imagem original. - `items[].image.thumbnail60` *string* — Miniatura de 60 px. - `items[].image.thumbnail120` *string* — Miniatura de 120 px. - `items[].image.thumbnailWeb` *string* — Miniatura para web. - `items[].menus` *array* — Configurações do complemento por cardápio. - `items[].menus[].merchantId` *number* — Identificador do cardápio. - `items[].menus[].name` *string* — Nome do cardápio. Somente leitura. - `items[].menus[].active` *boolean* — Indica se está ativo neste cardápio. - `items[].menus[].delivery` *boolean* — Indica se aparece no delivery. - `items[].menus[].deliveryPrice` *number* — Preço no delivery. - `items[].menus[].dineIn` *boolean* — Indica se aparece no presencial. - `items[].menus[].dineInPrice` *number* — Preço no presencial. - `items[].menus[].totem` *boolean* — Indica se aparece no totem. - `items[].menus[].promotionPrice` *number* — Preço promocional. - `items[].menus[].sortOrder` *number* — Posição de exibição. - `items[].menus[].featuredOrder` *number* — Posição entre destaques. - `items[].menus[].cashbackEnabled` *boolean* — Indica se o cashback está ativo neste cardápio. - `items[].groups` *array* — Grupos de opções em que o complemento aparece. Somente leitura. - `items[].groups[].optionId` *number* — Identificador da opção no grupo. - `items[].groups[].name` *string* — Nome do grupo. - `page` *number* — page da paginação. - `limit` *number* — limit da paginação. - `total` *number* — total da paginação. - `pages` *number* — pages da paginação. ## 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 | ## Vocabulários usados neste endpoint ## Listagens · sort | Valor | Significado | Uso | | --- | --- | --- | | `asc` | Crescente | Todas as listagens | | `desc` | Decrescente (padrão) | Todas as listagens | ## 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 |