Cardápio v1
Esta seção descreve o funcionamento de todos dos endpoints relacionados à consulta de cardápio.
O cardápio é consultado de forma completa, sendo divido em grupos, produtos e grupos de opcionais.
Quando um cardápio é alterado no painel Goomer o cliente deve publicar as alterações para que o novo cardápio passe a retornar nas rotas abaixo.
É possível configurar um webhook para receber notificações de alterações de cardápio, que serão enviadas após a publicação das alterações.
Consulta de grupos
Retorna a lista de grupos cadastrados no cardápio. Os objetos da lista são do tipo Group.
/menu/v1/groups
GET https://api-integration.goomer.app/menu/v1/groups
Headers
x-api-key
string
Token de autenticação
[
{
"id": 3395,
"categoryId": 1,
"categoryName": "Entradas",
"name": "Porções",
"availableOnsite": true,
"availableDelivery": true,
"hours": [
{
"from": "Seg",
"to": "Dom",
"open": "13:30",
"close": "17:29"
},
{
"from": "Seg",
"to": "Dom",
"open": "18:00",
"close": "23:59"
}
]
},
{
"id": 3396,
"categoryId": 2,
"categoryName": "Principais",
"name": "Massas",
"availableOnsite": true,
"availableDelivery": true,
"hours": []
},
{
"id": 3399,
"categoryId": 3,
"categoryName": "Bebidas",
"name": "Bebidas",
"availableOnsite": true,
"availableDelivery": true,
"hours": [
{
"from": "Seg",
"to": "Dom",
"open": "21:30",
"close": "01:59"
}
]
}
]Consulta de produtos
Retorna a lista de produtos cadastrados no cardápio. Os objetos da lista são do tipo Product.
/menu/v1/products
GET https://api-integration.goomer.app/menu/v1/products
Headers
x-api-key
string
Token de autenticação
[
{
"id": 21525,
"categoryId": 1,
"categoryName": "Entradas",
"groupId": 3395,
"groupName": "Porções",
"name": "Batata Rústica",
"availableOnsite": true,
"availableDelivery": true,
"prices": [
{
"id": 37033,
"name": "",
"price": 22.5,
"code": 10,
"availableOnsite": true,
"availableDelivery": true
}
],
"hours": [
{
"from": "Qua",
"to": "Dom",
"open": "00:00",
"close": "23:59"
},
{
"from": "Seg",
"to": "Dom",
"open": "00:00",
"close": "21:59"
},
{
"from": "Seg",
"to": "Dom",
"open": "10:00",
"close": "23:59"
}
],
"optionals": []
},
{
"id": 21528,
"categoryId": 2,
"categoryName": "Principais",
"groupId": 3396,
"group": "Massas",
"name": "Spaghetti ao Fungi",
"availableOnsite": true,
"availableDelivery": true,
"prices": [
{
"id": 37036,
"name": "",
"price": 27,
"code": 0,
"availableOnsite": true,
"availableDelivery": true
}
],
"hours": [
{
"from": "Seg",
"to": "Dom",
"open": "06:30",
"close": "17:29"
},
{
"from": "Seg",
"to": "Dom",
"open": "18:00",
"close": "00:29"
}
],
"optionals": []
},
{
"id": 21539,
"categoryId": 3,
"categoryName": "Bebidas",
"groupId": 3399,
"groupName": "Bebidas",
"name": "Coca cola",
"availableOnsite": true,
"availableDelivery": true,
"prices": [
{
"id": 37047,
"name": "",
"price": 5.5,
"code": 0,
"availableOnsite": true,
"availableDelivery": true
}
],
"hours": [],
"optionalGroups": [
27120,
27121,
27122
]
}
]Consulta de opcionais
Retorna a lista de grupos de opcionais com suas respectivas opções cadastradas no cardápio. Os objetos da lista são do tipo OptionalGroup.
/menu/v1/optionals
GET https://api-integration.goomer.app/menu/v1/optionals
Headers
x-api-key
string
Token de autenticação
[
{
"id": 27121,
"name": null,
"min": 0,
"max": 1,
"repeat": false,
"availableOnsite": true,
"availableDelivery": true,
"options": [
{
"id": 54886,
"name": "Com gelo",
"price": 0,
"code": null,
"availableOnsite": true,
"availableDelivery": true
}
]
},
{
"id": 27122,
"name": "Copo?",
"min": 0,
"max": 1,
"repeat": false,
"availableOnsite": true,
"availableDelivery": true,
"options": [
{
"id": 54887,
"name": "1 copo",
"price": 0,
"code": null,
"availableOnsite": true,
"availableDelivery": true
},
{
"id": 54888,
"name": "2 copos",
"price": 0,
"code": null,
"availableOnsite": true,
"availableDelivery": true
},
{
"id": 54889,
"name": "3 copos",
"price": 0,
"code": null,
"availableOnsite": true,
"availableDelivery": true
},
{
"id": 54890,
"name": "4 copos",
"price": 0,
"code": null,
"availableOnsite": true,
"availableDelivery": true
}
]
},
{
"id": 27773,
"name": null,
"min": 0,
"max": 1,
"repeat": true,
"availableOnsite": true,
"availableDelivery": true,
"options": [
{
"id": 55889,
"name": "queijo extra",
"price": 1,
"code": "1001",
"availableOnsite": true,
"availableDelivery": true
}
]
}
]Modelos
Group
Campo
Tipo
Descrição
id
int
id único global do grupo
categoryId
int
id único global da categoria
categoryName
string
Nome da categoria
name
string
Nome do grupo
availableDelivery
boolean
Indica se o grupo deve aparecer no cardápio de delivery
availableOnsite
boolean
Indica se o grupo deve aparecer no cardápio dentro da loja
Product
Campo
Tipo
Descrição
id
int
id único global do produto
categoryId
int
id único global da categoria
categoryName
string
Nome da categoria
groupId
int
id único global do grupo
groupName
string
Nome do grupo
name
string
Nome do produto
availableDelivery
boolean
Indica se o produto deve aparecer no cardápio de delivery
availableOnsite
boolean
Indica se o produto deve aparecer no cardápio dentro da loja
Price
Campo
Tipo
Descrição
id
int
id único global do preço
name
string
Nome do preço (Será vazio para produtos de preço único)
price
float
Preço de venda
code
string
Código do produto/preço (para lançamento no PDV)
availableDelivery
boolean
Indica se o preço deve aparecer no cardápio de delivery
availableOnsite
boolean
Indica se o preço deve aparecer no cardápio dentro da loja
OptionalGroup
Campo
Tipo
Descrição
id
int
id único global do grupo de opcionais
name
string
Nome do grupo de opcionais
min
int
Quantidade mínima de opcionais para seleção
max
int
Quantidade máxima de opcionais para seleção
repeat
boolean
Indica se o cliente pode escolher a mesma opção mais de uma vez dentro deste grupo (Quantidade > 1)
availableDelivery
boolean
Indica se o grupo de opcionais deve aparecer no cardápio de delivery
availableOnsite
boolean
Indica se o grupo de opcionais deve aparecer no cardápio dentro da loja
Optional
Campo
Tipo
Descrição
id
int
id único global do opcional
name
string
Nome do opcional
price
float
Preço de venda
code
string
Código do opcional (para lançamento no PDV)
availableDelivery
boolean
Indica se o opcional deve aparecer no cardápio de delivery
availableOnsite
boolean
Indica se o opcional deve aparecer no cardápio dentro da loja
Hour
Campo
Tipo
Descrição
id
int
id único global do horário
open
string
Hora de início no formato HH:mm (intervalo fechado)
close
string
Hora de término no formato HH:mm (intervalo fechado)
Os horários possuem casos específicos que merecem atenção especial:
Se
from == to:O horário só é ativo neste dia da semana em específico.
Se
open > close:O horário de operação passa da meia-noite, e deve se estender até o horário indicado por
closedo dia seguinte.Ex.: from: Sab, to: Sab, open: 19:00, close: 00:59 Isso significa que este horário estará ativo apenas aos sábados, abrindo às 19:00 e fechando às 01:00 do Domingo.
Os intervalos de horários são do tipo fechado, ou seja, se o horário indicado em
opené 19:00, às 19h o seu objeto associado deve estar ativo. Se o horário indicado emcloseé 00:59, o objeto associado deve se tornar inativo às 01:00.
Tabelas
Dias da semana
Tabela de referência para dias da semana utilizado nos horários. O primeiro dia da semana é Segunda-feira.
Valor
Descrição
Seg
Segunda-feira
Ter
Terça-feira
Qua
Quarta-feira
Qui
Quinta-feira
Sex
Sexta-feira
Sab
Sábado
Dom
Domingo
Last updated
Was this helpful?