{"info":{"_postman_id":"eb5202f9-4884-4b0d-b3f4-d105d594ba3c","name":"Get In APIs (ONLY FOR DOC)","description":"

📄 Introdução

O GET IN fornece muitos produtos, ferramentas e recursos de API que permitem que você gerencie suas reservas, filas de espera e cardápios.

Guia de uso

Para iniciar o uso de nossas APIs, você precisa saber que:

Precisa ter a chave de API (API Key) para se autenticar e ter acesso aos endpoits.
\n
Para ter um controle maior de segurança e disponibilidade, as APIs possuem limites de requisições.
\n
Todas as APIs trabalham com a comunicação por meio de dados solicitados e disponibilizados em formato JSON.
\n

Autenticação

As APIs v2 GET IN utilizam autenticação por meio de chave de API (API Key).

Para obter esta chave, preencha nosso formuário de solicitação e nossa equipe disponibilizará no endereço de e-mail informado no cadastro.

Com a API Key em mãos é necessário o envio da mesma como HEADER apiKey em cada requisição.

Obs: Em primeiro momento, disponibilizamos uma chave apenas para o ambiente de homologação (sandbox). A chave de ambiente de produção será gerada após aprovação na etapa de homologação da aplicação que fará a integração.

Erro de autenticação

Se em algum momento a chave de API estiver faltando, incorreta ou inválida, será retornado um erro HTTP 401 Unauthorized

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Introdução","slug":"introducao"}],"owner":"10758727","collectionId":"eb5202f9-4884-4b0d-b3f4-d105d594ba3c","publishedId":"2sB2x5FsK7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-10T15:58:46.000Z"},"item":[{"name":"v2","item":[{"name":"Units","item":[{"name":"Retrieve All","event":[{"listen":"test","script":{"id":"6c2310fc-2ee1-477a-b37b-b5bcd36a8f89","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"unit_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"f16e4254-0c03-45ed-bb5b-b997d43b194a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/units","description":"

Obter a lista de unidades disponíveis baseado na credencial.

Entrada:

É possível definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de reservas encontradas.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Com unidades encontradas:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"VPz**DPQ\",\n            \"cuisines\": [\n                {\n                    \"id\": \"ld1VQPvB\",\n                    \"name\": \"Árabe\",\n                    \"slug\": \"arabe\",\n                    \"image\": \"https://cdn.gistg.pw/cuisines/arabe-cd888fc16846bd0ee4d6b9b40c45fb6053be2690.jpg\"\n                },\n                {\n                    \"id\": \"RLkwa13x\",\n                    \"name\": \"Argentina\",\n                    \"slug\": \"argentina\",\n                    \"image\": \"https://cdn.gistg.pw/cuisines/argentina-18ded1d74d4c3e4b9a62891e14f1f27140f41cf3.jpg\"\n                },\n            ],\n            \"cuisine_name\": \"Árabe\",\n            \"city_slug\": \"sao-paulo\",\n            \"name\": \"Restaurante Homologação\",\n            \"slug\": \"restaurante-homologacao\",\n            \"about\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ultrices turpis odio, ac pretium enim gravida scelerisque. Aliquam arcu arcu.\",\n            \"payment_description\": \"Dinheiro, Cartão de crédito, Sodexo\",\n            \"opening_hours_description\": \"\",\n            \"price_range\": \"$$\",\n            \"price_range_description\": \"de R$61 até R$120\",\n            \"cover_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/f371f553-6899-41d3-b8fa-541e1e55abf3.png\",\n            \"profile_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/9176c3e8-d5c2-44dc-b432-46a7e86e0098.png\",\n            \"photos\": [\n                {\n                    \"id\": \"yPA**31z\",\n                    \"image\": \"628db6af-bc8c***1770ef2f9058.jpg\",\n                    \"unit_id\": \"O6p**ak5\",\n                    \"priority\": 1,\n                    \"created_at\": \"2023-08-25T18:38:56.000000Z\",\n                    \"updated_at\": \"2023-08-25T18:38:56.000000Z\",\n                    \"deleted_at\": null\n                }\n            ],\n            \"full_address\": \"Avenida Alpha, 123, Vila Beta, São Paulo-SP\",            \n            \"website\": \"https://restaurante.getin.app\",\n            \"telephone\": \"5500999999999\",\n            \"zipcode\": \"05506070\",\n            \"address\": \"Avenida Valentim Gentil\",\n            \"number\": \"470\",\n            \"complement\": \"\",\n            \"neighborhood\": \"Butantã\",\n            \"coordinates\": {\n                \"lat\": -23.5658523,\n                \"lng\": -46.7075854\n            },\n            \"timezone\": \"America/Sao_Paulo\",\n            \"amenities\": [\n                {\n                    \"id\": \"oBg**PmN\",\n                    \"name\": \"Estacionamento disponível\",\n                    \"category_name\": \"Estacionamento e Acessibilidade\"\n                },\n                {\n                    \"id\": \"716**k5A\",\n                    \"name\": \"Música ao vivo\",\n                    \"category_name\": \"Estrutura e Ambiente\"\n                },\n                {\n                    \"id\": \"Rt**Z6vL\",\n                    \"name\": \"Opções sem glúten\",\n                    \"category_name\": \"Alimentos e Bebidas\"\n                },\n                ...\n            ],\n            \"reservation\": {\n                \"noshow\": {\n                    \"enabled\": 0,\n                    \"tax\": 10,\n                    \"hours_in_advance\": 120\n                },\n                \"paid_grade_enabled\": true,\n                \"no_show_enabled\": true,\n                \"experiences_enabled\": true,\n                \"cena_experiences_enabled\": true,\n                \"active_experiences\": [\n                    {\n                        \"title\": \"Nome da Experiência\",\n                        \"categories\": [\n                            \"qD6dVPM9\",\n                            \"Vl6y81mD\"\n                        ]\n                    }\n                ]\n            },\n            \"widget_id\": \"868x5J6A\"\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 2,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Sem unidades encontradas:

{\n    \"success\": true,\n    \"data\": [],\n    \"pagination\": {\n        \"total\": 0,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Filter by latitude and longitude

\n","type":"text/plain"},"key":"coordinates","value":""},{"disabled":true,"description":{"content":"

Filter by distance radius (default = 10)

\n","type":"text/plain"},"key":"distance","value":""},{"disabled":true,"description":{"content":"

Filter by no-show availability (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"no_show_enabled","value":"1"},{"disabled":true,"description":{"content":"

Filter by experiences availability (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"experiences_enabled","value":"1"},{"disabled":true,"description":{"content":"

Filter by no-show paid grade (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"paid_grade_enabled","value":"1"},{"disabled":true,"description":{"content":"

Filter by experiences availability on Cena (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"cena_experiences_enabled","value":"1"},{"disabled":true,"description":{"content":"

Filter by experiences category

\n","type":"text/plain"},"key":"experiences_category","value":""},{"disabled":true,"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by unit cuisines (coma separated)

\n","type":"text/plain"},"key":"cuisines","value":""},{"disabled":true,"description":{"content":"

Filter by units (coma separated)

\n","type":"text/plain"},"key":"units","value":""},{"disabled":true,"description":{"content":"

Filter by amenities (coma separated)

\n","type":"text/plain"},"key":"amenities","value":null},{"disabled":true,"description":{"content":"

Filter by occasions (coma separated)

\n","type":"text/plain"},"key":"occasions","value":null}],"variable":[]}},"response":[],"_postman_id":"f16e4254-0c03-45ed-bb5b-b997d43b194a"},{"name":"Retrieve One","id":"2ed26658-c329-4817-bad6-750e2c817c0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/units/:unit_id","description":"

Obter detalhes de uma unidades.

Entrada:

A requisição possui parâmetros obrigatórios na rota, descritos na seção PATH VARIABLES.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de reservas encontradas.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Unidades encontrada:

{\n    \"success\": true,\n    \"data\": {\n        \"id\": \"VPz**DPQ\",\n        \"cuisines\": [\n            {\n                \"id\": \"ld1VQPvB\",\n                \"name\": \"Árabe\",\n                \"slug\": \"arabe\",\n                \"image\": \"https://cdn.gistg.pw/cuisines/arabe-cd888fc16846bd0ee4d6b9b40c45fb6053be2690.jpg\"\n            },\n            {\n                \"id\": \"RLkwa13x\",\n                \"name\": \"Argentina\",\n                \"slug\": \"argentina\",\n                \"image\": \"https://cdn.gistg.pw/cuisines/argentina-18ded1d74d4c3e4b9a62891e14f1f27140f41cf3.jpg\"\n            },\n        ],\n        \"cuisine_name\": \"Árabe\",\n        \"city_slug\": \"sao-paulo\",\n        \"name\": \"Restaurante Homologação\",\n        \"slug\": \"restaurante-homologacao\",\n        \"about\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ultrices turpis odio, ac pretium enim gravida scelerisque. Aliquam arcu arcu.\",\n        \"payment_description\": \"Dinheiro, Cartão de crédito, Sodexo\",\n        \"opening_hours_description\": \"\",\n        \"price_range\": \"$$\",\n        \"price_range_description\": \"de R$61 até R$120\",\n        \"cover_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/f371f553-6899-41d3-b8fa-541e1e55abf3.png\",\n        \"profile_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/9176c3e8-d5c2-44dc-b432-46a7e86e0098.png\",\n        \"photos\": [\n            {\n                \"id\": \"yPA**31z\",\n                \"image\": \"628db6af-bc8c***1770ef2f9058.jpg\",\n                \"unit_id\": \"O6p**ak5\",\n                \"priority\": 1,\n                \"created_at\": \"2023-08-25T18:38:56.000000Z\",\n                \"updated_at\": \"2023-08-25T18:38:56.000000Z\",\n                \"deleted_at\": null\n            }\n        ],\n        \"full_address\": \"Avenida Alpha, 123, Vila Beta, São Paulo-SP\",            \n        \"website\": \"https://restaurante.getin.app\",\n        \"telephone\": \"5500999999999\",\n        \"zipcode\": \"05506070\",\n        \"address\": \"Avenida Valentim Gentil\",\n        \"number\": \"470\",\n        \"complement\": \"\",\n        \"neighborhood\": \"Butantã\",\n        \"coordinates\": {\n            \"lat\": -23.5658523,\n            \"lng\": -46.7075854\n        },\n        \"timezone\": \"America/Sao_Paulo\",\n        \"amenities\": [\n            {\n                \"id\": \"oVPBjPmN\",\n                \"name\": \"Estacionamento disponível\",\n                \"category_name\": \"Estacionamento e Acessibilidade\"\n            },\n            {\n                \"id\": \"7O6pak5E\",\n                \"name\": \"Música ao vivo\",\n                \"category_name\": \"Estrutura e Ambiente\"\n            },\n            {\n                \"id\": \"Re63Z1vL\",\n                \"name\": \"Opções sem glúten\",\n                \"category_name\": \"Alimentos e Bebidas\"\n            },\n            ...\n        ],\n        \"reservation\": {\n            \"noshow\": {\n                \"enabled\": 0,\n                \"tax\": 10,\n                \"hours_in_advance\": 120\n            },\n            \"paid_grade_enabled\": true,\n            \"no_show_enabled\": true,\n            \"experiences_enabled\": true,\n            \"cena_experiences_enabled\": true,\n            \"active_experiences\": [\n                {\n                    \"title\": \"Nome da Experiência\",\n                    \"categories\": [\n                        \"qD6dVPM9\",\n                        \"Vl6y81mD\"\n                    ]\n                }\n            ]\n        },\n        \"widget_id\": \"868x5J6A\"\n    }\n}\n\n

Unidade não encontrada ou problema na identificação/autorização da credencial:

{\n    \"success\": false,\n    \"message\": \"Seu acesso a este recurso foi bloqueado.\"\n}\n\n

Id da unidade a ser pesquisada.\nTipo: String(8)

\n","type":"text/plain"},"type":"any","value":"{{unit_id}}","key":"unit_id"}]}},"response":[],"_postman_id":"2ed26658-c329-4817-bad6-750e2c817c0e"},{"name":"Reservation Available","id":"c45a7557-8767-448f-ac63-285a7dfc605f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/units/reservation","description":"

Obter a lista de unidades que tem disponibilidade de reserva com os parametros informados.

Entrada:

É possível definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Além dos filtros expecíficos para essa rota, todos os filtros do endpoint Units/Retrieve All

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de reservas encontradas.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Com unidades encontradas:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"VPz**DPQ\",\n            \"cuisines\": [\n                {\n                    \"id\": \"ld1VQPvB\",\n                    \"name\": \"Árabe\",\n                    \"slug\": \"arabe\",\n                    \"image\": \"https://cdn.gistg.pw/cuisines/arabe-cd888fc16846bd0ee4d6b9b40c45fb6053be2690.jpg\"\n                },\n                {\n                    \"id\": \"RLkwa13x\",\n                    \"name\": \"Argentina\",\n                    \"slug\": \"argentina\",\n                    \"image\": \"https://cdn.gistg.pw/cuisines/argentina-18ded1d74d4c3e4b9a62891e14f1f27140f41cf3.jpg\"\n                },\n            ],\n            \"cuisine_name\": \"Árabe\",\n            \"city_slug\": \"sao-paulo\",\n            \"name\": \"Restaurante Homologação\",\n            \"slug\": \"restaurante-homologacao\",\n            \"about\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ultrices turpis odio, ac pretium enim gravida scelerisque. Aliquam arcu arcu.\",\n            \"payment_description\": \"Dinheiro, Cartão de crédito, Sodexo\",\n            \"opening_hours_description\": \"\",\n            \"price_range\": \"$$\",\n            \"price_range_description\": \"de R$61 até R$120\",\n            \"cover_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/f371f553-6899-41d3-b8fa-541e1e55abf3.png\",\n            \"profile_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/9176c3e8-d5c2-44dc-b432-46a7e86e0098.png\",\n            \"photos\": [\n                {\n                    \"id\": \"yPA**31z\",\n                    \"image\": \"628db6af-bc8c***1770ef2f9058.jpg\",\n                    \"unit_id\": \"O6p**ak5\",\n                    \"priority\": 1,\n                    \"created_at\": \"2023-08-25T18:38:56.000000Z\",\n                    \"updated_at\": \"2023-08-25T18:38:56.000000Z\",\n                    \"deleted_at\": null\n                }\n            ],\n            \"full_address\": \"Avenida Alpha, 123, Vila Beta, São Paulo-SP\",            \n            \"website\": \"https://restaurante.getin.app\",\n            \"telephone\": \"5500999999999\",\n            \"zipcode\": \"05506070\",\n            \"address\": \"Avenida Valentim Gentil\",\n            \"number\": \"470\",\n            \"complement\": \"\",\n            \"neighborhood\": \"Butantã\",\n            \"coordinates\": {\n                \"lat\": -23.5658523,\n                \"lng\": -46.7075854\n            },\n            \"timezone\": \"America/Sao_Paulo\",\n            \"amenities\": [\n                {\n                    \"id\": \"oBg**PmN\",\n                    \"name\": \"Estacionamento disponível\",\n                    \"category_name\": \"Estacionamento e Acessibilidade\"\n                },\n                {\n                    \"id\": \"716**k5A\",\n                    \"name\": \"Música ao vivo\",\n                    \"category_name\": \"Estrutura e Ambiente\"\n                },\n                {\n                    \"id\": \"Rt**Z6vL\",\n                    \"name\": \"Opções sem glúten\",\n                    \"category_name\": \"Alimentos e Bebidas\"\n                },\n                ...\n            ],\n            \"reservation\": {\n                \"noshow\": {\n                    \"enabled\": 0,\n                    \"tax\": 10,\n                    \"hours_in_advance\": 120\n                },\n                \"paid_grade_enabled\": true,\n                \"no_show_enabled\": true,\n                \"experiences_enabled\": true,\n                \"cena_experiences_enabled\": true,\n                \"active_experiences\": [\n                    {\n                        \"title\": \"Nome da Experiência\",\n                        \"categories\": [\n                            \"qD6dVPM9\",\n                            \"Vl6y81mD\"\n                        ]\n                    }\n                ]\n            },\n            \"widget_id\": \"868x5J6A\"\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 2,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Sem unidades encontradas:

{\n    \"success\": true,\n    \"data\": [],\n    \"pagination\": {\n        \"total\": 0,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Filter by latitude and longitude (latitude, longitude)

\n","type":"text/plain"},"key":"coordinates","value":""},{"disabled":true,"description":{"content":"

Filter by distance radius (default = 10)

\n","type":"text/plain"},"key":"distance","value":""},{"disabled":true,"description":{"content":"

Data a qual será consultada a disponibilidade\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"date","value":""},{"disabled":true,"description":{"content":"

Hora na qual será consultada a disponibilidade.\nTipo: Time\nPadrão HH:MM (Ex: 12:00)

\n","type":"text/plain"},"key":"hour","value":""},{"disabled":true,"description":{"content":"

Número de pessoas referente a pesquisa de disponibilidade.\nTipo: Integer

\n","type":"text/plain"},"key":"people","value":""},{"disabled":true,"description":{"content":"

Filter by unit name

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by no-show availability (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"no_show_enabled","value":""},{"disabled":true,"description":{"content":"

Filter by experiences availability (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"experiences_enabled","value":""},{"disabled":true,"description":{"content":"

Filter by no-show paid grade (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"paid_grade_enabled","value":""},{"disabled":true,"description":{"content":"

Filter by experiences availability on Cena (enabled: 1|disabled=0)

\n","type":"text/plain"},"key":"cena_experiences_enabled","value":""},{"disabled":true,"description":{"content":"

Filter by experiences category

\n","type":"text/plain"},"key":"experiences_category","value":""},{"disabled":true,"key":"per_page","value":""},{"disabled":true,"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"c45a7557-8767-448f-ac63-285a7dfc605f"}],"id":"d05b545b-4d14-446f-8c09-982df7cb00d3","description":"

Endpoints para obtenção de informações referentes às unidades disponíveis ao acesso da credencial de API

\n","_postman_id":"d05b545b-4d14-446f-8c09-982df7cb00d3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Cuisines","item":[{"name":"Retrieve All","event":[{"listen":"test","script":{"id":"6c2310fc-2ee1-477a-b37b-b5bcd36a8f89","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"unit_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a5eeacaa-bea0-424d-b25a-943d0a4a0436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/cuisines","description":"

Obter a lista de cozinhas disponíveis.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de cozinhas encontradas.

Ex:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"oVPBjPmN\",\n            \"name\": \"Alemã\",\n            \"slug\": \"alema\",\n            \"image\": \"https://images.getinapp.com.br/cuisines/89fe5c8940dfeef187427667d78d535c850da8d0.jpg\"\n        }\n    ],\n    \"pagination\": {\n        \"total\": 1,\n        \"current_page\": 1,\n        \"next_page\": 1,\n        \"last_page\": 1,\n        \"per_page\": 1,\n        \"is_last_page\": true\n    }\n}\n\n

Endpoints para obtenção da lista de tipos de cozinha disponíveis para a segmentação/filtro de unidades

\n","_postman_id":"5ad8449b-e61a-4e7c-9a5a-9b0f2141933e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Amenities Categories","item":[{"name":"Retrieve All","event":[{"listen":"test","script":{"id":"6c2310fc-2ee1-477a-b37b-b5bcd36a8f89","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"unit_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"afe38295-3c03-429e-89f9-4e6d0eaac425","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/amenities-categories","description":"

Obter a lista de categorias de facilidades disponíveis.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de cozinhas encontradas.

Ex:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"XX9XX9XX\",\n            \"name\": \"Estacionamento e Acessibilidade\",\n            \"slug\": \"estacionamento-e-acessibilidade\"\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 3,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Endpoints para obtenção da lista de categorias disponíveis para a segmentação/filtro de facilidades

\n","_postman_id":"a98bfa98-0aae-4b97-a329-812fc199f122","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Amenities","item":[{"name":"Retrieve All","event":[{"listen":"test","script":{"id":"6c2310fc-2ee1-477a-b37b-b5bcd36a8f89","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"unit_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"af8e0ba8-6d61-4b42-bc76-d97a6f7cc3b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/amenities","description":"

Obter a lista de facilidades disponíveis.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de cozinhas encontradas.

Ex:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"XX9XX9XX\",\n            \"name\": \"Estacionamento disponível\",\n            \"icon\": \"car-front\",\n            \"category_id\": \"XX9XX9XX\",\n            \"category_name\": \"Estacionamento e Acessibilidade\"\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 14,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Endpoints para obtenção da lista de facilidades disponíveis para a segmentação/filtro de unidades

\n","_postman_id":"4ed610a7-f4f4-40e9-b960-5716587777bd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Occasions","item":[{"name":"Retrieve All","event":[{"listen":"test","script":{"id":"6c2310fc-2ee1-477a-b37b-b5bcd36a8f89","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"unit_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7233df01-0ecb-4faf-afbe-dae9c57233f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/occasions","description":"

Obter a lista de ocasiões disponíveis.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de cozinhas encontradas.

Ex:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"XX9XX9XX\",\n            \"name\": \"Jantar a dois\",\n            \"slug\": \"romantic_dinner\",\n            \"image\": \"https://images.getinapp.com.br/occasions/71d7fb4d-c5...da-79d4b055b2a7.png\"\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 5,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Endpoints para obtenção da lista de ocasiões disponíveis para a segmentação/filtro de unidades

\n","_postman_id":"14887818-73c0-45b8-8fb5-9b62a247b446","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Schedules","item":[{"name":"Retrieve Table Availability By Unit","event":[{"listen":"test","script":{"id":"82710c5b-eae2-4db1-8e0f-ec110553bf28","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"schedule_availability_people\", jsonData.data[0]);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"637c988f-c7f7-4fae-9148-586402d95803","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/schedules/units/:unit_id/table-availability","description":"

Obter a disponibilidade mesas baseado no número de pessoas.

Entrada:

A requisição possui parâmetros obrigatórios na rota, descritos na seção PATH VARIABLES.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Lista com as opções disponíveis baseado no número de pessoas por mesa.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Disponibilidade encontrada:

{\n    \"success\": true,\n    \"data\": [\n        1,\n        2,\n        4,\n        6,\n        ...\n    ]\n}\n\n

Disponibilidade não encontrada:

{\n    \"success\": true,\n    \"data\": []\n}\n\n

Erro de entrada de dados:

{\n    \"success\": false,\n    \"message\": \"Seu acesso a este recurso foi bloqueado.\"\n}\n\n

Id da unidade a ser pesquisada.\nTipo: String(8)

\n","type":"text/plain"},"type":"any","value":"{{unit_id}}","key":"unit_id"}]}},"response":[],"_postman_id":"637c988f-c7f7-4fae-9148-586402d95803"},{"name":"Retrieve Date Availability By Unit","event":[{"listen":"test","script":{"id":"82710c5b-eae2-4db1-8e0f-ec110553bf28","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"schedule_availability_date\", jsonData.data[0]);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"32f4dd17-36f5-4d98-a918-86993244f883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/schedules/units/:unit_id/date-availability?people={{schedule_availability_people}}","description":"

Obter a disponibilidade de datas disponíveis para reservas para uma mesa com determinado número de pessoas.

Entrada:

A requisição possui parâmetros obrigatórios na rota, descritos na seção PATH VARIABLES.

É obrigatório definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a estrutura de grade horária encontrada. Este valor é segmentado por estabelecimento.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Disponibilidade encontrada:

{\n    \"success\": true,\n    \"data\": [\n        \"2026-02-01\",\n        \"2026-02-02\",\n        \"2026-02-03\",\n        \"2026-02-08\",\n        \"2026-02-09\",\n        \"2026-02-10\",\n        ...\n    ]\n}\n\n

Disponibilidade não encontrada:

{\n    \"success\": true,\n    \"data\": []\n}\n\n

Erro de entrada de dados:

{\n    \"success\": false,\n    \"errors\": {\n        \"people\": [\n            \"O campo people é obrigatório.\"\n        ]\n    }\n}\n\n

Número de pessoas referente a pesquisa de disponibilidade.\nTipo: Integer

\n","type":"text/plain"},"key":"people","value":"{{schedule_availability_people}}"},{"disabled":true,"description":{"content":"

Quantidade de dias seguintes disponíveis na grade a ser retornado.

O Limite de dias à frente é 30

** Caso seja informado um valor maior que o configurado pela unidade, será considerado o valor configurado da unidade.

\n","type":"text/plain"},"key":"days_in_advance","value":"{{schedule_availability_days_in_advance}}"}],"variable":[{"type":"any","value":"{{unit_id}}","key":"unit_id"}]}},"response":[],"_postman_id":"32f4dd17-36f5-4d98-a918-86993244f883"},{"name":"Retrieve Schedule Availability","event":[{"listen":"test","script":{"id":"82710c5b-eae2-4db1-8e0f-ec110553bf28","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"unit_id\", jsonData.data[0].id);",""," if (jsonData.data[0].schedules.length > 0) {"," pm.environment.set(\"sector_id\", jsonData.data[0].schedules[0].sector_id);"," pm.environment.set(\"people\", jsonData.data[0].schedules[0].people);"," pm.environment.set(\"table_people\", jsonData.data[0].people);"," pm.environment.set(\"date\", pm.request.url.query.get('date') || null);"," pm.environment.set(\"time\", jsonData.data[0].schedules[0].hour);"," pm.environment.set(\"discount\", jsonData.data[0].schedules[0].discount);"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a6f5e21a-5cda-45c6-babd-d6883bc38056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/schedules/units?people={{schedule_availability_people}}&date={{schedule_availability_date}}","description":"

Obter a disponibilidade geral* de horários para reservas.

*caso a credencial possua visibilidade de múltiplas unidades.

Entrada:

É obrigatório definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a estrutura de grade horária encontrada. Este valor é segmentado por estabelecimento.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Disponibilidade encontrada:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"M0mFWg63\",\n            \"name\": \"Unidade 1\",\n            \"schedules\": [\n                {\n                    \"hour\": \"12:00\",\n                    \"people\": 2,\n                    \"sector_id\": \"VPj2LSPQ\",\n                    \"sector_name\": \"Salão A\",\n                    \"discount\": 0\n                },\n                {\n                    \"hour\": \"12:00\",\n                    \"people\": 2,\n                    \"sector_id\": \"J8kyW3PO\",\n                    \"sector_name\": \"Salão B\",\n                    \"discount\": 0\n                },\n                ...\n            ]\n        },\n        {\n            \"id\": \"Kdm4Wq82\",\n            \"name\": \"Unidade 2\",\n            \"schedules\": [\n                {\n                    \"hour\": \"12:00\",\n                    \"people\": 2,\n                    \"sector_id\": \"LLz2NOGQ\",\n                    \"sector_name\": \"Salão A\",\n                    \"discount\": 0\n                },\n                ...\n            ]\n        },\n        ...\n    ]\n}\n\n

Disponibilidade não encontrada:

{\n    \"success\": true,\n    \"data\": []\n}\n\n

Erro de entrada de dados:

{\n    \"success\": false,\n    \"errors\": {\n        \"people\": [\n            \"O campo people é obrigatório.\"\n        ],\n        \"date\": [\n            \"O campo date é obrigatório.\"\n        ]\n    }\n}\n\n

Número de pessoas referente a pesquisa de disponibilidade.\nTipo: Integer

\n","type":"text/plain"},"key":"people","value":"{{schedule_availability_people}}"},{"description":{"content":"

Data a qual será consultada a disponibilidade\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"date","value":"{{schedule_availability_date}}"},{"disabled":true,"description":{"content":"

Hora na qual será consultada a disponibilidade.\nTipo: Time\nPadrão HH:MM (Ex: 12:00)

\n","type":"text/plain"},"key":"hour","value":"{{schedule_availability_hour}}"}],"variable":[]}},"response":[],"_postman_id":"a6f5e21a-5cda-45c6-babd-d6883bc38056"},{"name":"Retrieve Schedule Availability By Unit","event":[{"listen":"test","script":{"id":"82710c5b-eae2-4db1-8e0f-ec110553bf28","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"sector_id\", jsonData.data[0].sector_id);"," pm.environment.set(\"people\", jsonData.data[0].people);"," pm.environment.set(\"table_people\", jsonData.data[0].people);"," pm.environment.set(\"date\", pm.request.url.query.get('date') || null);"," pm.environment.set(\"time\", jsonData.data[0].hour);"," pm.environment.set(\"discount\", jsonData.data[0].discount || 0);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"03680f8c-a52d-47fd-9858-930973ba9cc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/schedules/units/:unit_id?people={{schedule_availability_people}}&date={{schedule_availability_date}}","description":"

Obter a disponibilidade de horários para reservas em uma unidade.

Entrada:

A requisição possui parâmetros obrigatórios na rota, descritos na seção PATH VARIABLES.

É obrigatório definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a estrutura de grade horária encontrada. Este valor é segmentado por estabelecimento.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Disponibilidade encontrada:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"hour\": \"12:00\",\n            \"people\": 2,\n            \"sector_id\": \"J1bqDWPO\",\n            \"sector_name\": \"Salão 01\",\n            \"discount\": 0,\n            \"flexible\": false\n        }\n        ...\n    ]\n}\n\n

Disponibilidade não encontrada:

{\n    \"success\": true,\n    \"data\": []\n}\n\n

Erro de entrada de dados:

{\n    \"success\": false,\n    \"errors\": {\n        \"people\": [\n            \"O campo people é obrigatório.\"\n        ],\n        \"date\": [\n            \"O campo date é obrigatório.\"\n        ]\n    }\n}\n\n

Número de pessoas referente a pesquisa de disponibilidade.\nTipo: Integer

\n","type":"text/plain"},"key":"people","value":"{{schedule_availability_people}}"},{"description":{"content":"

Data a qual será consultada a disponibilidade\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"date","value":"{{schedule_availability_date}}"},{"disabled":true,"description":{"content":"

Hora na qual será consultada a disponibilidade.\nTipo: Time\nPadrão HH:MM (Ex: 12:00)

\n","type":"text/plain"},"key":"hour","value":"{{schedule_availability_hour}}"}],"variable":[{"type":"any","value":"{{unit_id}}","key":"unit_id"}]}},"response":[],"_postman_id":"03680f8c-a52d-47fd-9858-930973ba9cc5"}],"id":"d4f57949-6406-4df2-9c57-30beace956b9","description":"

Endpoints para obtenção de informações referentes à grade horária e disponibilidade configurada pelo restaurante.

\n","_postman_id":"d4f57949-6406-4df2-9c57-30beace956b9","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Reservation Settings","item":[{"name":"Retrieve One","id":"e72c6af8-2834-4791-9e9f-05a20a4d3c42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/reservations/units/:unit_id/settings","description":"

Obter algumas das configurações atuais da reserva para o restaurante.

Entrada:

A requisição possui parâmetros obrigatórios na rota, descritos na seção PATH VARIABLES.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

sucess: Valor booleano indicando sucesso ou falha no processo de autenticação.

data: Lista de campos de configuração e campo indicando a data da última atualização (descrição dos campos abaixo).

message: Mensagem de erro para casos de falha na requisição ou recurso não encontrado (retornado quando _success = false_.

Descrição dos campos de configuração:

unit_id: ID da unidade consultada.
enabled: Campo booleano indicando se o módulo de reserva está ativo no restaurante.
days_in_advance: Números de dias à frente que o restaurante define para disponibilidade a grade horária.
tolerance: Quantidade de minutos aceitos para atraso no comparecimento da reserva.
conditions: Texto de regras e condições definido pelo restaurante para ciência do consumidor ao reservar.
additional_information: Texto para descrição e informações extras para ciência do consumidor ao reservar.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}},"urlObject":{"path":["apis","v2","reservations","units",":unit_id","settings"],"host":["https://sandbox.getinapis.com"],"query":[],"variable":[{"type":"any","value":"{{unit_id}}","key":"unit_id"}]}},"response":[],"_postman_id":"e72c6af8-2834-4791-9e9f-05a20a4d3c42"}],"id":"2db1f80d-44c6-4661-8f2c-89f779c94ac0","_postman_id":"2db1f80d-44c6-4661-8f2c-89f779c94ac0","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}}},{"name":"Reservations","item":[{"name":"Create","event":[{"listen":"test","script":{"id":"e4dc8b65-c7d6-4ca5-8ed4-dddae7d5d424","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.success && jsonData.data.id) {"," pm.environment.set(\"reservation_id\", jsonData.data.id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1962196a-64d6-4d16-adcc-c0d5f996eea0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"unit_id\": \"{{unit_id}}\",\n \"sector_id\": \"{{sector_id}}\",\n \"name\": \"John Doe\",\n \"mobile\": \"5500999999999\",\n \"email\": \"johndoe@getinapp.com.br\",\n \"people\": {{people}},\n \"table_people\": {{table_people}},\n \"date\": \"{{date}}\",\n \"time\": \"{{time}}\",\n \"info\": \"Se possível, gostaria de mesa virada para a varanda\",\n \"discount\": \"{{discount}}\",\n \"highlighted\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.getinapis.com/apis/v2/reservations","description":"

Criar uma reserva de mesa.

Entrada:

É obrigatório enviar alguns campos à requisição por meio de parâmetros no body, listados abaixo, seguindo o padrão JSON.

unit_id
\n
sector_id
\n
name
\n
people
\n
table_people
\n
date
\n
time
\n

{\n    \"unit_id\": \"Rj4**HnK\",\n    \"sector_id\": \"JKu**yUh\",\n    \"name\": \"John Doe\",\n    \"mobile\": \"5500996308709\",\n    \"email\": \"johndoe@getinapp.com.br\",\n    \"people\": 2,\n    \"table_people\": 2,\n    \"date\": \"2026-01-01\",\n    \"time\": \"12:00\",\n    \"info\": \"Se possível, gostaria de mesa virada para a varanda\",\n    \"discount\": 0,\n    \"highlighted\": false\n}\n\n

Saída:

O response será enviado no padrão JSON, conforme abaixo:

status: Valor booleano indicando sucesso ou falha no processo de autenticação.

data: Conteúdo referente ao token de acesso do usuário para casos de sucesso na autenticação.

message: Mensagem de erro para casos de falha na autenticação.

Ex:

Reserva criada com sucesso:

{\n    \"data\": {\n        \"id\": \"62E**wl1\",\n        \"sector\": {\n            \"id\": \"91a**OPv\",\n            \"name\": \"Salão Principal\"\n        },\n        \"unit\": {\n            \"id\": \"VPz**DPQ\",\n            \"name\": \"Restaurante - Homologação\",\n            \"cover_image\": \"https://cdn.gistg.pw/1faecc4f-****-d4e49ba20f5d.png\",\n            \"profile_image\": \"https://cdn.gistg.pw/151d05d2-****-632c7e7f7c3f.jpg\",\n            \"photos\": [],\n            \"full_address\": \"Avenida Valentim Gentil, 470, Butantã, São Paulo-SP\",\n            \"cuisine_name\": \"\",\n            \"city_name\": \"São Paulo\"\n        },\n        \"name\": \"Ricardo Soares\",\n        \"people\": 1,\n        \"date\": \"2026-02-01\",\n        \"time\": \"08:00\",\n        \"discount\": 0,\n        \"confirmation_sent\": false,\n        \"status\": \"pending\",\n        \"info\": \"Reserva criada via Postman\",\n        \"mobile\": \"5511996308709\",\n        \"email\": \"ricardo@getinapp.com.br\",\n        \"custom_fields\": [],\n        \"monetize\": null\n    },\n    \"success\": true\n}\n\n

Erro ao criar reserva ou problema na identificação/autorização da credencial::

{\n    \"success\": false,\n    \"message\": \"Ocorreu um erro com sua requisição.\"\n}\n\n

Erro de entrada de dados:

{\n    \"success\": false,\n    \"errors\": {\n        \"date\": [\n            \"O campo date é obrigatório.\"\n        ],\n        \"time\": [\n            \"O campo time é obrigatório.\"\n        ]\n    }\n}\n\n

{\n    \"success\": false,\n    \"errors\": {\n        \"date\": [\n            \"O horário escolhido não está mais disponível.\"\n        ]\n    }\n}\n\n

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apiKey"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","id":"af932e28-8e2d-4fcc-8200-f6d91f2392d5","name":"v2","type":"folder"}},"urlObject":{"path":["apis","v2","reservations"],"host":["https://sandbox.getinapis.com"],"query":[],"variable":[]}},"response":[{"id":"ed1ce332-6107-449c-a1f2-2588a8fa8da0","name":"Reserve","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"unit_id\": \"{{unit_id}}\",\n \"sector_id\": \"{{sector_id}}\",\n \"name\": \"Full Name\",\n \"mobile\": \"+5511996308709\",\n \"email\": \"email-example@domain.com\",\n \"people\": \"{{people}}\",\n \"table_people\": \"{{table_people}}\",\n \"date\": \"{{date}}\",\n \"time\": \"{{time}}\",\n \"info\": \"Table overlooking the garden.\",\n \"discount\": \"{{discount}}\",\n \"highlighted\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.getinapis.com/apis/v2/reservations"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"c49bda0f-c587-4a77-a1dc-024ec530d746","name":"Reserve - Custom Fields","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"unit_id\": \"{{unit_id}}\",\n \"sector_id\": \"{{sector_id}}\",\n \"name\": \"Full Name\",\n \"mobile\": \"+5511996308709\",\n \"email\": \"email-example@domain.com\",\n \"people\": \"{{people}}\",\n \"table_people\": \"{{table_people}}\",\n \"date\": \"{{date}}\",\n \"time\": \"{{time}}\",\n \"info\": \"Table overlooking the garden.\",\n \"discount\": \"{{discount}}\",\n \"highlighted\": false,\n \"custom_fields\": {\n \"Re63241v\": \"Cerveja\",\n \"KZ6RBE6L\": \"DESCONTO10\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox.getinapis.com/apis/v2/reservations"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1962196a-64d6-4d16-adcc-c0d5f996eea0"},{"name":"Retrieve All","event":[{"listen":"test","script":{"id":"7d9f475e-0ce7-423a-9900-d35b20d0538b","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"reservation_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"125ef42d-2806-4c68-85d7-cdd6584c0fd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/reservations?date=2026-07-08&sort=date:desc","description":"

Obter a lista de reservas efetuadas.

Entrada:

É obrigatório definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de reservas encontradas.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Com reservas encontradas:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"D6dEnQkM\",\n            \"sector\": {\n                \"id\": \"46l3xj1Z\",\n                \"name\": \"Salão Principal\"\n            },\n            \"unit\": {\n                \"id\": \"O6pawak5\",\n                \"name\": \"Restaurante - Homologação\",\n                \"cover_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/f371f553-6899-41d3-b8fa-541e1e55abf3.png\",\n                \"profile_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/9176c3e8-d5c2-44dc-b432-46a7e86e0098.png\",\n                \"photos\": [\n                    {\n                        \"id\": \"yPAXX31z\",\n                        \"image\": \"628db6af-bc8c...1770ef2f9058.jpg\",\n                        \"unit_id\": \"O6pawak5\",\n                        \"priority\": 1,\n                        \"created_at\": \"2023-08-25T18:38:56.000000Z\",\n                        \"updated_at\": \"2023-08-25T18:38:56.000000Z\",\n                        \"deleted_at\": null\n                    }\n                ],\n                \"full_address\": \"Avenida Alpha, 123, Vila Beta, São Paulo-SP\",\n                \"cuisine_name\": \"Brasileira\",\n                \"city_name\": \"São Paulo\"\n            },\n            \"name\": \"John Doe\",\n            \"mobile\": \"5511987654321\",\n            \"email\": \"john.doe@getinapp.com.br\",\n            \"people\": 2,\n            \"date\": \"2026-10-07\",\n            \"time\": \"14:00\",\n            \"info\": \"Se possível, uma mesa virada para o jardim\",\n            \"zipcode\": \"98765-123\",\n            \"occasion\": \"Jantar a dois\",\n            \"birthdate\": \"1970-01-01\",\n            \"promocode\": \"SAVE10\",\n            \"taxpayer_identification\": \"999.999.999-15\",\n            \"custom_fields\": [\n                {\n                    \"id\": \"80k**X6W\",\n                    \"title\": \"Campo 1\",\n                    \"answer\": \"-\"\n                }\n            ],\n            \"discount\": 0,\n            \"confirmation_sent\": false,\n            \"status\": \"confirmed\",\n            \"monetize\": null //Não aplicável em contexto de Get In API\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 98,\n        \"current_page\": 1,\n        \"next_page\": 2,\n        \"last_page\": 7,\n        \"per_page\": 15,\n        \"is_last_page\": false\n    }\n}\n\n

Sem reservas encontradas:

{\n    \"success\": true,\n    \"data\": [],\n    \"pagination\": {\n        \"total\": 0,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Estabelecimento específico a ser consultado.\nTipo: Texto(8)

\n","type":"text/plain"},"key":"unit_id","value":""},{"disabled":true,"description":{"content":"

Dado de contato presente na reserva (Nome, E-mail, Telefone).\nTipo: Texto\nFormato: email@domain.com|5500999999999|José

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Número de telefone específico a ser consultado.\nTipo: Texto

\n","type":"text/plain"},"key":"mobile","value":""},{"disabled":true,"description":{"content":"

Endereço de e-mail específico a ser consultado.\nTipo: Texto

\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"

Data a qual será consultada a disponibilidade.\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"date","value":"2026-07-08"},{"disabled":true,"description":{"content":"

Data inicial do período no qual será consultada a disponibilidade.\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"start_date","value":"2026-09-01"},{"disabled":true,"description":{"content":"

Data final do período no qual será consultada a disponibilidade.\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"end_date","value":"2026-10-07"},{"disabled":true,"description":{"content":"

Status específico a ser consultado.\nTipo: Texto\nValores possíveis: PENDING|CONFIRMED|CANCELED-USER|CANCELED-AGENT

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Salão específico a ser consultado.\nTipo: Texto(8)

\n","type":"text/plain"},"key":"sector_id","value":""},{"description":{"content":"

Campo a ser considerado para a ordenação do resultado.\nTipo: Texto\nEx: field:direction\nObs: Poderá ser usado de forma composta. Ex: field1:direction,field2:direction,...

\n","type":"text/plain"},"key":"sort","value":"date:desc"},{"disabled":true,"description":{"content":"

Informação da página a ser considerada para o retorno dos resultados\nTipo: Inteiro

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"125ef42d-2806-4c68-85d7-cdd6584c0fd7"},{"name":"Retrieve Next","event":[{"listen":"test","script":{"id":"7d9f475e-0ce7-423a-9900-d35b20d0538b","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"reservation_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"76f74120-3c7c-4b8e-a350-5e773c75f830","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/reservations/next?unit_id={{unit_id}}&mobile=5511996308709&sort=date:desc,status:asc","description":"

Obter a lista de reservas futuras.

Regra pré-estabelecida::

Reservas com data igual ou superior a data atual (pendentes e confirmadas)

Entrada:

É obrigatório definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de reservas encontradas.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Com reservas encontradas:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"D6d**QkM\",\n            \"sector\": {\n                \"id\": \"46l**j1Z\",\n                \"name\": \"Salão Principal\"\n            },\n            \"unit\": {\n                \"id\": \"O6p**ak5\",\n                \"name\": \"Restaurante - Homologação\",\n                \"cover_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/f371f553-6899-41d3-b8fa-541e1e55abf3.png\",\n                \"profile_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/9176c3e8-d5c2-44dc-b432-46a7e86e0098.png\",\n                \"photos\": [\n                    {\n                        \"id\": \"yPA**31z\",\n                        \"image\": \"628db6af-bc8c***1770ef2f9058.jpg\",\n                        \"unit_id\": \"O6p**ak5\",\n                        \"priority\": 1,\n                        \"created_at\": \"2023-08-25T18:38:56.000000Z\",\n                        \"updated_at\": \"2023-08-25T18:38:56.000000Z\",\n                        \"deleted_at\": null\n                    }\n                ],\n                \"full_address\": \"Avenida Alpha, 123, Vila Beta, São Paulo-SP\",\n                \"cuisine_name\": \"Brasileira\",\n                \"city_name\": \"São Paulo\"\n            },\n            \"name\": \"John Doe\",\n            \"mobile\": \"5511987654321\",\n            \"email\": \"john.doe@getinapp.com.br\",\n            \"people\": 2,\n            \"date\": \"2026-10-07\",\n            \"time\": \"14:00\",\n            \"info\": \"Se possível, uma mesa virada para o jardim\",\n            \"zipcode\": \"98765-123\",\n            \"occasion\": \"Jantar a dois\",\n            \"birthdate\": \"1970-01-01\",\n            \"promocode\": \"SAVE10\",\n            \"taxpayer_identification\": \"999.999.999-15\",\n            \"custom_fields\": [\n                {\n                    \"id\": \"80k**X6W\",\n                    \"title\": \"Campo 1\",\n                    \"answer\": \"-\"\n                }\n            ],\n            \"discount\": 0,\n            \"confirmation_sent\": false,\n            \"status\": \"confirmed\",\n            \"monetize\": null //Não aplicável em contexto de Get In API\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 98,\n        \"current_page\": 1,\n        \"next_page\": 2,\n        \"last_page\": 7,\n        \"per_page\": 15,\n        \"is_last_page\": false\n    }\n}\n\n

Sem reservas encontradas:

{\n    \"success\": true,\n    \"data\": [],\n    \"pagination\": {\n        \"total\": 0,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Estabelecimento específico a ser consultado.\nTipo: Texto(8)

\n","type":"text/plain"},"key":"unit_id","value":"{{unit_id}}"},{"description":{"content":"

Número de telefone específico a ser consultado.\nTipo: Texto

\n","type":"text/plain"},"key":"mobile","value":"5511996308709"},{"disabled":true,"description":{"content":"

Endereço de e-mail específico a ser consultado.\nTipo: Texto

\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"

Data inicial do período no qual será consultada a disponibilidade.\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Data final do período no qual será consultada a disponibilidade.\nTipo: Date\nFormato: AAAA-MM-DD (Ex: 2024-02-10)

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Status específico a ser consultado.\nTipo: Texto\nValores possíveis: PENDING|CONFIRMED|CANCELED-USER|CANCELED-AGENT

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

Campo a ser considerado para a ordenação do resultado.\nTipo: Texto\nEx: field:direction\nObs: Poderá ser usado de forma composta. Ex: field1:direction,field2:direction,...

\n","type":"text/plain"},"key":"sort","value":"date:desc,status:asc"},{"disabled":true,"description":{"content":"

Direção a ser considerada para a ordenação do resultado (ascendente ou decrescente).\nTipo: Texto\nValores aceitos: ASC|DESC\nObs: Poderá ser usado de forma composta. Ex: desc,asc,...

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[],"_postman_id":"76f74120-3c7c-4b8e-a350-5e773c75f830"},{"name":"Retrieve History","event":[{"listen":"test","script":{"id":"7d9f475e-0ce7-423a-9900-d35b20d0538b","exec":["var jsonData = JSON.parse(pm.response.text());","","if (jsonData.data && jsonData.data.length > 0) {"," pm.environment.set(\"reservation_id\", jsonData.data[0].id);","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"28f0e257-3408-473d-8768-2110249eb241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox.getinapis.com/apis/v2/reservations/history","description":"

Obter a lista de histórico de reservas.

Regras pré-estabelecidas:

Reservas com data igual ou superior a data atual (canceladas)
\n
Reservas com data anterior a data atual (todos os status)
\n

Entrada:

É obrigatório definir filtro(s) à requisição por meio de parâmetros query string, descritos na seção PARAMS.

Saída:

O response será enviado no padrão JSON, conforme abaixo:

success: Valor booleano indicando sucesso ou falha na requisição.

data: Conteúdo referente a lista de reservas encontradas.

errors: Coleção de mensagens de erro para casos de erros de validação de entrada.

Ex:

Com reservas encontradas:

{\n    \"success\": true,\n    \"data\": [\n        {\n            \"id\": \"D6dEnQkM\",\n            \"sector\": {\n                \"id\": \"46l3xj1Z\",\n                \"name\": \"Salão Principal\"\n            },\n            \"unit\": {\n                \"id\": \"O6pawak5\",\n                \"name\": \"Restaurante - Homologação\",\n                \"cover_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/f371f553-6899-41d3-b8fa-541e1e55abf3.png\",\n                \"profile_image\": \"https://s3.sa-east-1.amazonaws.com/cdn.gistg.pw/9176c3e8-d5c2-44dc-b432-46a7e86e0098.png\",\n                \"photos\": [\n                    {\n                        \"id\": \"yPAXX31z\",\n                        \"image\": \"628db6af-bc8c...1770ef2f9058.jpg\",\n                        \"unit_id\": \"O6pawak5\",\n                        \"priority\": 1,\n                        \"created_at\": \"2023-08-25T18:38:56.000000Z\",\n                        \"updated_at\": \"2023-08-25T18:38:56.000000Z\",\n                        \"deleted_at\": null\n                    }\n                ],\n                \"full_address\": \"Avenida Alpha, 123, Vila Beta, São Paulo-SP\",\n                \"cuisine_name\": \"Brasileira\",\n                \"city_name\": \"São Paulo\"\n            },\n            \"name\": \"John Doe\",\n            \"mobile\": \"5511987654321\",\n            \"email\": \"john.doe@getinapp.com.br\",\n            \"people\": 2,\n            \"date\": \"2026-10-07\",\n            \"time\": \"14:00\",\n            \"info\": \"Se possível, uma mesa virada para o jardim\",\n            \"zipcode\": \"98765-123\",\n            \"occasion\": \"Jantar a dois\",\n            \"birthdate\": \"1970-01-01\",\n            \"promocode\": \"SAVE10\",\n            \"taxpayer_identification\": \"999.999.999-15\",\n            \"custom_fields\": [\n                {\n                    \"id\": \"80k**X6W\",\n                    \"title\": \"Campo 1\",\n                    \"answer\": \"-\"\n                }\n            ],\n            \"discount\": 0,\n            \"confirmation_sent\": false,\n            \"status\": \"confirmed\",\n            \"monetize\": null //Não aplicável em contexto de Get In API\n        },\n        ...\n    ],\n    \"pagination\": {\n        \"total\": 98,\n        \"current_page\": 1,\n        \"next_page\": 2,\n        \"last_page\": 7,\n        \"per_page\": 15,\n        \"is_last_page\": false\n    }\n}\n\n

Sem reservas encontradas:

{\n    \"success\": true,\n    \"data\": [],\n    \"pagination\": {\n        \"total\": 0,\n        \"current_page\": 1,\n        \"next_page\": null,\n        \"last_page\": 1,\n        \"per_page\": 15,\n        \"is_last_page\": true\n    }\n}\n\n

Estabelecimento específico a ser consultado.\nTipo: Texto(8)

\n","type":"text/plain"},"key":"unit_id","value":""},{"disabled":true,"description":{"content":"

Telefone específico a ser consultado.\nTipo: Texto