Listar produtos por categoria
Retorna as categorias de produtos do restaurante e, dentro de cada categoria, seus respectivos produtos. **Observações** - Produtos/categorias com `deleted_at` diferente de `null` já foram deletados. - `is_exclusive` indica categorias/produtos de uso exclusivo do restaurante, que não aparecem para o cliente final. - `price` é o preço presencial; `price_promotion` o preço promocional presencial (se houver). `delivery_price` é o preço para delivery/retirada; `delivery_price_promotion` o promocional para delivery (se houver). Sem `delivery_price`, usa-se `price`/`price_promotion`. - `available` indica disponibilidade presencial; `available_in_delivery` a disponibilidade no delivery/retirada. - `use_weight` indica se o produto é vendido por peso em vez de unidade.
Retorna as categorias de produtos do restaurante e, dentro de cada categoria, seus respectivos produtos.
Observações
- Produtos/categorias com
deleted_atdiferente denulljá foram deletados. is_exclusiveindica categorias/produtos de uso exclusivo do restaurante, que não aparecem para o cliente final.priceé o preço presencial;price_promotiono preço promocional presencial (se houver).delivery_priceé o preço para delivery/retirada;delivery_price_promotiono promocional para delivery (se houver). Semdelivery_price, usa-seprice/price_promotion.availableindica disponibilidade presencial;available_in_deliverya disponibilidade no delivery/retirada.use_weightindica se o produto é vendido por peso em vez de unidade.
Authorization
bearerAuth Token JWT obtido em POST /public/api/sessions. Envie como
Authorization: Bearer {token}.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/products"[ { "id": 456214, "name": "Burgers", "available": true, "available_in_delivery": false, "is_exclusive": false, "is_ifood": false, "created_at": "2019-08-24T14:15:22Z", "products": [ { "id": 1439633, "name": "X-Tudo", "description": "Delicioso X-Tudo completo", "price": "24.00", "price_promotion": "22.00", "available": false, "available_in_delivery": true, "use_weight": false, "delivery_price": "26.00", "delivery_price_promotion": "string", "available_multistore": true, "ean_codes": "string", "created_at": "2019-08-24T14:15:22Z" } ] }]{ "error": "token_invalid", "message": "Token inválido ou expirado."}Listar métodos de pagamento GET
Retorna todos os métodos de pagamento ativos cadastrados no sistema. Alguns métodos podem não ter `method` e/ou `brand` — principalmente os criados pelo próprio restaurante. Isso é esperado.
Listar clientes do Clube de Fidelidade GET
Retorna, de forma paginada, os clientes do Clube de Fidelidade do restaurante autenticado, com dados relevantes para CRM: cadastro, saldo de cashback, pontos, visitas, produto favorito, histórico de resgates e histórico de mensagens enviadas. **Observações** - Disponível apenas para restaurantes com Clube de Fidelidade configurado. Caso contrário, retorna `400 clube_not_configured`. - Cada cliente pertence somente à loja autenticada — clientes de outras lojas nunca são retornados. - `messages` contém apenas mensagens **enviadas** ao cliente (não há registro de mensagens recebidas). - `cashback`, `total_spent` e `points` podem ser retornados como string numérica. - `cashback_expires_at` é a data em que o cashback do cliente expira; ela é renovada a cada nova compra e pode ser `null` se o cliente ainda não acumulou cashback. - `favorite_product` pode ser `null` quando o cliente ainda não tem compras suficientes.