API Pública do Gourmet

Descrição

Permite criar e consultar contas através do servidor Yoda/WEB.

Configuração

URL
/public-api/v1/gourmet/conta

Verbos suportados
POST, GET

Status HTTP
200 = OK, 400 = Falha na validação dos dados. Veja a mensagem retornada para mais detalhes, 404 = Objeto não encontrado, 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

JSON de Exemplo

{
   "numero": 2,
   "tipo": "COMANDA",
   "codigoFilial": "1",,
   "nomeIntegracao": "Postman",
   "observacao": "Teste",
   "valorTotalItens": "39.00",
   "valorDescontoSubtotal": "1.00",
   "itens": [
       {
           "opcionais": null,
           "valorDescontoSubtotal": "2.500",
           "observacao": "Sem milho",
           "valorTotal": "17.500",
           "codigoProduto": "1002",
           "codigoUnidadeMedida": "UN",
           "nomeProduto": "X Salada",
           "quantidade": "2.000",
           "valorUnitario": "10.000",
       },
       {
           "valorDescontoSubtotal": "0.000",
           "observacao": "Sem tomate",
           "valorTotal": "16.000",
           "codigoProduto": "1004",
           "codigoUnidadeMedida": "UN",
           "nomeProduto": "X Egg",
           "quantidade": "1.000",
           "valorUnitario": "15.000",
           "opcionais": [
               {
                   "tipo": "COM",
                   "valorTotal": "1.00",
                   "codigoProduto": "1003",
                   "nomeProduto": "Bacon",
                   "quantidade": "2.000",
                   "valorUnitario": "0.500",
               }
           ]
       },
       {
           "valorDescontoSubtotal":"0.500",
           "observacao": "null",
           "valorTotal": "5.500",
           "codigoProduto": "1006",
           "codigoUnidadeMedida": "LT",
           "nomeProduto": "Coca-Cola",
           "quantidade": "1.000",
           "valorUnitario": "6.000",
           "opcionais": [
               {
                   "tipo": "SEM",
                   "valorTotal": "0,00",
                   "codigoProduto": "1020_",
                   "nomeProduto": "Gelo",
                   "quantidade": "1.000",
                   "valorUnitario": "0.000"
               }
           ]
       }
   ],
   "cliente": {
       "cpf": "54995193073",
       "nome": "Pedrinho"
   },
   "pagamentos": [
       {
           "forma": "DINHEIRO",
           "valor": "10.000"
       },
       {
           "forma": "CARTAO",
           "valor": "10.000"
       },
       {
           "forma": "PIX",
           "valor": "3.000"
       },
       {
           "forma": "CARTEIRA DIGITAL",
           "valor": "5.000"
       },
       {
           "forma": "OUTROS",
           "valor": "10.000"
       }
   ]
}

Schema do JSON

{
   "$schema": "http: //json-schema.org/draft-04/schema#",
   "title": "Conta API",
   "type": "object",
   "additionalProperties": false,
   "properties": {
       "nomeIntegracao": {
           "type": "string",
           "maxLength": "64"
       },
       "numero": {
           "type": "integer"
       },
       "tipo": {
           "type": "string",
           "enum": ["MESA", "COMANDA"]
       },
       "codigoFilial": {
           "type": "string",
           "maxLength": "4"
       },
       "observacao": {
           "type": "string",
           "maxLength": "255"
       },
       "valorDescontoSubtotal": {
           "type": "number"
       },
       "valorTotalItens": {
           "type": "number"
       },
       "cliente": {
           "$ref": "#/definitions/ClienteAPI"
       },
       "itens": {
           "type": "array",
           "minItems": "1",
           "maxItems": "1000",
           "items": {
               "$ref": "#/definitions/ItemAPI" 
           }
       },
       "pagamentos": {
           "type": "array"
           "minItems": "0",
           "maxItems": "1000",
           "items": {
               "$ref": "#/definitions/PagamentoAPI"" 
           }
       }
   },
   "required": ["nomeIntegracao", "numero", "tipo", "codigoFilial", "valorTotalItens", "itens"]
   "definitions": {
       "ClienteAPI": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
               "nome": {
                   "type": "string",
                   "maxLength": "60"
               },
               "cpf": {
                   "type": "string",
                   "maxLength": "18"
               }
           }
       },
       "ItemAPI": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
               "codigoProduto": {
                   "type": "string",
                   "maxLength": "20"
               },
               "nomeProduto": {
                   "type": "string",
                   "maxLength": "120"
               },
               "codigoUnidadeMedida": {
                   "type": "string",
                   "maxLength": "6"
               },
               "observacao": {
                   "type": "string",
                   "maxLength": "255"
               },
               "valorUnitario": {
                   "type": "number"
               },
               "quantidade": {
                   "type": "number"
               },
               "valorDescontoSubtotal": {
                   "type": "number" 
               },
               "valorTotal": {
                   "type": "number" 
               },
               "opcionais": {
                   "type": "array"
                   "items": {
                       "$ref": "#/definitions/OpcionalAPI"
                   }
               }
           },
           "required": ["codigoProduto", "nomeProduto", "codigoUnidadeMedida", "valorUnitario", "quantidade", "valorTotal"]
       },
       "OpcionalAPI": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
               "codigoProduto": {
                   "type": "string",
                   "maxLength": "20"
               },
               "nomeProduto": {
                   "type": "string",
                   "maxLength": "120"
               },
               "valorUnitario": {
                   "type": "number"
               },
               "quantidade": {
                   "type": "number"
               },
               "valorTotal": {
                   "type": "number"
               },
               "tipo": {
                   "type": "string",
                   "enum": ["COM", "SEM"]
               }
           },
           "required": ["codigoProduto", "nomeProduto", "valorUnitario", "quantidade", "valorTotal", "tipo"]
       },
       "PagamentoAPI": {
           "type": "object",
           "additionalProperties": false,
           "properties": {
               "valor": {
                   "type": "number"
               },
               "forma": {
                   "type": "string"
                   "enum": ["DINHEIRO", "CARTAO", "PIX", "CARTEIRA_DIGITAL", "OUTROS"]
               }
           },
           "required": ["valor", "forma"]
       }
   }
}

Criando/atualizando Contas (POST)

Para criar ou atualizar contas, utilize o verbo POST passando o JSON no corpo da requisição. Caso esteja tudo certo com os dados, o servidor enviará o pedido para a produção. Note que o método POST não permite editar itens existentes. Apenas é permitido incluir novos itens. Exemplo de requisição completa disponível na collection do Postman.

Consultando Contas (GET)

Para consultar contas, utilize o verbo GET passando os seguintes parâmetros obrigatórios: numero: número da conta. Exemplo: 30;

• tipo: tipo da conta. Exemplo: “MESA” ou “COMANDA”;
• codigoFilial: código da filial onde a conta está aberta. Exemplo: “1”;
• incluirItens: indica se a consulta deve ou não incluir os itens. Exemplo: “true” ou “false;

Exemplo de requisição completa disponível na collection do Postman.

Collection do Postman

Nesta collection do Postman existem exemplos de como gerar token, incluir/atualizar e consultar contas. Para mais detalhes sobre como conectar na API pública, veja este artigo.

Conteúdo Relacionado

Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• Uniplus Gourmet
• Vendas Uniplus Gourmet
• PDVConf: Aba Uniplus Gourmet / Conta de Cliente