Documentacao WEBService REST Ecletica E GarcomPro Mesa Comanda Balcao 3.2.0

Documentação API (Local & Online DMWS) Mesa -
Comanda - Balcão
Versão: 3.2.0 (atualizado em 23/01/2024)
Os serviços são desenvolvidos em REST em formato JSON (Javascript Object Notation). Os verbos
HTTP utilizados nestes serviços são POST e GET. O timeout para cada requisição é de no máximo
60 segundos.
Receberá inclusive um token hexadecimal de 40 caracteres para autenticação em todos os serviços o

qual deverá ser enviado no header (cabeçalho) das requisições na variável loginToken.
• Autenticação ----------------------------------------------------------------------------- pg: 2

• Verificações Iniciais -------------------------------------------------------------------- pg: 3 ~ 4
• Lista Detalhe Bandeiras ---------------------------------------------------------------- pg: 5 ~ 6
• Lista Grupos ----------------------------------------------------------------------------- pg: 7 ~ 9
• Lista Produtos --------------------------------------------------------------------------- pg: 10 ~ 12
• Lista Combos ---------------------------------------------------------------------------- pg: 13 ~ 15
• Lista Pizzas ------------------------------------------------------------------------------ pg: 16 ~ 18
• Lista Promoções ------------------------------------------------------------------------ pg: 19 ~ 20
• Lista Produtos Faltantes --------------------------------------------------------------- pg: 21
• Lista Produtos Vinculados ------------------------------------------------------------ pg: 22 ~ 23
• Lista Operadores ----------------------------------------------------------------------- pg: 24 ~ 25
• Consulta Itens da Mesa/Comanda --------------------------------------------------- pg: 26 ~ 27
• Inserir Itens na Mesa/Comanda ------------------------------------------------------ pg: 28 ~ 32
• Pré Fechamento da Mesa/Comanda –------------------------------------------------ pg: 33 ~ 35
• Chamar Garçom –----------------------------------------------------------------------- pg: 36
• Consultar a Conta da Mesa/Comanda ----------------------------------------------- pg: 37 ~ 38
• Fechar a Conta da Mesa/Comanda --------------------------------------------------- pg: 39 ~ 44
• Mapa de Mesas ------------------------------------------------------------------------- pg: 45
• Mapa de Comandas -------------------------------------------------------------------- pg: 46
• Venda Balcão/Comanda ————————————————————— pg: 47 ~ 54
• Tabela de respostas –------------------------------------------------------------------- pg: 55
1
Autenticação
Existem dois modelos de se conectar à API Eclética, de forma local(HTTP) e online(HTTPS).
Cada modelo tem seu próprio endpoint com seus devidos parâmetros específicos. O header
loginToken para autenticação difere para cada modo de conexão e será enviado pela Eclética
para o integrador.
API Local:
Endpoint: http://IP_API:PORTA/ecletica_ws/services/?metodo={nome_metodo}
Parâmetros obrigatórios API Local:
IP_API: Esta sigla deve ser substituída pelo número IP da máquina onde a API está instalada.
PORTA: Geralmente utilizamos a porta 8080 para as requisições, se por necessidade específica a
porta da API estiver em outro range, o ideal é entrar em contato com nosso suporte.
loginToken: Token enviado no header da requisição para autenticação no WebService (fornecido

pela Eclética Informática).
metodo: Em cada método terá o nome que deve ser enviado em nome_metodo
Obs: dependendo do método, outros parâmetros devem ser fornecidos
API Online (DMWS):

Endpoint (Homologação) https://www.pedidoviaweb.com.br/teste/ws/dmws/index.php?
metodo={nome_metodo}&rede={numero_rede}&loja={numero_loja}
Endpoint (Produção) https://www.pedidoviaweb.com.br/ws/dmws/index.php?metodo={nome_me-

todo}&rede={numero_rede}&loja={numero_loja}
Parâmetros obrigatórios API Online:
rede: Número da Rede do estabelecimento (fornecido pela Eclética)
loja: Número da Loja do estabelecimento (fornecido pela Eclética)
loginToken: Token enviado no header da requisição para autenticação no WebService (fornecido

pela Eclética Informática).
metodo: Em cada método terá o nome que deve ser enviado em nome_metodo
Obs: dependendo do método, outros parâmetros devem ser fornecidos
2
Verificações Iniciais (GET)
Retorna dados em geral como versão da API, dados do próprio dispositivo e configurações da
loja como número de mesas, comandas, e etc...
metodo: verificacoesIniciais
Formato da Resposta da requisição (verificações Iniciais)
O retorno será em JSON contendo até 3 elementos:

cod: código da resposta.
msg: mensagem referente a resposta.
dados_adicionais: uma lista com dados adicionais, quando aplicável.
Exemplo de sucesso de verificacoesIniciais:
{
"cod": "000",
"msg": "Operação efetuada com sucesso",
"dados_adicionais": {
"versao_api": "1.1.2",
"numero_pocket": "1",
"ip": "192.168.0.6",
"usa_multisabor": "S",
"operacao_multisabor": "V",
"comandas_min": "1",
"comandas_max": "50",
"mesas": "50",
}
}
3
Explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais do método
verificacoesIniciais:
Campo Tipo Descrição

versao_api String Número da versão da API da Eclética
numero_pocket String Número do pocket que o sistema da Eclética atribuiu
ao dispositivo (sempre será 1)
ip String Número IP do dispositivo que acessou a API
usa_multisabor String Multisabor normalmente é utilizado em Pizzarias

para o lançamento de pizzas meio a meio. Flag com
valor “S” quando a loja trabalha com multisabor ou
“N” quando não trabalha
operacao_multisabor String Flag com valor “V” para cobrar o valor médio do
produto ou “M” para cobrar o maior valor.
comandas_min String Número mínimo de comandas que o estabelecimento
disponibiliza.
comandas_max String Número máximo de comandas que o estabelecimento
disponibiliza.
mesas String Número de mesas que o estabelecimento possui.
Obs: dados como numero_pocket e ip são importantes serem armazenados em sua app para envio
posterior de alguns métodos específicos. É importante que este método seja realizado primeiro, pois
a partir dos dados de resposta, esses outros métodos recebem seus parâmetros.
4
Lista Detalhe Bandeiras (GET)
Exibe a listagem dos detalhes de bandeira(formas de pagamento) cadastrados na loja.
metodo: listaDetalheBandeiras
Formato da Resposta da requisi o (Lista Detalhe Bandeiras)

O retorno ser em JSON contendo at 3 elementos:
cod: c digo da resposta.
dados_adicionais: uma lista com dados adicionais, com os subarrays pertinentes aos dados dos de-
talhes de bandeira.
{
"cod": "000",
"bandeiras": [{
"tipo_det": "C",
"cod_det": "1",
"descr_det": "VISA",
"c_magnus": "1"
}, {
"tipo_det": "T",
"cod_det": "1",
"descr_det": "Ticket Refeição",
"c_magnus": "3"
}, {
"tipo_det": "O",
"cod_det": "1",
"descr_det": "Conta assinada",
"c_magnus": "0"
}]
}
}
5
ó
á
é
ç
ã
Segue explica o da estrutura de cada par metro de resposta do n dados_adicionais-
>bandeiras do m todo listaDetalheBandeiras:
Campo Tipo Descri o

String(
tipo_det Tipo de bandeira. Pode ser “C” de cart o, “T” de ticket ou “O” de outras.
1)
ID da bandeira. Pode repetir, caso o campo “tipo_det” n o repita ao mesmo
cod_det Integer
tempo.
descr_de
String Nome da bandeira de pagamento. Ex: Mastercard
t
C digo identificador da transa o (para m quinas POS fazerem a chamada
correspondente ao gateway). Segue tabela:
codigo '0': 'credito';

c_magn
Integer c digo '1': 'debito';
us
c digo '2': 'visa alimentacao'; (sodexo - vale alimenta o) c digo '3': 'vale
refeicao';
Para tipo_det “O” de outras, c_magnus ser sempre 0 (zero).
6
ó
ó
ó
ç
ã
ç
ã
é
ç
ã
ã
á
á
â
ç
ã
ã
ó
ó
Lista Grupos (GET)
Exibe a listagem de grupos (categorias) dos produtos da loja.
metodo: listaGrupos
Parâmetros adicionais da requisição:
num_pocket: Número do pocket retornado pelo método verificacoesIniciais.
Ex endpoint: ?metodo=listaGrupos&num_pocket=X…
Formato da Resposta da requisição (Lista Grupos)

Exemplo de sucesso de listaGrupos:
{
"cod": "000",
"colecao": {
"grupos": [{
"cod_grupo": "4",
"descr_grupo": "Entradas",
"cor_grupo": "#ffff80",
"cor_fonte": "#000000",
"porc_desc": "0.00",
"valor_f": "0.00",
"valor_i": "0.00",
"descr_eua": "",
"descr_esp": "",
"descr_bra": "",
"imagem": ""
}, {
"cod_grupo": "5",
"descr_grupo": "Lanches",
"cor_grupo": "#ff0000",
"cor_fonte": "#ffffff",
"porc_desc": "0.00",
"valor_f": "0.00",
"valor_i": "0.00",
"descr_eua": "",
7
"descr_esp": "",
"descr_bra": "",
"imagem": ""
}, {
"cod_grupo": "8",
"descr_grupo": "Pizzas",
"cor_grupo": "#ff8000",
"cor_fonte": "#000000",
"descr_eua": "",
"descr_esp": "",
"descr_bra": "",
"imagem": ""
}, {
"cod_grupo": "9",
"descr_grupo": "Pizzas Doces",
"cor_grupo": "#0000ff",
"cor_fonte": "#ffffff",
"descr_eua": "",
"descr_esp": "",
"descr_bra": "",
"imagem": ""
}, {
"cod_grupo": "2",
"descr_grupo": "Refrigerantes",
"cor_grupo": "#80ff00",
"cor_fonte": "#000000",
"descr_eua": "refri",
"descr_esp": "refri",
"descr_bra": "refri",
"imagem": ""
}],
"subgrupos": [{
"cod_sub_grupo": "1",
"cod_grupo": "8",
"descricao": "Pizzas Grande Salgada"
}, {
"cod_sub_grupo": "1",
"cod_grupo": "9",
"descricao": "Pizzas Grande Doce"
}]
}
}
}
8
Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais-
>colecao (grupos e subgrupos) do método listaGrupos:
grupos:

cod_grupo String ID do código do grupo no sistema da Eclética.
descr_grupo String Descrição do grupo cadastrado.
cor_grupo String Hexadecimal da cor do fundo do grupo.
cor_fonte String Hexadecimal da cor da fonte do grupo.
descr_eua String Descrição do grupo em inglês (opcional).
descr_esp String Descrição do grupo em espanhol (opcional).
descr_bra String Descrição do grupo em português (opcional).
imagem String Imagem do grupo em formato base64 (opcional).
Alguns campos extras podem aparecer no JSON de resposta, porém não são utilizados nos métodos
de inserção de itens na mesa/comanda.
subgrupos:

cod_sub_grupo String ID do código do subgrupo no sistema da Eclética.
cod_grupo String ID do grupo ao qual este subgrupo pertence.
descricao String Descrição do nome do subgrupo cadastrado.
9
Lista Produtos (GET)
Exibe a listagem de produtos da loja.
metodo: listaProdutos
Formato da Resposta da requisição (Lista Produtos)

Exemplo de sucesso de listaProdutos:

{
"cod": "000",
"produtos": [{
"cod_item": "1",
"cod_grupo": "1",
"descr_grupo": "Bebidas Alcóolicas",
"cor_produto": "#ffffff",
"cor_fonte": "#000000",
"descr_item": "Stela Artois",
"resumo_web": "",
"vlr_unit": "10.00",
"combo": "N",
"multi_sabores": "N",
"adicional_delivery": "2.00",
"status_item": "N",
"cod_unid": "2",
"impressao1": "0",
"impressao2": "0",
"cod_sub_grupo": null,
"nome_sub_grupo": null,
“ordem_touch” : 1.00000,
“produto_pizza” : 'N',
“cod_grupo_web”: “0",
“descricao_web” : “Stela Artois",
“info_extra_web”: “”,
“qtde_calorica”: “0”,
“info_nutricional”: “”,
"service_open_delivery”: “DELIVERY, TAKEOUT, INDOOR”,
“url_imagem_od”: ""
}, {
"cod_item": "2",
"cod_grupo": "2",
"descr_grupo": "Refrigerantes",
"cor_produto": "#ffffff",
"cor_fonte": "#000000",
"descr_item": "Fruit Dolly",
"resumo_web": "",
"vlr_unit": "9.00",
"combo": "N",
"multi_sabores": "S",
"status_item": "N",
"cod_unid": "2",
"impressao1": "0",
10
"impressao2": "0",
"cod_sub_grupo": null,
"nome_sub_grupo": null,
“ordem_touch” : 2.00000,
“produto_pizza” : ’N',
“cod_grupo_web”: “0",
“descricao_web” : “Stela Artois",
“info_extra_web”: “”,
“qtde_calorica”: “0”,
“info_nutricional”: “”,
"service_open_delivery”: “DELIVERY, TAKEOUT, INDOOR”,
“url_imagem_od”: “”
}]
}
}

>produtos do método listaProdutos:

cod_item String ID do código do produto no sistema da Eclética.
cod_grupo String ID do código do grupo ao qual o produto pertence.
descr_grupo String Descrição do grupo ao qual o produto pertence.
cor_produto String Hexadecimal da cor do fundo do produto.
cor_fonte String Hexadecimal da cor da fonte do produto.
descr_item String Descrição do produto.
resumo_web String Resumo das características do produto (opcional).
vlr_unit String Valor unitário do produto.
combo String Flag que declara se o produto é o item inicial de um
combo. “S” caso seja, “N” caso não seja.
multi_sabores String Flag com valor “S” quando o produto deve ser
vendido como multisabor ou “N” quando não pode.
status_item String Status de exibição do produto. Pode ser “N” para
“Normal”, “S” para escondido ou “V” para
vinculado.
“N” signi ca que o produto pode ser vendido de
qualquer maneira. “S” signi ca que o produto não
pode ser vendido de qualquer maneira. “V” signi ca
que o produto só pode ser vendido dentro de um
Combo ou como um vínculo.
11
fi
fi
fi
cod_unid String Código da unidade física que é utilizada para vender
o produto, os códigos padrões são: “0” quilo, “1”
litro, “2” unidade.
impressao1 String Número da impressora que imprime a primeira via
da compra.
impressao2 String Número da impressora que imprime a segunda via da
compra.
cod_sub_grupo String ID do código do subgrupo ao qual o produto
pertence.
nome_sub_grupo String Nome do subgrupo ao qual o produto pertence.
ordem_touch Double(1,5) Número usado para ordenação dos produtos na lista
de exibição.
produto_pizza String Flag que demarca se o produto é o item principal da
pizza. Ex: Pizza Grande 2 Sabores. “S” caso seja,
“N” caso não seja.
cod_grupo_web Integer ID do código do grupo web ao qual pertence este
produto.
descricao_web String Descrição alternativa do produto na web.
info_extra_web String Informação extra alternativa do produto.
qtde_calorica String Quantidade em calorias do produto.
info_nutricional String Informação nutricional do produto.
service_open_delivery String Exibe os tipos de serviços que este produto se
enquadra na loja: Ex: DELIVERY, TAKEOUT,
INDOOR
url_imagem_od String URL da imagem do produto hospedada no servidor
12
Lista Combos (GET)
Exibe a listagem de combos da loja.
metodo: listaCombos
Formato da Resposta da requisição (Lista Combos)

{
"cod": "000",
"combos": [{
"cod_prod_princ": "3",
"cod_prod_vinc": "7",
"qtde_obrig": "2.00",
"cor_combo": "#ffffff",
"cor_fonte": "#000000",
"descr_item": "Queijo Mussarela de Bufalo Albino",
"vlr_unit_prod": "0.40",
"observacao": "0",
"preco_diferenciado": "S",
"vlr_unit_combo": "12.00",
"combo_princ": "0",
"qtde_max": "N",
"nome_nivel": "Selecione um queijo",
"impressao1": "0",
"impressao2": "0"
}, {
"cod_prod_princ": "3",
"cod_prod_vinc": "6",
"qtde_obrig": "2.00",
"cor_combo": "#ffffff",
"cor_fonte": "#000000",
"descr_item": "Queijo Prato",
"vlr_unit_prod": "0.50",
"observacao": "0",
"preco_diferenciado": "N",
"vlr_unit_combo": "0.00",
"combo_princ": "0",
"qtde_max": "N",
"nome_nivel": "Selecione um queijo",
"impressao1": "0",
"impressao2": "0"
}]
}
}
13
>combos do método listaCombos:

cod_prod_princ String Código do produto principal do combo.
cod_prod_vinc String Código do produto vinculado ao principal. Este
produto será chamado caso o cod_prod_princ seja
adicionado ao carrinho.
qtde_max String Flag que determina se no “nível” do combo em que
este produto se encontra possui uma quantidade
(máxima ou obrigatória) de
itens que podem ser escolhidos. Os valores podem
ser “S” ou “N”. “S” para determinar uma quantidade
máxima. “N” para quantidade obrigatória.
cor_combo String Hexadecimal da cor do fundo do combo.
cor_fonte String Hexadecimal da cor da fonte do combo.
descr_item String Descrição do combo.
preco_diferenciado String Flag que determina se este produto dentro do combo
possui um preço diferente de quando é vendido
diretamente. Os valores
podem ser ‘S’ ou ‘N’. Quando for 'S' utilize o
vlr_unit_combo, sendo 'N', use o vlr_unit_prod que é
o preço da tabela de produtos.
vlr_unit_prod String Valor do produto na tabela de produtos.
vlr_unit_combo String Valor do produto na tabela de combos.
combo_princ String Código do combo para de nir a regra ao qual o
produto principal pertence. Se o código for igual a 0
signi ca que sempre que o produto principal for
adicionado dentro de um combo( independente de
qual combo for) ele chamará o produto vinculado
cadastrado. Caso o código seja diferente de 0
signi ca que esta regra só funcionará dentro deste
combo com este respectivo código.
qtde_obrig String Determina a quantidade( m xima ou obrigat ria ) de

itens que poder o ser adicionados nessa etapa do
combo. Caso o valor seja “0” significa que n o
possui limite de itens que podem ser adicionados
nessa etapa.
14
fi
fi
ã
fi
á
ó
ã
nome_nivel String Nome do nível do combo Ex: “Selecione o ponto da
carne”
impressao1 String Número da impressora que imprime a primeira via
da compra.
Impressao2 String Número da impressora que imprime a segunda via da
compra.
15
Lista Pizzas (GET)
Exibe a listagem das configurações, opcionais e sabores dos produtos pizza da loja.
metodo: listaPizzas
Formato da Resposta da requisição (Lista Pizzas)

dados_adicionais: uma lista com dados adicionais, com os subarrays pertinentes aos dados
produtos pizza.
{
"cod": "000",
"pizzas": {
"con guracao_pizzas": [{
"cod_item_pizza": "20",
"num_sabores": "2",
"usa_preco_principal": "N"
},{
"num_sabores": "3",
"usa_preco_principal": "S"
}],
"sabores_pizzas": [{
"cod_item": "11",
"tipo": "S"
}, {
"cod_item": "12",
"tipo": "S"
}, {
"cod_item": "13",
"tipo": "S"
}, {
"cod_item": "14",
"tipo": "S"
}, {
"cod_item": "21",
"tipo": "M"
}, {
"cod_item": "22",
"tipo": "M"
16
fi
}, {
"cod_item": "23",
"tipo": "M"
}, {
"cod_item": "24",
"tipo": "B"
}, {
"cod_item": "25",
"tipo": "B"
}],
"opcionais_pizzas": [{
"cod_item_sabor": "25",
"cod_item": "26",
"preco_diferenciado": "N"
}, {
"cod_item_sabor": "25",
"cod_item": "27",
}]
}
}
}
Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais->pizzas-

>configuracao_pizzas do método listaPizzas:

cod_item_pizza Integer(9) Código do produto pizza principal.
num_sabores Integer(1) Quantidade de sabores da pizza.
usa_preco_principal String(1) Flag que determina se o valor de todos os itens da
pizza(sabores, opcionais, massas e bordas) será
informado apenas no produto principal zerando os
demais do carrinho.
Explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais->pizzas-

>sabores_pizzas do método listaPizzas:

cod_item_pizza Integer(9) Código do produto pizza principal.
17
cod_item Integer(9) Código do produto referente ao sabor da pizza.
tipo String(1) Flag que determina o tipo do produto. “S” para
sabor, “M” para massa e “B” para borda. Quando um
produto principal de pizza é selecionado, exibem-se
os sabores(S) e ao selecionar determinado sabor
também é exibido os opcionais deste se houverem.
Ao m da seleção da quantidade de sabores exibem-
se as massas(M) – se houverem – e por m as
bordas(B) – se houverem-.
Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais->pizzas-

>opcionais_pizzas do método listaPizzas:

cod_item_pizza Integer(9) Código do sabor da pizza que referencia os
opcionais.
cod_item Integer(9) Código do opcional.
preco_diferenciado String(1) Flag que determina se o opcional é vendido com
preço diferenciado. “S” para sim e “N” para não.
18
fi
fi
Lista Promoções (GET)
Exibe a listagem das promoções cadastradas na loja.
metodo: listaPromocoes
Formato da Resposta da requisição (Lista Promoções)

{
"cod": "000",
"promocoes": [{
"prioridade": "4",
"cod_item": "2",
"perc_desc": "10.00000",
"data_ini_desc": "2001-10-01 00:00:00",
"data_fim_desc": "2032-10-30 23:00:00",
"dias_semana": "1, 2, 3, 4, 5, 6, 7"
}, {
"prioridade": "3",
"cod_item": "5",
"perc_desc": "50.00000",
"data_ini_desc": "2010-10-01 00:00:00",
"data_fim_desc": "2022-10-30 22:00:00",
"dias_semana": "1, 2, 3, 4, 5, 6, 7"
}, {
"prioridade": "4",
"cod_item": "5",
"perc_desc": "20.00000",
"data_ini_desc": "2001-10-01 00:00:00",
"data_fim_desc": "2002-10-30 08:00:00",
"dias_semana": "1, 2, 3, 4, 5, 6, 7"
}]
}
}
19
>promocoes do método listaPromocoes:

prioridade String Prioridade das promoções. Utilizado para de nir
qual promoção será aplicada caso uma promoção
con ite com outra. O valor será
entre 1 e 10 onde a prioridade mais alta é 1 e a mais
baixa é 10.
cod_item String Código do produto.
perc_desc String Percentual de desconto do produto em promoção.
data_ini_desc String Data/Hora do início da promoção.
data_fim_desc String Data/Hora do fim da promoção.
dias_semana String Dias da semana onde a promoção funciona. Onde
1=domingo … 7=sábado
20
fl
fi
Lista Produtos Faltantes (GET)
Exibe a listagem dos produtos faltantes cadastrados na loja.
metodo: listaProdutosFaltantes
Formato da Resposta da requisição (Lista Produtos Faltantes)

{
"cod": "000",
"produtos_faltantes": [{
"cod_item": "2",
"descricao": "Fruit Dolly"
},{
"cod_item": "3",
"descricao": "Pepsi Twist 2L"
}]
}
}

>produtos_faltantes do método listaProdutosFaltantes:
grupos:

cod_item String ID do produto que está marcado como faltante.
descricao String Nome do produto marcado como faltante.
21
Lista Produtos Vinculados (GET)
Exibe a listagem dos produtos vinculados cadastrados na loja.
metodo: listaProdutosVinculados
Formato da Resposta da requisição (Lista Produtos Vinculados)

{
"cod": "000",
"produtos_vinculados": [{
"cod_item": "4",
"cod_item_vinc": "10",
"vlr_unit": "0.00",
}, {
"cod_item": "4",
"cod_item_vinc": "5",
"vlr_unit": "0.00",
}]
}
}
22
>produtos_vinculados do método listaProdutosVinculados:

cod_item String ID do produto que chamará uma cadeia de produtos
a serem vinculados.
cod_item_vinc String ID do produto que está vinculado ao ID principal
(cod_item).
vlr_unit String Ainda não utilizado.
preco_diferenciado String Ainda não utilizado.
Imagine que no exemplo acima o cod_item 4 é uma Coca-cola. No momento que o cliente
selecionar esta Coca, como este item possui 2 vinculos, o cod_item_vinc=10 seria “Gelo” e o
cod_item_vinc=5 seria o “Limão”. O vínculo funciona como uma forma de pedir, opcionalmente,
algum item a mais no seu pedido.
23
Lista Operadores (GET)
Exibe a listagem dos operadores cadastrados na loja.
metodo: listaOperadores
operacao: contém o valor fixo literal de “mesa” (operacao=mesa).
Ex endpoint: ?metodo=listaOperadores&operacao=mesa…
Formato da Resposta da requisição (Lista Operadores)

{
"cod": "000",
"operadores": [{
"cod_fun": "2",
"nome_login": "JOSÉ",
"senha": "123",
"permite_cancelar": "S",
"permite_desconto": "N",
"permite_consulta": "S",
"permite_prefechamento": "S",
"permite_venda": "S",
"permite_transferencia": "S",
"permite_fecharconta": "N"
}, {
"cod_fun": "3",
"nome_login": "MARIA",
"senha": "1234",
"permite_cancelar": "S",
"permite_desconto": "N",
"permite_consulta": "S",
"permite_prefechamento": "S",
"permite_venda": "S",
"permite_transferencia": "S",
"permite_fecharconta": "N"
}]
}
}
24
>operadores do método listaOperadores:

cod_fun String ID do funcionário cadastrado dentro do sistema.
nome_login String Nome do login do funcionário.
senha String Senha do cadastro do funcionário.
permite_cancelar String “S” para permitir o cancelamento de pedidos e “N”
para não permitir.
permite_desconto String “S” para permitir dar desconto em pedidos e “N”
para não permitir.
permite_consulta String “S” para permitir a consulta de pedidos e “N” para
não permitir.
permite_prefechament String “S” para permitir que o funcionário execute pré
o fechamento de pedidos e “N” para não permitir.
permite_venda String “S” para permitir que o funcionário efetue vendas na
plataforma e “N” para não permitir.
permite_transferencia String “S” para permitir a transferência de itens de uma
mesa para outra e “N” para não permitir.
permite_fecharconta String “S” para permitir que o funcionário utilize o método
de fechar conta e “N” para não permitir.
25
Consulta Itens da Mesa/Comanda (GET)
Exibe a listagem dos produtos adicionados à determinada mesa/comanda.
metodo: consultaItens
operacao: contém o valor fixo literal de “mesa” ou "comanda" (operacao=mesa/comanda).
mesa_comanda: número da mesa/comanda que está sendo consultada.
Ex endpoint: ?metodo=consultaItens&operacao={mesa/comanda}&mesa_comanda=X…
Formato da Resposta da requisição (Consulta Itens Mesa/Comanda)

{
"cod": "000",
"itens": [{
"cod_reg": "34",
"cod_item": "90",
"descr_item": "COMBO 1",
"vlr_unit": "10.00",
"qtde": "0.500",
"vlr_total": "5.00000",
"posicao": "0",
"transf": "0.00",
"multi_sabor": "N"
}, {
"cod_reg": "34",
"cod_item": "700",
"descr_item": "COMBO PIZZA E REFRIGERANTE",
"vlr_unit": "10.00",
"qtde": "0.500",
"vlr_total": "5.00000",
"posicao": "0",
"transf": "0.00",
"multi_sabor": "N"
}]
}
}
26
Segue explicação da estrutura de cada parâmetro do array de resposta do nó
dados_adicionais->itens do método consultaItens:

cod_reg String Código de agrupamento dos itens. Cada item terá um
código de agrupamento independente, exceto, os
itens de um multisabor ou pertencentes a um combo.
O valor será “-1” para itens que estiverem
cancelados, ca a critério do integrador exibir estes
itens cancelados ou não.
cod_item String Código do item
descr_item String Descrição do item
vlr_unit String Valor unitário do item
qtde String Quantidade adicionada do item
vlr_total String Valor total do item (vlr_unit * qtde)
posicao String Posição do item na mesa ou número da mesa em
caso de Comanda.
transf String Indica se o item veio transferido de uma outra mesa/
comanda.
multi_sabor String Indica se o item é multisabor “S” ou não “N”. Mais
para fins de exibição.
27
fi
Inserir Itens na Mesa/Comanda (POST)
Envia a inclusão de itens para determinada mesa/comanda para o sistema (Ainda não é o
fechamento).
metodo: efetuaVenda
JSON: é um objeto que será enviado no body via POST na chamada do WebService.
Exemplo da estrutura de JSON:

[{
"JSON": {
"metodo": "inserirPedidoJSON",
"numero": "61",
"tipo_operacao": "comanda",
"modulo": "NOME_INTEGRADOR",
"versao_atual": "2.3.0",
"pagar_agora": "N",
"usa_pinpad": "N",
"id_transacao": "30201886162454775",
"dadosDispositivo": {
"ip_dispositivo": "192.168.0.6",
"sistema_operacional": "android",
"modelo_pinpad": "",
"operadora_pinpad": ""
},
"dadosOperador": {
"nome_operador": "JOSÉ",
"codigo_operador": "2"
},
"inserirPedidoJSON": {
"Itens": [{
"ordem": 1,
"cod_item": "18",
"descr_item": "Heineken Long Neck",
"descr_item_impresso": "Heineken Long Neck",
"quantidade": 6,
"vlr_unit": "10.00",
"posicao": 0,
28
"observacao": "",
"multisabor": "S",
"impressao1": "2",
"impressao2": "3",
"brinde": "N",
"cod_reg": 1,
"combo": "N",
"promocao": "N",
"status": "N",
"faltante": "N",
"valor_total": "60.00"
}],
"CpfnaNota": [],
"FormaDePagamento": [],
"Pagamento": {
"valor_total": 0,
"dinheiro": 0,
"cheque": 0,
"cartao": 0,
"ticket": 0,
"outros": 0,
"servico": 0,
"desconto": 0,
"vale_ref": 0,
"contra_vale_emi": 0,
"contra_vale_rec": 0,
"troco": 0,
"numero_de_pessoas": 1,
"nome_cliente": "",
"telefone_cliente": "",
"repique": 0,
"pendura": 0,
"cpf": ""
},
"Checkin": "",
"ComprovantePagamento": []
}
}
}]
Segue explicação da estrutura de cada parâmetro de JSON:
29
Campo Exemplo de Descrição
Conteúdo
metodo inserirPedidoJSON Nome do método que está sendo consumido
numero 1,2,3,... Número da mesa/comanda
tipo_operacao “mesa” Tipo de operação que está sendo realizada. Será
“mesa” ou “comanda”
modulo Nome do programa/empresa que está consumindo a
“NOME_INTEGRADOR” API
numero_pocket 1 Número individual do dispositivo. Usado para

identificar o lançador. Sempre enviar 1.
versao_atual 1.2.5 , 2.5.4, ... Versão do sistema integrador.
pagar_agora “S” ou “N” Mandar sempre “N”
usa_pinpad “S” ou “N” Mandar sempre “N”
id_transacao 302018725121559361 Número único da transação. Recomendamos
concatenar:
número_interno+ano+mês+dia+hora+minuto+segund
o+milésimos
Não poderá haver, em hipótese alguma, 2 transações
com o mesmo ID.
dadosDispositiv -
o
ip_dispositivo 192.168.0.1 IP do dispositivo que está efetuando o lançamento
sistema_operacio android Sistema operacional do dispositivo
nal
modelo_pinpad Mandar sempre vazio.
operadora_pinpa Mandar sempre vazio.
d
dadosOperador
nome_operador José Nome do operador logado.
codigo_operador 2 Código interno da Eclética do operador logado.
inserirPedidoJS -
ON
Itens
ordem 1,2,3,... Ordem que os itens foram lançados. Começa com 1,
sendo acrescido +1 a cada novo item.
30
cod_reg 1,2,3,... Código de agrupamento. Cada item terá um código de
agrupamento específico, exceto produtos multisabor
ou dentro de um combo. Ex: para uma pizza meia
calabresa, meia mussarela deve ser enviados dois
registros com “ordem” diferente, mas cod_reg iguais.
O mesmo exemplo se aplica para itens pertencentes
ao mesmo combo.
cod_item 1,2,3,... Código interno da eclética
descr_item Suco de Laranja Nome do produto na base da eclética
descr_item_impr Suco de Laranja Nome do produto na base da eclética.
esso
quantidade 1,2,3,... Quantidade do produto
vlr_unit 8.50 Valor unitário do produto
valor_total 17.00 Valor unitário multiplicado pela quantidade
posicao 2 Posição do item na mesa ou o número da mesa em
caso de comanda. Caso não exista, enviar valor ‘0’
observacao Com gelo Observação variável do item
multisabor “S” ou “N” “S” caso seja uma pizza multisabor (meia de um
sabor, meia de outro)
Impressao1 1,2,3 Código interno da eclética. Informa em qual
impressora que o produto será impresso na impressora
1
impressora que o produto será impresso na impressora
2
brinde “S” ou “N” Mandar sempre “N”.
combo “S” ou “N” “S” caso o produto faça parte de um combo. Ex:
hambúrguer + batata + bebida
promocao “S” ou “N” “S” caso o produto esteja sendo enviado com algum
desconto
status “S”, “N”, “V” “N” normal para venda. “S” não deve ser vendido.
“V” produto vinculado a um outro conforme o
cadastro do produto.
faltante “S” ou “N” “S” caso o produto esteja como faltante na loja mas
mesmo assim esteja sendo enviado.
CpfnaNota - Mandar sempre em branco.
numero 000.000.000.00 Mandar sempre em branco.
31
FormaDePaga - Mandar sempre em branco.
mento
Pagamento -
cartao 0.00 Sempre mandar zero.
cheque 0.00 Sempre mandar zero.
contra_vale_emi 0.00 Sempre mandar zero.
contra_vale_rec 0.00 Sempre mandar zero.
cpf Mandar sempre em branco.
desconto 0.00 Sempre mandar zero.
dinheiro 0.00 Sempre mandar zero.
nome_cliente “João” Enviar nome do cliente para identificação. Opcional
numero_de_pess 1 Numero de pessoas na mesa. Mandar no mínimo o
oas número “1”.
outros 0.00 Sempre mandar zero.
pendura 0.00 Sempre mandar zero.
repique 0.00 Sempre mandar zero.
servico 0.00 Sempre mandar zero.
telefone_cliente “11987654321” Enviar telefone do cliente para identificação.
Opcional
ticket 0.00 Sempre mandar zero.
troco 0.00 Sempre mandar zero.
vale_ref 0.00 Sempre mandar zero.
valor_total 0.00 Sempre mandar zero.
Checkin Mandar objeto em branco
ComprovantePa Mandar objeto em branco
gamento
Formato da Resposta da requisição (Efetua Venda)

{
"cod": "000",
"msg": "Pedido realizado com sucesso"
}
32
Pré Fechamento da Mesa/Comanda (POST)
Solicita o pré-fechamento da mesa/comanda para o sistema.

Obs: O pré-fechamento da comanda é opcional, enquanto da mesa é obrigatória.
metodo: enviaPreFechamento
operacao: enviar o valor de “mesa” / “comanda”
Ex endpoint: ?metodo=enviaPreFechamento&operacao=mesa…
[{
"JSON": {
"metodo": "emitirPreFechamentoJSON",
"numero": 5,
"tipo_operacao": "mesa",
"modulo": "Goomer",
"usa_pinpad": "N",
"id_transacao": "3020188616266251",
"modelo_pinpad": "homolog_html_v2_cupom",
},
"dadosOperador": {
"nome_operador": "MARIA",
},
"emitirPreFechamentoJSON": {
"valor_desconto": 10,
"tipo_desconto": "porcentagem",
"numero_pessoas": 1
}
33
}
}]

Conteúdo
metodo emitirPreFechamentoJSO Nome do método que está sendo consumido
N

tipo_operacao “mesa” / “comanda” Tipo de operação que está sendo realizada
modulo Nome do programa que está consumindo a API
“NOME_INTEGRADOR
”
numero_pocket 1 Mandar sempre “1”.
usa_pinpad “S” ou “N” Mandar sempre “N”.
1 concatenar:
numero_interno+ano+mês+dia+hora+minuto+segu
ndo+milésimos
Não poderá haver, em hipótese alguma, 2
transações com o mesmo ID.
dadosDispositivo -
sistema_operacional Android, ios Sistema operacional do dispositivo
modelo_pinpad homolog_html_v2_- Indica qual modelo de resposta será retornado pelo
cupom PDV caso precise imprimir o pré-fechamento:
- homolog_html_v1_cupom (versão 1 do cupom

em HTML)
- homolog_html_v2_cupom (versão 2 do cupom

em BASE_64)
operadora_pinpad Mandar objeto vazio
34
dadosOperador
nome_operador Maria Nome do operador logado.
emitirPreFechamen
toJSON
valor_desconto 0 Enviar valor caso a conta tenha desconto.
tipo_desconto dinheiro ou Modo de desconto em dinheiro ou porcentagem,
porcentagem deve-se enviar literalmente dessa forma
numero_pessoas 1 Numero de pessoas na mesa.
Formato da Resposta da requisição (Pré-Fechamento)

{
"cod": "000",
"msg": "Pré fechamento emitido com sucesso",
}
35
Chamar Garçom (POST)
Imprime um cupom na impressora de despacho solicitando a presença do garçom
metodo: chamarGarcom
operacao: contém o valor fixo literal de “mesa” (operacao=mesa).
Ex endpoint: ?metodo=chamarGarcom&operacao=mesa…
[{
"JSON": {
"metodo": "chamarGarcomJSON",
"numero": 7,
"tipo_operacao": "mesa",
"nome_cliente": "João da Silva"
}
}]

Conteúdo
metodo chamarGarcomJSON Nome do método que está sendo consumido
numero 1,2,3,... Número da mesa/comanda que está solicitando a
presença do garçom
tipo_operacao “mesa” Tipo de operação que está sendo realizada
nome_cliente “João da Silva” Nome do cliente que está solicitando a presença do
garçom (opcional)
Formato da Resposta da requisição (Chamar Garçom)

{
"cod": "000",
}
36
Consultar a Conta da Mesa/Comanda (POST)
Solicita o total da conta (incluindo valores de serviço, descontos e lista de produtos) da mesa/
comanda inteira. Também pode ser consultado individualmente por cliente via posição na
mesa/comanda.
metodo: consultaTotalConta
[{
"JSON": {
"metodo": "consultarTotalContaJSON",
"numero": "1",
"numero_conta": 0
}
}]
Campo Exemplo de Conteúdo Descrição

metodo consultarTotalContaJSO Nome do método que está sendo consumido
N
numero 1,2,3,... Número da mesa/comanda que está
solicitando a consulta do total
tipo_operacao “mesa” ou “comanda” Tipo de operação que está sendo realizada
numero_conta “0” ou “1” É a numeração do cliente na mesa que está
solicitando a consulta da conta (se mandar
0 traz os valores totais da mesa). Essa
numeração é como se fosse a posição do
cliente sentado na mesa que solicita a parte
dele da conta (Ex: numa mesa com 4
cadeiras, o cliente que está sentando na
posição 1 decide solicitar o quanto ele
gastou).
37
Formato da Resposta da requisição (Consulta Total Conta)
dados_adicionais: uma lista com dados adicionais, onde irá trazer o total da conta, serviço, se o
serviço é obrigatório ou não, descontos, listagem de produtos e um nó chamado total indicando
diversos campos a respeito do total da conta.
{
"valido": true,
"cod": "000",
"msg": "CONSULTA TOTAL PEDIDO",
"msg_adicional": "",
"total_conta": 7.7,
"servico": 0.7,
"servico_obrigatorio": "N",
"desconto": 0.0,
"produtos": [
{
"cod_item": 86,
"descr_item": "ÁGUA MINERAL COM GÁS NESTLÉ 2 L",
"qtde": 1.0,
"vlr_unit": 7.0,
"cod_reg": 13,
"isento_servico": "N",
"isento_desconto": "N"
}
],
"total": {
"vlr_total_produtos": 7.0,
"vlr_adiantamento": 0.0,
"vlr_desconto_conta": 0.0,
"vlr_desconto_tempo_permanencia": 0.0,
"vlr_servico": 0.7
},
"html": "",
"json": [],
"cupom_json": null
}
}
38
Fechar a Conta da Mesa/Comanda (POST)
Fecha conta de uma mesa ou comanda previamente aberta. Com isso, permite que uma mesa
ou comanda consumida por horas ou minutos seja fechada atrav s desse servi o.
Obs: Para fechar uma mesa ou comanda, antes é necessário emitir o pré-fechamento da mesma (inclusive se for
aplicar desconto) e na sequência chamar o método consultaTotalConta.
metodo: fecharConta
JSON: é um objeto que será enviado via POST na chamada do WebService.

[{
"JSON": {
"metodo": "fecharContaJSON",
"numero": "61",
"pagar_agora": "S",
"usa_pinpad": "N",
"id_transacao": "30201886162454775",
},
"dadosOperador": {
"nome_operador": "JOSÉ",
},
"inserirPagamentoJSON": {
"CpfnaNota": [{
"numero": "370.343.488-04",
"valor_cupom": 66
}],
39
é
ç
"FormaDePagamento": [{
"flag_de_pagamento": "C",
"nome_bandeira": "Visa",
"codigo_bandeira": "1",
"valor": "66"
}],
"Pagamento": {
"valor_total": 66,
"dinheiro": 0,
"cheque": 0,
"cartao": 66,
"ticket": 0,
"outros": 0,
"servico": 6,
"desconto": 0,
"vale_ref": 0,
"troco": 0,
"nome_cliente": "",
"repique": 0,
"pendura": 0,
"cpf": ""
},
"ComprovantePagamento": ["{\"details\":{\"sale\":{\"id\":\"2020-20191128101646\",\"fiscal_coupon_nr\":
\"2020\",\"customer_name\":\"Unknow\",\"operator_name\":\"Terminal 01\",\"terminal_name\":\"Unknow\",\"payment_method\":
\"credit\",\"status\":\"started\",\"transfer_datetime\":\"2019-11-28T12:16:54.000Z\",
\"total_value\":1,\"total_taxes\":0,\"transfer_canceled\":false,\"store_id\":\"00000000\",\"pdv_id\":\"AA000001\",\"cc_first_digits\":
\"516292\",\"card_type_obj\":{\"code\":\"00002\",\"description\":\"Mastercard\",\"category\":\"Crédito\",\"subcategory\":\"-\"},
\"customer_receipt_coupon\":\".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S....\\nSI Rede 5\\nMU Codigo
transacao: 200\\nLA Codigo operacao: 3000\\nDO Valor: 1\\n.....S...I...M...U...L...A...D...O....\\nSI
NSU SiTef: 280016\\nMU 28/11/19 10:16\\nLA ID PDV: AA000001\\nDO Estab.:
000000000000005\\n.....S...I...M...U...L...A...D...O....\\nSI Host: 999280016\\nMU Transacao Simulada Aprovada\
\n (SiTef)\\n\",\"vendor_receipt_coupon\":\".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S....\\nSI Rede 5\
\nMU Codigo transacao: 200\\nLA Codigo operacao: 3000\\nDO Valor: 1\
\n.....S...I...M...U...L...A...D...O....\\nSI NSU SiTef: 280016\\nMU 28/11/19 10:16\\nLA ID PDV:
AA000001\\nDO Estab.: 000000000000005\\n.....S...I...M...U...L...A...D...O....\\nSI Host: 999280016\\nMU
Transacao Simulada Aprovada\\n (SiTef)\\n\",\"authorizer_id\":\"00005\",\"card_type\":\"00002\",
\"payment_type_code\":\"0200\",\"sitef_nsu\":\"280016\",\"host_nsu\":\"999280016\",\"credit_authorizer\":\"280016\",
\"institution_name\":\"MASTERCARD \"},\"fiscalDate\":\"20191128\",\"fiscalHour\":\"101646\",\"couponText\":
\".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S....\\nSI Rede 5\\nMU Codigo transacao: 200\\nLA Codigo
operacao: 3000\\nDO Valor: 66\\n.....S...I...M...U...L...A...D...O....\\nSI NSU SiTef: 280016\\nMU
28/11/19 10:16\\nLA ID PDV: AA000001\\nDO Estab.: 000000000000005\\n.....S...I...M...U...L...A...D...O....
\\nSI Host: 999280016\\nMU Transacao Simulada Aprovada\\n (SiTef)\\n\",
\"vendorCouponText\":\".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S....\\nSI Rede 5\\nMU Codigo transacao: 200\
\nLA Codigo operacao: 3000\\nDO Valor: 1\\n.....S...I...M...U...L...A...D...O....\\nSI NSU SiTef:
280016\\nMU 28/11/19 10:16\\nLA ID PDV: AA000001\\nDO Estab.: 000000000000005\
\n.....S...I...M...U...L...A...D...O....\\nSI Host: 999280016\\nMU Transacao Simulada Aprovada\\n
(SiTef)\\n\",\"cc_first_digits\":\"516292\",\"authorizer_id\":\"00005\",\"card_type\":\"00002\",\"payment_type_code\":\"0200\",
\"sitef_nsu\":\"280016\",\"host_nsu\":\"999280016\",\"credit_authorizer\":\"280016\",\"institution_name\":\"MASTERCARD \"},
\"id\":\"2020-20191128101646\",\"fiscal_coupon_nr\":\"2020\",\"customer_name\":\"Unknow\",\"operator_name\":\"Terminal 01\",
\"terminal_name\":\"Unknow\",\"payment_method\":\"credit\",\"status\":\"done\",\"transfer_datetime\":
\"2019-11-28T12:16:54.000Z\",\"total_value\":66,\"total_taxes\":0,\"transfer_canceled\":false,\"store_id\":\"00000000\",\"pdv_id\":
40
\"AA000001\",\"cc_first_digits\":\"516292\",\"card_type_obj\":{\"code\":\"00002\",\"description\":\"Mastercard\",\"category\":
\"Crédito\",\"subcategory\":\"-\"},\"customer_receipt_coupon\":\".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S....\\nSI Rede
5\\nMU Codigo transacao: 200\\nLA Codigo operacao: 3000\\nDO Valor: 66\
\n.....S...I...M...U...L...A...D...O....\\nSI NSU SiTef: 280016\\nMU 28/11/19 10:16\\nLA ID PDV:
AA000001\\nDO Estab.: 000000000000005\\n.....S...I...M...U...L...A...D...O....\\nSI Host: 999280016\\nMU
Transacao Simulada Aprovada\\n (SiTef)\\n\",\"vendor_receipt_coupon\":\".....S.O.F.T.W.A.R.E.E.X.P.R.E.S.S....\
\nSI Rede 5\\nMU Codigo transacao: 200\\nLA Codigo operacao: 3000\\nDO
Valor: 66\\n.....S...I...M...U...L...A...D...O....\\nSI NSU SiTef: 280016\\nMU 28/11/19 10:16\\nLA
ID PDV: AA000001\\nDO Estab.: 000000000000005\\n.....S...I...M...U...L...A...D...O....\\nSI Host: 999280016\
\nMU Transacao Simulada Aprovada\\n (SiTef)\\n\",\"authorizer_id\":\"00005\",\"card_type\":\"00002\",
\"payment_type_code\":\"0200\",\"sitef_nsu\":\"280016\",\"host_nsu\":\"999280016\",\"credit_authorizer\":\"280016\",
\"institution_name\":\"MASTERCARD \"}"
"}]
}
}]

Conteúdo
metodo fecharContaJSON Nome do método que está sendo consumido
tipo_operacao “comanda” Tipo de operação que está sendo realizada.
Será “mesa” ou “comanda”
modulo Nome do programa/empresa que está
“NOME_INTEGRADOR consumindo a API
”
pagar_agora “S” Mandar sempre “S”
usa_pinpad “N” Mandar sempre “N”
41
1 concatenar:
número_interno+ano+mês+dia+hora+minuto
+segundo+milésimos
Não poderá haver, em hipótese alguma, 2
transações com o mesmo ID.
dadosDispositivo -
ip_dispositivo 192.168.0.1 IP do dispositivo que está efetuando o
lançamento
sistema_operacional android Sistema operacional do dispositivo
modelo_pinpad homolog_html_v2_cup Indica qual modelo de resposta será retornado
om
dos cupons fiscais:
- homolog_html_v1_cupom (versão 1 do cupom em

HTML)
BASE_64)
- homolog_objeto_cupom (versão 3 do cupom em
JSON)
operadora_pinpad “” Mandar sempre vazio.

dadosOperador
codigo_operador 2 Código interno da Eclética do operador
logado.
inserirPagamentoJSON -
CpfnaNota - Array para caso de divisão de cupom por
parte dos clientes numa mesma mesa por
370.343.488-04 exemplo.
numero Enviar caso cliente queira CPF na nota.
valor_cupom 0.00 Valor pago por determinado cliente na nota
fiscal para CPF na nota. Mandar valor total do
pedido caso seja um único cliente a pagar a
mesa/comanda.
FormaDePagamento - Array com os detalhes de bandeira dos
pagamentos enviados.
flag_de_pagamento C, T ou O Tipo da bandeira no Eclética: C = Cartão, T =
Ticket e O = Outras
nome_bandeira “Visa” Descrição do detalhe de bandeira utilizada
codigo_bandeira “1” Código da bandeira cadastrada no Eclética
valor 0.00 Valor pago na bandeira
42
Pagamento -
cartao 0.00 Enviar valor caso seja pagamento em cartão
cheque 0.00 Sempre mandar zero.
contra_vale_emi 0.00 Sempre mandar zero.
contra_vale_rec 0.00 Sempre mandar zero.
cpf Utilizado geralmente para programa
fidelidade
desconto 0.00 Sempre mandar zero.
dinheiro 0.00 Enviar valor caso o pagamento seja em
dinheiro
nome_cliente 0.00 Enviar nome do cliente caso necessário para
identificação.
numero_de_pessoas 1 Numero de pessoas na mesa. Mandar no
mínimo o número “1”.
outros 0.00 Enviar valor caso o pagamento seja do tipo
“Outras”
pendura 0.00 Sempre mandar zero.
repique 0.00 Enviar valor caso o cliente queira dar gorjeta
ao garçom.
servico 0.00 Informar valor se serviço se houver
telefone_cliente Informar telefone do cliente se houver
necessidade para identificação
ticket 0.00 Informar valor se o pagamento for feito com
“Ticket”
troco 0.00 Informar valor caso haja troco no pagamento
em dinheiro
valor_total 0.00 Informar o valor total da conta
ComprovantePagamento Enviar JSON/XML do cupom em texto (com
as aspas juntas das barras Ex: \” ) retornado
pelo gateway caso o pedido seja pago
diretamente no dispositivo de auto-
atendimento. É importante que neste
aglomerado de informações contenha um
dado crucial para a loja que é o nsu da
transação.
43
Formato da Resposta da requisição (Fechar Conta)
dados_adicionais: uma lista com dados adicionais do fechamento da mesa/comanda. Neste
exemplo foi requerido o cupom no modelo “homolog_html_v2_cupom” BASE64 como segue:
{
"cod": "000",
"msg": "Pedido realizado com sucesso",
"total_conta": 0.0,
"servico": 0.0,
"desconto": 0.0,
"produtos": [],
"html": "",
"json": [
{
"operation": "PRINT_IMAGE",
"style": [],
"value": [ "/9j/4AAQSkZJRgABAQEBLAEsAAD/
2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ
EBAQEBAQEBAQEBAQEBAQH/
2wBDAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ
EBAQEBAQEBAQEBAQEBAQH/..."
]
}
],
}
}
44
Mapa de Mesas (GET)
Exibe a listagem das mesas com seus respectivos status no estabelecimento.
metodo: mapaDeMesas
Formato da Resposta da requisição (Mapa de Mesas)

dados_adicionais: uma lista com o mapa das mesas e suas numerações(“num”) as quais podem ter
os seguintes “status”: EmUso, Livre ou Fechando:
{
"cod": "000",
"mesas": [{
"num": 1,
"status": "EmUso"
},
{
"num": 2,
"status": "Livre"
},
{
"num": 3,
"status": "Fechando"
}
]
}
}
45
Mapa de Comandas (GET)
Exibe a listagem das comandas com seus respectivos status no estabelecimento.
metodo: mapaDeComandas
Formato da Resposta da requisição (Mapa de Comandas)

dados_adicionais: uma lista com o mapa das comandas e suas numerações(“num”) as quais podem
ter os seguintes “status”: EmUso, Livre ou Bloqueada(com a descrição do motivo se houver):
{
"cod": "000",
"comandas": [{
"num": 1,
"status": "EmUso"
“motivo”: “”
},
{
"num": 2,
"status": "Livre"
“motivo”: “”
},
{
"num": 3,
"status": "Bloqueada",
“motivo”: “MOTIVO DO BLOQUEIO”
}
]
}
}
46
Venda Balcão/Comanda (POST)
Envia uma venda balcão/comanda para o sistema já paga no ato.
Obs: Para comanda, diferente do modelo anterior onde deve-se enviar primeiramente os produtos através do
método de inserir itens para posteriormente usar o método de fechamento, neste modelo é possível inserir os
itens já fechando (enviando o pagamento) numa única requisição.
metodo: efetuaVenda
JSON: é um objeto que será enviado via POST na chamada do WebService.
Exemplo da estrutura de JSON para uma venda Balcão:

[{
"JSON": {
"metodo": "inserirPedidoJSON",
"numero": "0",
"tipo_operacao": "balcão",
"pagar_agora": "S",
"usa_pinpad": "S",
"id_transacao": "30201886162454775",
},
"dadosOperador": {
"nome_operador": “NOME_INTEGRADOR“,
},
"inserirPedidoJSON": {
"Itens": [{
"ordem": 1,
47
"cod_item": "18",
"descr_item": "Skol Long Neck",
"descr_item_impresso": "Skol Long Neck",
"quantidade": 1,
"vlr_unit": "8.00",
"posicao": 0,
"observacao": "",
"multisabor": "N",
"impressao1": "2",
"impressao2": "3",
"brinde": "N",
"cod_reg": 1,
"combo": "N",
"promocao": "N",
"status": "N",
"faltante": "N",
"valor_total": "8.00"
}],
"CpfnaNota": [{
"numero": "370.343.488-04",
"valor_cupom": “8.00”
}],
"FormaDePagamento": [{
"flag_de_pagamento": "C",
"nome_bandeira": “MasterCard Crédito",
"codigo_bandeira": "2",
"valor": “5,50"
}],
"Pagamento": {
"valor_total": 8.00,
"dinheiro": 2.50,
"cheque": 0,
"cartao": 5.50,
"ticket": 0,
"outros": 0,
"servico": 0,
"desconto": 0,
"vale_ref": 0,
"troco": 0,
"nome_cliente": "",
48
"repique": 0,
"pendura": 0,
"cpf": ""
},
"ComprovantePagamento": [{"createdAt":"Aug 17, 2018 5:07:31
PM”,"id":"06e05655-29cf-4643-9310-57be1c00ea06","items":[{"description":"","details":"","id":"27839565-b09b-4668-
b45d-3862e72d64b1","name":"Skol Long
Neck","quantity":1,"reference":"","sku":"1234","unitOfMeasure":"unidade","unitPrice":30}],"notes":"","number":"","paidAmount":
9,"payments":
[{"accessKey":"FOQBvCi5UvsjFgyiSOHlhRxDjWfD","amount":9,"applicationName":"com.ads.lio.uriappclient","authCode":"0753
59","brand":"VISA","cieloCode":"447840","description":"","discountedAmount":0,"externalId":"4a6c4d8b-bfee-4b96-
be20-835570a75e41","id":"4554c304-5667-444b-899f-2a5e33612058","installments":0,"mask":"************3694","merchantCod
e":"0011035627439400","paymentFields":{"clientName":"RUBENS F AMARAL F
","upFrontAmount":"0","creditAdminTax":"0","firstQuotaDate":"0","hasSignature":"false","hasPrintedClientReceipt":"false","hasW
arranty":"false","interestAmount":"0","serviceTax":"0","cityState":"SAO PAULO
SP","hasSentReference":"false","originalTransactionId":"0","cardLabelApplication":"CREDITO","originalTransactionDate":"17/08/
18","hasConnectivity":"true","productName":"CREDITO A
VISTA","finalCryptogram":"FC77B4A519506BB7","entranceMode":"303010104080","firstQuotaAmount":"0","cardCaptureType":
"0","requestDate":"1534536472000","boardingTax":"0","numberOfQuotas":"0","isDoubleFontPrintAllowed":"false","hasPassword":
"true","primaryProductCode":"1000","isExternalCall":"true","primaryProductName":"CREDITO","receiptPrintPermission":"1","isO
nlyIntegrationCancelable":"false","externalCallMerchantCode":"0011035627439400","isFinancialProduct":"true","applicationName
":"com.ads.lio.uriappclient","changeAmount":"0","v40Code":"4","secondaryProductName":"A
VISTA","paymentTransactionId":"4a6c4d8b-bfee-4b96-be20-835570a75e41","typeName":"VENDA A
CREDITO","avaiableBalance":"0","pan":"************3694","secondaryProductCode":"1","hasSentMerchantCode":"true","docu
mentType":"J","statusCode":"1","merchantAddress":"R. CONSOLACAO
3367","merchantCode":"0011035627439400","paymentTypeCode":"1","merchantName":"ECLETICA
TECNOLOGIA","totalizerCode":"10","applicationId":"cielo.launcher","document":"002143500000108"},"primaryCode":"1000","re
questDate":"1534536472000","secondaryCode":"1","terminal":"78286226"}],"pendingAmount":0,"price":9,"reference":"Order","sta
tus":"ENTERED","type":"PAYMENT","updatedAt":"Aug 17, 2018 5:07:32 PM"}]
}
}
}]
Explicação da estrutura de cada parâmetro de JSON:

Conteúdo
metodo inserirPedidoJSO Nome do método que está sendo consumido
N
numero 0 ou 1,2,3… Para balcão mande sempre zero “0”, para comanda
mande o número da mesma.
tipo_operacao “balcão” / Tipo de operação que está sendo realizada. Será
“comanda” “balcão” ou “comanda”
modulo Nome do programa/empresa que está consumindo a
“NOME_INTEGRA API
DOR”
49
pagar_agora “S” ou “N” Mandar sempre “S”
usa_pinpad “S” ou “N” Mandar sempre “N”
9361 concatenar:
número_interno+ano+mês+dia+hora+minuto+segund
o+milésimos
Não poderá haver, em hipótese alguma, 2 transações
com o mesmo ID.
dadosDispositivo -
sistema_operacional android Sistema operacional do dispositivo
modelo_pinpad homolog_html_v2_c Indica qual modelo de resposta será retornado dos
upom
cupons fiscais:
- homolog_html_v1_cupom (versão 1 do cupom em HTML)

BASE_64)
- homolog_objeto_cupom (versão 3 do cupom em JSON)
operadora_pinpad Mandar sempre vazio.

dadosOperador
InserirPedidoJSON -
Itens
ordem 1,2,3,... Ordem que os itens foram lançados. Começa com 1,
sendo acrescido +1 a cada novo item.
cod_reg 1,2,3,... Código de agrupamento. Cada item terá um código
de agrupamento específico, exceto produtos
multisabor ou dentro de um combo. Ex: para uma
pizza meia calabresa, meia mussarela deve ser
enviados dois registros com “ordem” diferente, mas
cod_reg iguais. O mesmo exemplo se aplica para
itens pertencentes ao mesmo combo.
cod_item 1,2,3,... Código interno da eclética
50
descr_item Suco de Laranja Nome do produto na base da eclética
descr_item_impresso Suco de Laranja Nome do produto na base da eclética.
quantidade 1,2,3,... Quantidade do produto
vlr_unit 8.50 Valor unitário do produto
valor_total 17.00 Valor unitário multiplicado pela quantidade
posicao 2 Posição do item na mesa ou o número da mesa em
caso de comanda. Caso não exista, enviar valor ‘0’
observacao Com gelo Observação variável do item
multisabor “S” ou “N” “S” caso seja uma pizza multisabor (meia de um
sabor, meia de outro)
impressora que o produto será impresso na
impressora 1
impressora que o produto será impresso na
impressora 2
brinde “S” ou “N” Mandar sempre “N”.
combo “S” ou “N” “S” caso o produto faça parte de um combo. Ex:
hambúrguer + batata + bebida
promocao “S” ou “N” “S” caso o produto esteja sendo enviado com algum
desconto
status “S”, “N”, “V” “N” normal para venda. “S” não deve ser vendido.
“V” produto vinculado a um outro conforme o
cadastro do produto.
faltante “S” ou “N” “S” caso o produto esteja como faltante na loja mas
mesmo assim esteja sendo enviado.
CpfnaNota - Array para caso de divisão de cupom por parte dos
clientes numa mesma comanda/balcão por exemplo.
numero 370.343.488-04 Enviar caso cliente queira CPF na nota.
valor_cupom 0.00 Valor pago por determinado cliente na nota fiscal
para CPF na nota.
FormaDePagamento - Array com detalhes de bandeiras dos pagamentos
enviados.
codigo_bandeira 1, 2, 3, 4 Código interno da Eclética. Identifica a bandeira
dentro da nossa base de dados.
51
flag_de_pagamento C, T, O “C” para cartão; “T” para ticket; “O” para outras.
nome_bandeira Visa, Master, etc Nome da bandeira selecionada.

valor 5,50 Valor que está sendo pago nesta forma de pagamento
Pagamento -
valor_total 5,50 Valor total da venda. Valor Total dos Produtos menos
o valor dado em Desconto.
cartao 0.00 No total, quanto foi pago em cartão.
cheque 0.00 No total, quanto foi pago em cheque.
contra_vale_emi 0.00 Mandar sempre 0.00.
contra_vale_rec 0.00 No total, quanto foi pago em contra vale recebido.
cpf Utilizado geralmente para programa fidelidade
desconto 0.00 Desconto que foi dado na conta.
dinheiro 0.00 No total, quanto foi pago em dinheiro.
nome_cliente “João” Enviar nome do cliente para identificação. Opcional
numero_de_pessoas 1 Numero de pessoas na mesa. Mandar no mínimo o
número “1”.
outros 0.00 No total, quanto foi pago em “outras" formas de
pagamento.
pendura 0.00 No total, quanto foi pendurado de valor.
repique 0.00 Sempre mandar zero.
servico 0.00 Sempre mandar zero.
telefone_cliente “11987654321” Enviar telefone do cliente para identificação.
Opcional
ticket 0.00 No total, quanto foi pago em ticket.
troco 0.00 Valor que deve ser dado de troco para o cliente.
Checkin Mandar objeto em branco
52
ComprovantePagam Mandar resposta (comprovante do pagamento) da
ento transação do Gateway em formato JSON para log
interno do sistema Eclética. O JSON de resposta que
demonstramos nesta propriedade é de um gateway da
CIELO.
Formato da Resposta da requisição (Venda Balcão/Comanda)

dados_adicionais: uma lista com dados adicionais da venda balcão/comanda. Neste exemplo foi
requerido o cupom no modelo “homolog_html_v2_cupom” que retorna BASE64 como segue:
{
"cod": "000",
"msg": "Pedido realizado com sucesso",
"total_conta": 0.0,
"servico": 0.0,
"desconto": 0.0,
"produtos": [],
"html": "",
"json": [
{
"operation": "PRINT_IMAGE",
"style": [],
"value": [ "/9j/4AAQSkZJRgABAQEBLAEsAAD/
2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ
EBAQEBAQEBAQEBAQEBAQH/
2wBDAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ
EBAQEBAQEBAQEBAQEBAQH/..."
]
}
],
}
}
Exemplo na página abaixo de modelo impresso do retorno do PDV:
53
54
Tabela de Respostas (Sucesso e Erro) das requisições
cod msg dados_adicionais

000 Operação efetuada com sucesso Podem ser dados JSON diversos
001 Falha na autenticação Não exibe dados adicionais
002 Comanda bloqueada Ex: {“bloqueada” : {“motivo” : “Comanda
perdida/quebrada”}}
003 Mesa em Pré Fechamento Não exibe dados adicionais
004 Mesa não encontrada Não exibe dados adicionais
005 Comanda não encontrada Não exibe dados adicionais
006 Falha ao estabelecer comunicação com o Não exibe dados adicionais
socket IP: XXX.XXX.XXX - Verifique se
o Monitor está aberto
007 Falha ao conectar com o MySQL Não exibe dados adicionais

050 A loja não possui NFC-e e nem SAT ativos Não exibe dados adicionais
054 Gerando a nota de SAT; Não exibe dados adicionais
055 Não foi possível emitir pré fechamento; Não exibe dados adicionais
057 Gerando a nota de NFCe; Não exibe dados adicionais
55

Documentacao WEBService REST Ecletica E GarcomPro Mesa Comanda Balcao 3.2.0

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Documentacao WEBService REST Ecletica E GarcomPro Mesa Comanda Balcao 3.2.0

Enviado por

Direitos autorais:

Formatos disponíveis

Documentação API (Local & Online DMWS) Mesa -

Receberá inclusive um token hexadecimal de 40 caracteres para autenticação em todos os serviços o

• Autenticação ----------------------------------------------------------------------------- pg: 2

Parâmetros obrigatórios API Local:

loginToken: Token enviado no header da requisição para autenticação no WebService (fornecido

Obs: dependendo do método, outros parâmetros devem ser fornecidos

API Online (DMWS):

Endpoint (Produção) https://www.pedidoviaweb.com.br/ws/dmws/index.php?metodo={nome_me-

Parâmetros obrigatórios API Online:

rede: Número da Rede do estabelecimento (fornecido pela Eclética)

loja: Número da Loja do estabelecimento (fornecido pela Eclética)

loginToken: Token enviado no header da requisição para autenticação no WebService (fornecido

Obs: dependendo do método, outros parâmetros devem ser fornecidos

Formato da Resposta da requisição (verificações Iniciais)

O retorno será em JSON contendo até 3 elementos:

Exemplo de sucesso de verificacoesIniciais:

Campo Tipo Descrição

usa_multisabor String Multisabor normalmente é utilizado em Pizzarias

Exibe a listagem dos detalhes de bandeira(formas de pagamento) cadastrados na loja.

Formato da Resposta da requisi o (Lista Detalhe Bandeiras)

Campo Tipo Descri o

codigo '0': 'credito';

Para tipo_det “O” de outras, c_magnus ser sempre 0 (zero).

Exibe a listagem de grupos (categorias) dos produtos da loja.

Parâmetros adicionais da requisição:

num_pocket: Número do pocket retornado pelo método verificacoesIniciais.

Formato da Resposta da requisição (Lista Grupos)

O retorno será em JSON contendo até 3 elementos:

Exemplo de sucesso de listaGrupos:

Campo Tipo Descrição

Campo Tipo Descrição

Exibe a listagem de produtos da loja.

Formato da Resposta da requisição (Lista Produtos)

O retorno será em JSON contendo até 3 elementos:

Exemplo de sucesso de listaProdutos:

Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais-

Campo Tipo Descrição

Exibe a listagem de combos da loja.

Formato da Resposta da requisição (Lista Combos)

O retorno será em JSON contendo até 3 elementos:

Campo Tipo Descrição

qtde_obrig String Determina a quantidade( m xima ou obrigat ria ) de

Formato da Resposta da requisição (Lista Pizzas)

O retorno será em JSON contendo até 3 elementos:

Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais->pizzas-

Campo Tipo Descrição

Explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais->pizzas-

Campo Tipo Descrição

Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais->pizzas-

Campo Tipo Descrição

Exibe a listagem das promoções cadastradas na loja.

Formato da Resposta da requisição (Lista Promoções)

Campo Tipo Descrição

Exibe a listagem dos produtos faltantes cadastrados na loja.

Formato da Resposta da requisição (Lista Produtos Faltantes)

Segue explicação da estrutura de cada parâmetro de resposta do nó dados_adicionais-

Campo Tipo Descrição

Exibe a listagem dos produtos vinculados cadastrados na loja.

Formato da Resposta da requisição (Lista Produtos Vinculados)

Campo Tipo Descrição

Exibe a listagem dos operadores cadastrados na loja.

Parâmetros adicionais da requisição:

operacao: contém o valor fixo literal de “mesa” (operacao=mesa).

Formato da Resposta da requisição (Lista Operadores)