Esta é uma especificação da API para integração de reservas com o sistema Sismotel.
Esta especificação é o ponto de partida para entender o fluxo de integração de reservas com o sistema Sismotel.
API de Integração de Reservas do Sismotel fornece todo o conhecimento necessário para a integração de sistemas terceiros. O foco desta API é suprir a necessidade de reservas online dos moteleiros.
Esta API trata as solicitações de reservas para as próximas 24 horas como reservas do dia (last minute) e maiores que 24 horas como reservas futuras (programadas). Ou seja, para efetivação de uma nova reserva, o sistema considera como regra principal o status atual das suítes e como regra secundária as RESERVAS JÁ CONFIRMADAS QUE ESTÃO PREVISTAS (mapa de reserva). Enquanto a reserva programada considera apenas as RESERVAS CONFIRMADAS PREVISTAS (mapa de reservas).
1 - Solicitação de Pré-Reserva (API RECEBE) 2 - Pré-Reserva Cancelada 3 - Pré-Reserva Confirmada 4 - Informações de Pagamento (API RECEBE) 5 - Pagamento não Registrado 6 - Pagamento Registrado (Confirmada) 7 - Solicitação de Cancelamento, antes de check-in (API RECEBE) 8 - Confirmação de Cancelamento 9 - Cancelamento pelo Sistema 10 - Check-in 11 - Troca de Suíte 12 - Checkout 13 - No Show 14 - Cancelamento pelo Sistema após check-in 15 - Solicitado alteração nos dados da Reserva 98 - Timeout 99 - Motel Offline
1 - Buscar as Categorias; 2 - Solicitar pré-reserva, de acordo com os dados da categoria obtidas anteriormente; 3 - Buscar informação da reserva a cada x tempo, recomendamos 10 segundos. Caso a pré-reserva fique 60 segundos sem alterar a situação, será automaticamente cancelada, com a situação 98 - Timeout. 4 - Se a situação da reserva for 3, a pré-reserva foi confirmada; O sistema informa a suíte que foi reservada e irá aguardar pela informação de pagamento. Envie a informação de pagamento da reserva. (Só pode ser feita, quando a situação da pré-reserva for igual a 3) 5 - O sistema reconhece o pagamento e confirma a reserva da suíte.
1 - A reserva pode ser cancelada pela api, se ainda não foi feito o check-in. Ou seja, quando as situações ainda forem (1, 2, 3, 4, 5, 6); 2 - O pagamento da reserva não for confirmado em 3 minutos, ou seja, não enviar a confirmação de pagamento (situação 4).
1 - Somente reservas confirmadas podem ser editadas. Ou seja, a edição só é permitida quando o situação for igual a 6 (confirmada). 2 - Ao solicitar a edição de uma reserva, a situação será alterado para 15, indicando que a reserva está em processo de edição, até que o sistema conclua a operação. 3 - Após a conclusão da edição, o sistema retornará a situação 6 novamente, indicando que a reserva foi confirmada, juntamente com uma mensagem informando se a alteração foi realizada com sucesso ou não. 4 - Não é possivel editar dados como: CPF e Valores. Se for necessário alterar esses dados, o fluxo recomendado é cancelar a reserva e fazer uma nova.
Para utilizar o módulo Fidelidade, é necessário que o cliente tenha o serviço Fidelidade Web contratado, juntamente com os parâmetros FIDELIDADE-RTOKEN e FIDELIDADE-EMPRESA-ID.
Categorias = Tipo de Suíte. TOKEN = Token do motel, fornecido pela Microtecs com autorização do Motel. SOFTHOUSE = Token da Softhouse, fornecido pela Microtecs. Envie um e-mail para atendimento@microtecs.com.br com os dados: nome, email e telefone da softhouse para solicitar o cadastro e o token. FIDELIDADE-RTOKEN = Token da rede. FIDELIDADE-EMPRESA-ID = CNPJ da empresa.
Recupera as categorias do motel
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": [
- {
- "id": 1,
- "name": "Categoria A",
- "total": 10,
- "free": 10
}, - {
- "id": 2,
- "name": "Categoria B",
- "total": 8,
- "free": 4
}
]
}Recupera as suítes do motel
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": [
- {
- "suite_number": 1,
- "categories_id": 1,
- "status": "Conferência",
- "categories_name": "Categoria A",
- "free": 1
}, - {
- "suite_number": 2,
- "categories_id": 2,
- "status": "Conferência",
- "categories_name": "Categoria B",
- "free": 0
}
]
}Recupera os Produtos do motel
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": [
- {
- "id": 1,
- "name": "Produto A",
- "gtin": null,
- "un": "LT",
- "group": "BEBIDAS",
- "sale_value": 10,
- "balance": 10
}, - {
- "id": 2,
- "name": "Produto B",
- "gtin": null,
- "un": "UN",
- "group": "ERÓTICO",
- "sale_value": 5,
- "balance": -5
}
]
}Recupera as reservas agendadas do motel
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": null,
- "current_page": 1,
- "data": [
- {
- "id": 1,
- "categories_id": 1,
- "categories_name": "Luxo",
- "suite_number": 20,
- "period": 30,
- "date_in": "2020-08-27 18:30:06",
- "date_out": "2020-08-27 19:00:06",
- "partner": "Sismotel",
- "value": 100,
- "charging": 1,
- "name_client": "Cliente A",
- "email_client": "clientea@sismotel.com.br"
}, - {
- "id": 2,
- "categories_id": 1,
- "categories_name": "Luxo",
- "suite_number": 21,
- "period": 60,
- "date_in": "2020-08-29 18:30:06",
- "date_out": "2020-08-29 19:30:06",
- "partner": "Sismotel",
- "value": 150,
- "charging": 1,
- "name_client": "Cliente B",
- "email_client": "clienteb@sismotel.com.br"
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 100,
- "prev_page_url": null,
- "to": 2
}Recupera as reservas agendadas do motel por mês e ano
| MONTH required | integer Mês da consulta (1 a 12) |
| YEAR | integer Ano da consulta (Opcional) |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": null,
- "current_page": 1,
- "data": [
- {
- "id": 1,
- "categories_id": 1,
- "categories_name": "Luxo",
- "suite_number": 20,
- "period": 30,
- "date_in": "2020-08-27 18:30:06",
- "date_out": "2020-08-27 19:00:06",
- "partner": "Sismotel",
- "value": 100,
- "charging": 1,
- "name_client": "Cliente A",
- "email_client": "clientea@sismotel.com.br"
}, - {
- "id": 2,
- "categories_id": 1,
- "categories_name": "Luxo",
- "suite_number": 21,
- "period": 60,
- "date_in": "2020-08-29 18:30:06",
- "date_out": "2020-08-29 19:30:06",
- "partner": "Sismotel",
- "value": 150,
- "charging": 1,
- "name_client": "Cliente B",
- "email_client": "clienteb@sismotel.com.br"
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 100,
- "prev_page_url": null,
- "to": 2
}Recupera todas as reservas realizadas no motel
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": null,
- "current_page": 1,
- "data": [
- {
- "id": 1,
- "categories_id": 1,
- "categories_name": "Categoria A",
- "suite_number": 20,
- "suite_status": 1,
- "period": 120,
- "tolerance": 15,
- "discount": 0,
- "value": 300,
- "value_receive": 280,
- "value_extra": 10,
- "coupon": 0,
- "situation": 12,
- "charging": 1,
- "cpf_client": "<CPF>",
- "name_client": "Teste Microtecs",
- "phone_client": 0,
- "email_client": "teste@microtecs.com.br",
- "note": null,
- "date_scheduled": "2019-11-27 18:28:44",
- "logs": [
- {
- "situation": 0,
- "message": null,
- "date": "2019-11-27 18:28:44"
}, - {
- "situation": 2,
- "message": "A reserva 1 não pode ser efetuada.",
- "date": "2019-11-27 18:29:06"
}
]
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 100,
- "prev_page_url": null,
- "to": 1
}Recupera as reservas realizadas no motel por mês e ano
| MONTH required | integer Mês da consulta (1 a 12) |
| YEAR | integer Ano da consulta (Opcional) |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": null,
- "current_page": 1,
- "data": [
- {
- "id": 1,
- "categories_id": 1,
- "categories_name": "Categoria A",
- "suite_number": 20,
- "suite_status": 1,
- "period": 120,
- "tolerance": 15,
- "discount": 0,
- "value": 300,
- "value_receive": 280,
- "value_extra": 10,
- "coupon": 0,
- "situation": 12,
- "charging": 1,
- "cpf_client": "<CPF>",
- "name_client": "Teste Microtecs",
- "phone_client": 0,
- "email_client": "teste@microtecs.com.br",
- "note": null,
- "date_scheduled": "2019-11-27 18:28:44",
- "logs": [
- {
- "situation": 0,
- "message": null,
- "date": "2019-11-27 18:28:44"
}, - {
- "situation": 2,
- "message": "A reserva 1 não pode ser efetuada.",
- "date": "2019-11-27 18:29:06"
}
]
}
], - "from": 1,
- "next_page_url": null,
- "per_page": 100,
- "prev_page_url": null,
- "to": 1
}Recupera todas as informações de uma reserva.
| reservationId required | integer Código da reserva |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
{- "success": true,
- "result": {
- "reservation": {
- "id": 1,
- "categories_id": 1,
- "categories_name": "Categoria A",
- "suite_number": 20,
- "suite_status": 1,
- "period": 120,
- "tolerance": 15,
- "discount": 0,
- "value": 300,
- "value_receive": 280,
- "value_extra": 10,
- "coupon": 0,
- "situation": 12,
- "charging": 1,
- "cpf_client": "<CPF>",
- "name_client": "Teste Microtecs",
- "phone_client": 0,
- "email_client": "teste@microtecs.com.br",
- "note": null,
- "date_scheduled": "2019-11-27 18:28:44"
}, - "logs": [
- {
- "situation": 0,
- "message": null,
- "date": "2019-11-27 18:28:44"
}, - {
- "situation": 2,
- "message": "A reserva 1 não pode ser efetuada.",
- "date": "2019-11-27 18:29:06"
}
]
}
}Informa que o pagamento da reserva já foi recebido pelo sistema do integrador.
| reservationId required | integer Código da reserva |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
[- {
- "success": true,
- "result": {
- "id": 1,
- "situation": 1
}
}, - {
- "success": false,
- "message": "Mensagem de retorno do erro"
}
]Cancela a reserva informada
| reservationId required | integer Código da reserva |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
[- {
- "success": true,
- "result": {
- "id": 1,
- "situation": 1
}
}, - {
- "success": false,
- "message": "Mensagem de retorno do erro"
}
]Cria uma pré-reserva no sistema.
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
Exemplo de criação de pré-reserva.
| categories_id | integer Id da categoria |
| suite_number | integer Nullable Numero da suíte |
| period | number >= 30 Tempo em minutos do período contratado pelo cliente |
| tolerance | number Tempo em minutos de tolerância para o cliente fazer o check-in |
| discount | number Valor do desconto |
| value | number >= 1 Valor da reserva |
| value_receive | number >= 1 Valor que falta receber da reserva, se o pagamento já foi realizado deve ser informado zero. |
| value_extra | number >= 1 Valor já recebido, utilizado para o recebimento de produtos ou serviços, não compõe o valor de hospedagem. |
| coupon | integer Nullable Código do cupom |
| charging | integer Tipo de cobrança |
| cpf_client | string CPF válido do Cliente |
| doc_number | string Documento estrangeiro (Informado quando não existir CPF) |
| name_client | string <= 120 characters Nome do Cliente |
| phone_client | string Telefone do Cliente (11 dígitos) |
| email_client | string <= 128 characters Email válido do Cliente |
| note | string <= 200 characters Observações para exibir na tela de pagamento |
| date_scheduled | datetime Data que deseja fazer a reserva (se não informar, será a data e hora atual) |
| message | string <= 200 characters Nullable Mensagem de log da reserva |
{- "categories_id": 1,
- "suite_number": 10,
- "period": 120,
- "tolerance": 15,
- "discount": 0,
- "value": 300,
- "value_receive": 280,
- "value_extra": 10,
- "coupon": 0,
- "charging": 1,
- "cpf_client": "<CPF VÁLIDO>",
- "doc_number": "<Documento VÁLIDO>",
- "name_client": "Cliente A",
- "phone_client": "00000000000",
- "email_client": "string",
- "note": "string",
- "date_scheduled": "2020-07-10 16:46:50",
- "message": "Mensagem para gravar no log"
}[- {
- "success": true,
- "result": {
- "id": 1,
- "situation": 1
}
}, - {
- "success": false,
- "message": "Mensagem de retorno do erro"
}
]Atualiza uma reserva existente.
| ID required | string ID da reserva |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
Exemplo de edição da reserva.
| categories_id | integer Id da categoria |
| suite_number | integer Número da suíte, null quando a suíte ainda não foi selecionada |
| period | number >= 30 Tempo em minutos do período contratado pelo cliente |
| tolerance | number Tempo em minutos de tolerância para o cliente fazer o check-in |
| coupon | integer Nullable Código do cupom |
| charging | integer Tipo de cobrança |
| name_client | string <= 120 characters Nome do Cliente |
| phone_client | string Telefone do Cliente (11 dígitos) |
| email_client | string <= 128 characters Email válido do Cliente |
| note | string <= 200 characters Observações para exibir na tela de pagamento |
| date_scheduled | datetime Data que deseja fazer a reserva (se não informar, será a data e hora atual). OBS. Por padrão, só pode agendar uma reserva com 3 meses de antecedência. (Se precisar alterar, entre em contato com a Microtecs) |
{- "categories_id": 1,
- "suite_number": null,
- "period": 120,
- "tolerance": 15,
- "coupon": 0,
- "charging": 1,
- "name_client": "Cliente A",
- "phone_client": "00000000000",
- "email_client": "string",
- "note": "string",
- "date_scheduled": "2020-07-10 16:46:50"
}[- {
- "success": true,
- "result": {
- "id": 1,
- "situation": 1
}
}, - {
- "success": false,
- "message": "Mensagem de retorno do erro"
}
]Busca os pontos do cliente.
| CPF required | string CPF do cliente |
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
| FIDELIDADE-RTOKEN required | string <uuid> |
| FIDELIDADE-EMPRESA-ID required | string <uuid> |
{- "success": true,
- "result": {
- "id": 1,
- "cpf_client": "00000000000",
- "rg_client": "0000000",
- "name_client": "Nome do Cliente",
- "email_client": "email@email.com",
- "company_id": "1",
- "phone_client": "9999999999",
- "created_at": "12-04-2018 15:52:41",
- "available_score": "0.00",
- "plan": {
- "plan_id": 1,
- "plan_name": "PRATA",
- "description": "10% Desconto",
- "rules": "É o primeiro cartão do Programa de Fidelidade. Só é produzido após a primeira estadia. Dá 10% de desconto na estadia.",
- "upgrade_score": 10,
- "tolerance_days": 365,
- "discount": "10.00",
- "active": 1
}
}
}Busca as empresas cadastradas na rede.
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
| FIDELIDADE-RTOKEN required | string <uuid> |
| FIDELIDADE-EMPRESA-ID required | string <uuid> |
{- "success": true,
- "result": [
- {
- "company_id": 44,
- "company_name": "Companhia"
}
]
}Registra um novo usuário na rede.
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
| FIDELIDADE-RTOKEN required | string <uuid> |
| FIDELIDADE-EMPRESA-ID required | string <uuid> |
Exemplo de criação de usuario.
| agree_terms required | boolean Aceitar termos |
| cpf_client required | string CPF do cliente |
| email_client required | string Email do cliente |
| name_client required | string Nome do cliente |
| password required | string Senha |
| password_confirmation required | string Confirmar senha |
| adress | string Nullable Endereço |
| neighborhood | string Nullable Bairro |
| cep | string Nullable CEP |
| gender | string Nullable Sexo (M ou F) |
| city | string Nullable Cidade |
| company_id | integer Nullable ID da Empresa da Rede |
| phone_client | string Telefone Celular |
| promotion | boolean Nullable Se deseja receber promoções |
| birth_date required | string Data de nascimento >= 18 anos |
| relationship_date | string Nullable Data de relacionamento |
{- "agree_terms": true,
- "cpf_client": "0000000000",
- "email_client": "email@email.com",
- "name_client": "Nome",
- "password": "123456",
- "password_confirmation": "123456",
- "adress": "Rua exemplo",
- "neighborhood": "Nome do Bairro",
- "cep": "29200000",
- "gender": "M",
- "city": "Nome da Cidade",
- "company_id": 1,
- "phone_client": "99999999",
- "promotion": true,
- "birth_date": "2000-01-20",
- "relationship_date": "2020-11-25"
}{- "success": true,
- "result": {
- "name_client": "Nome do Cliente",
- "email_client": "email@exemplo.com",
- "cpf_client": "00000000000",
- "adress": "Rua exemplo",
- "neighborhood": "Bairro",
- "cep": "29200000",
- "gender": "M",
- "city": "São Paulo",
- "state_id": 1,
- "company_id": 1,
- "phone_client": "9999999999",
- "promotion": false,
- "birth_date": "2000-01-20",
- "relationship_date": "2020-11-25",
- "created_at": "2024-10-10 08:59:07"
}
}Credita ponto ao usuário.
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
| FIDELIDADE-RTOKEN required | string <uuid> |
| FIDELIDADE-EMPRESA-ID required | string <uuid> |
Exemplo de crédito ao usuário.
| cpf_client required | string CPF do cliente |
| score required | integer Pontuação a ser creditada |
| company_id required | integer ID da Empresa da Rede |
| employee | string Nullable ID do Responsavel |
{- "cpf_client": "0000000000",
- "score": 13,
- "company_id": 2,
- "employee": 2
}{- "success": true,
- "result": [
- {
- "name_client": "Jão da Silva",
- "cpf_client": "000000000",
- "available_score": "10.00",
- "credited_score": "8.0"
}
]
}Debita ponto do usuário.
| TOKEN required | string <uuid> |
| SOFTHOUSE required | string <uuid> |
| FIDELIDADE-RTOKEN required | string <uuid> |
| FIDELIDADE-EMPRESA-ID required | string <uuid> |
Exemplo de débito ao usuário.
| cpf_client required | string CPF do cliente |
| score required | integer Pontuação a ser deditada |
| company_id required | integer ID da Empresa da Rede |
| employee | string Nullable ID do Responsavel |
{- "cpf_client": "0000000000",
- "score": 13,
- "company_id": 1,
- "employee": 2
}{- "success": true,
- "result": [
- {
- "name_client": "Jão da Silva",
- "cpf_client": "000000000",
- "available_score": "10.00",
- "debited_score": "8.0"
}
]
}| id | integer Id da categoria |
| name | string <= 30 characters Nome da categoria |
| total | integer Quantidade total de suítes da categoria |
| free | integer Quantidade total de suítes livres da categoria |
{- "id": 1,
- "name": "Categoria A",
- "total": 10,
- "free": 5
}| suite_number | integer Numero da suíte |
| categories_id | integer Id da categoria |
| categories_name | string <= 30 characters Nome da categoria |
| free | integer Enum: "1 - Disponível" "0 - Indisponível" Disponibilidade |
{- "suite_number": 1,
- "categories_id": 1,
- "categories_name": "Categoria A",
- "free": 1
}| id | integer Id do Produto |
| name | string <= 60 characters Nome do Produto |
| gtin | string <= 15 characters Número Global de Item Comercial |
| un | string <= 2 characters Unidade de Medida do Produto |
| group | string <= 60 characters Grupo do Produto |
| sale_value | decimal Valor de Venda do Produto |
| balance | float Saldo em Estoque do Produto |
{- "id": 1,
- "name": "Categoria A",
- "gtin": 4006381333931,
- "un": "LT",
- "group": "FRIGOBAR",
- "sale_value": 26,
- "balance": "300 (* pode ser negativo)"
}| id | integer Id da reserva |
| categories_id | integer Id da categoria |
| categories_name | string <= 30 characters Nome da categoria |
| suite_number | integer Número da suíte, null quando a suíte ainda não foi selecionada |
| suite_status | integer Enum: "1 - Livre" "2 - Ocupada" "5 - Limpeza" Status da suíte |
| period | number >= 30 Tempo em minutos do período contratado pelo cliente |
| tolerance | number Tempo em minutos de tolerância para o cliente fazer o check-in |
| discount | number Valor do desconto |
| value | number >= 1 Valor bruto da reserva |
| value_receive | number >= 1 Valor que falta receber da reserva, se o pagamento já foi realizado deve ser informado zero. |
| value_extra | number >= 1 Valor já recebido, utilizado para o recebimento de produtos ou serviços, não compõe o valor de hospedagem. |
| coupon | integer Nullable Código do cupom |
| situation | integer Enum: "1 - Solicitação de Pré-Reserva (API RECEBE)" "2 - Pré-Reserva Cancelada" "3 - Pré-Reserva Confirmada" "4 - Informações de Pagamento (API RECEBE)" "5 - Pagamento não Registrado" "6 - Pagamento Registrado" "7 - Solicitação de Cancelamento, antes de check-in (API RECEBE)" "8 - Cancelamento pelo Sistema" "10 - Check-in" "11 - Troca de Suíte" "12 - Checkout" "13 - No Show" "98 - Timeout" "99 - Motel Offline" Código da situação da reserva |
| charging | integer Tipo de cobrança |
| cpf_client | string CPF válido do Cliente |
| name_client | string <= 120 characters Nome do Cliente |
| phone_client | string Telefone do Cliente (11 dígitos) |
| email_client | string <= 128 characters Email válido do Cliente |
| note | string <= 200 characters Observações para exibir na tela de pagamento |
| date_scheduled | datetime Data que deseja fazer a reserva (se não informar, será a data e hora atual). OBS. Por padrão, só pode agendar uma reserva com 3 meses de antecedência. (Se precisar alterar, entre em contato com a Microtecs) |
{- "id": 1,
- "categories_id": 1,
- "categories_name": "Categoria A",
- "suite_number": null,
- "suite_status": 1,
- "period": 120,
- "tolerance": 15,
- "discount": 0,
- "value": 300,
- "value_receive": 280,
- "value_extra": 10,
- "coupon": 0,
- "situation": 1,
- "charging": 1,
- "cpf_client": "<CPF VÁLIDO>",
- "name_client": "Cliente A",
- "phone_client": "00000000000",
- "email_client": "string",
- "note": "string",
- "date_scheduled": "2020-07-10 16:46:50"
}| id | integer Id da reserva agendada |
| categories_id | integer Id da categoria |
| categories_name | string Nome da categoria |
| suite_number | integer Número da Suíte |
| date_in | string Data de início da reserva |
| date_out | string Data de término da reserva |
| partner | string Parceiro da Reserva |
| period | number >= 30 Tempo em minutos do período contratado pelo cliente |
| value | number >= 1 Valor da reserva |
| charging | integer Tipo de cobrança |
| name_client | string <= 120 characters Nome do Cliente |
| email_client | string <= 128 characters Email válido do Cliente |
{- "id": 1,
- "categories_id": 1,
- "categories_name": "Categoria A",
- "suite_number": 12,
- "date_in": "2019-11-27 19:03:18",
- "date_out": "2019-11-27 23:03:18",
- "partner": "Sismotel",
- "period": 120,
- "value": 300,
- "charging": 1,
- "name_client": "Cliente A",
- "email_client": "string"
}| situation | integer Enum: "1 - Solicitação de Pré-Reserva (API RECEBE)" "2 - Pré-Reserva Cancelada" "3 - Pré-Reserva Confirmada" "4 - Informações de Pagamento (API RECEBE)" "5 - Pagamento não Registrado" "6 - Pagamento Registrado" "7 - Solicitação de Cancelamento, antes de check-in (API RECEBE)" "8 - Confirmação de Cancelamento" "9 - Cancelamento pelo Sistema" "10 - Check-in" "11 - Troca de Suíte" "12 - Checkout" "13 - No Show" "14 - Cancelamento pelo Sistema após check-in" "15 - Solicitado alteração nos dados da Reserva" "98 - Timeout" "99 - Motel Offline" Código da situação da reserva |
| message | string Mensagem de log da reserva |
| date | string Data de registro do log |
{- "situation": 2,
- "message": "A reserva 1 não pode ser efetuada.",
- "date": "2019-11-27 19:03:18"
}| categories_id | integer Id da categoria |
| suite_number | integer Número da suíte, null quando a suíte ainda não foi selecionada |
| period | number >= 30 Tempo em minutos do período contratado pelo cliente |
| tolerance | number Tempo em minutos de tolerância para o cliente fazer o check-in |
| coupon | integer Nullable Código do cupom |
| charging | integer Tipo de cobrança |
| name_client | string <= 120 characters Nome do Cliente |
| phone_client | string Telefone do Cliente (11 dígitos) |
| email_client | string <= 128 characters Email válido do Cliente |
| note | string <= 200 characters Observações para exibir na tela de pagamento |
| date_scheduled | datetime Data que deseja fazer a reserva (se não informar, será a data e hora atual). OBS. Por padrão, só pode agendar uma reserva com 3 meses de antecedência. (Se precisar alterar, entre em contato com a Microtecs) |
{- "categories_id": 1,
- "suite_number": null,
- "period": 120,
- "tolerance": 15,
- "coupon": 0,
- "charging": 1,
- "name_client": "Cliente A",
- "phone_client": "00000000000",
- "email_client": "string",
- "note": "string",
- "date_scheduled": "2020-07-10 16:46:50"
}| agree_terms required | boolean Aceitar termos |
| cpf_client required | string CPF do cliente |
| email_client required | string Email do cliente |
| name_client required | string Nome do cliente |
| password required | string Senha |
| password_confirmation required | string Confirmar senha |
| adress | string Nullable Endereço |
| neighborhood | string Nullable Bairro |
| cep | string Nullable CEP |
| gender | string Nullable Sexo (M ou F) |
| city | string Nullable Cidade |
| company_id | integer Nullable ID da Empresa da Rede |
| phone_client | string Telefone Celular |
| promotion | boolean Nullable Se deseja receber promoções |
| birth_date required | string Data de nascimento >= 18 anos |
| relationship_date | string Nullable Data de relacionamento |
{- "agree_terms": true,
- "cpf_client": "0000000000",
- "email_client": "email@email.com",
- "name_client": "Nome",
- "password": "123456",
- "password_confirmation": "123456",
- "adress": "Rua exemplo",
- "neighborhood": "Nome do Bairro",
- "cep": "29200000",
- "gender": "M",
- "city": "Nome da Cidade",
- "company_id": 1,
- "phone_client": "99999999",
- "promotion": true,
- "birth_date": "2000-01-20",
- "relationship_date": "2020-11-25"
}| cpf_client required | string CPF do cliente |
| score required | integer Pontuação a ser deditada |
| company_id required | integer ID da Empresa da Rede |
| employee | string Nullable ID do Responsavel |
{- "cpf_client": "0000000000",
- "score": 13,
- "company_id": 1,
- "employee": 2
}