GET
/booking/config/get
Chave + Carregador
Leia as regras de reserva e a moeda do aplicativo.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/config/update
Chave + Carregador
Atualizar as regras de aviso, cancelamento e lembrete. A confirmação de dois passos permanece sempre ativa.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
min_notice_minutes
inteiro
Optional
Aviso mínimo de reserva.
max_advance_days
inteiro
Optional
Tempo máximo de reserva antecipada.
cancellation_hours
inteiro
Optional
Prazo de cancelamento do cliente.
public_booking
booleano
Optional
Permitir reserva móvel.
reminders_enabled
booleano
Optional
Activar a fila de lembretes.
reminder_hours
inteiro
Optional
Horas antes da reserva.
customer_notes_enabled
booleano
Optional
Permitir notas de clientes.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/service-category/list
Chave + Carregador
Listar categorias de serviços e subcategorias.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/service-category/add
Chave + Carregador
Criar uma categoria ou subcategoria principal.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
name
string
Necessário
Category name.
parent_id
inteiro
Optional
Identificador da categoria principal ao criar uma subcategoria.
description
string
Optional
Descrição facultativa.
color
hex
Optional
#RRGGBB
photo_base64
string
Optional
Único JPG, PNG ou foto WebP como base64 ou dados URI.
photo_file_name
string
Optional
Nome de ficheiro opcional.
photo_mime_type
string
Optional
image/jpeg | image/png | image/webp
active
booleano
Optional
Visível na aplicação.
sort_order
inteiro
Optional
Display order.
Output
Resultados possíveis
201 Recurso criado
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/service-category/update
Chave + Carregador
Atualizar uma classificação de categoria de serviço.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Categoria a actualizar.
name
string
Necessário
Name.
parent_id
inteiro
Optional
0 para uma categoria principal.
photo_base64
string
Optional
Uma nova foto substitui a foto atual.
remove_photo
booleano
Optional
Remova a foto atual.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
DELETE
/booking/service-category/delete
Chave + Carregador
Apagar uma categoria não utilizada ou arquivá- la.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Uma categoria usada será arquivada.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/service/list
Chave + Carregador
Listar os serviços de reserva e os recursos elegíveis.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/service/detail
Chave + Carregador
Recuperar uma descrição detalhada serviço e galeria de fotos.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Necessário
Identificador de serviço.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/service/add
Chave + Carregador
Crie um serviço com duração, preço e recursos.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
name
string
Necessário
Service name.
category_id
inteiro
Optional
Main category.
subcategory_id
inteiro
Optional
Subcategoria pertencente a category_id.
short_description
string
Optional
Texto curto mostrado abaixo do título na lista móvel.
long_description
string
Optional
Apresentação detalhada mostrada na página de serviço.
booking_mode
enum
Optional
appointment | duration | period | capacity
duration_minutes
inteiro
Optional
Duração real da reserva, de 5 a 10080 minutos.
slot_interval_minutes
inteiro
Optional
Frequência inicial. 0 ou omitido = o mesmo que duration_minutes.
capacity_required
inteiro
Optional
Capacidade consumida por uma reserva.
price_type
enum
Optional
free | fixed | hourly | daily
price
decimal
Optional
Preço na moeda do aplicativo.
deposit_type
enum
Optional
none | fixed | percent
deposit_value
decimal
Optional
Montante ou percentagem.
location_mode
enum
Optional
business | customer | online | custom
address_required
booleano
Optional
Requer o endereço do cliente.
resource_ids
array
Necessário
Identificadores de recursos elegíveis.
active
booleano
Optional
Serviço visível.
sort_order
inteiro
Optional
Display order.
Output
Resultados possíveis
201 Recurso criado
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/service/photo/add
Chave + Carregador
Adicionar uma foto a uma galeria de serviços.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Necessário
Identificador de serviço.
photo_base64
string
Necessário
Imagem JPG, PNG ou WebP como base64 ou URI de dados.
file_name
string
Optional
File name.
mime_type
string
Optional
image/jpeg | image/png | image/webp
Output
Resultados possíveis
201 Recurso criado
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
DELETE
/booking/service/photo/delete
Chave + Carregador
Apagar uma foto de serviço.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Necessário
Identificador de serviço.
photo_id
inteiro
Necessário
Foto a apagar.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/service/photo/primary
Chave + Carregador
Selecione a foto principal mostrada na lista móvel.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Necessário
Identificador de serviço.
photo_id
inteiro
Necessário
Foto usada na lista móvel.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/service/update
Chave + Carregador
Atualizar um serviço bookable.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Identificador de serviço.
name
string
Necessário
Service name.
duration_minutes
inteiro
Optional
Duração real da reserva.
slot_interval_minutes
inteiro
Optional
Frequência de início; 0 usa a duração do serviço.
category_id
inteiro
Optional
Main category.
subcategory_id
inteiro
Optional
Subcategory.
resource_ids
array
Optional
Lista completa de recursos elegíveis.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
DELETE
/booking/service/delete
Chave + Carregador
Apagar um serviço não utilizado ou arquivá- lo.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Um serviço usado será arquivado.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/resource/list
Chave + Carregador
Listar pessoas, salas, veículos, equipamentos e recursos de capacidade.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/resource/add
Chave + Carregador
Criar um recurso bookable.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
name
string
Necessário
Resource name.
resource_type
enum
Optional
person | room | equipment | vehicle | capacity | other
description
string
Optional
Descrição dos recursos.
capacity
inteiro
Optional
Capacidade simultânea.
location
string
Optional
Localização associada.
color
hex
Optional
#RRGGBB
active
booleano
Optional
Recursos activos.
sort_order
inteiro
Optional
Order.
Output
Resultados possíveis
201 Recurso criado
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/resource/update
Chave + Carregador
Atualizar um recurso.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Identificador do recurso.
name
string
Necessário
Name.
capacity
inteiro
Optional
Capacidade simultânea.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
DELETE
/booking/resource/delete
Chave + Carregador
Apagar um recurso não utilizado ou arquivá- lo.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Um recurso usado será arquivado.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/availability/list
Chave + Carregador
Listar horários semanais.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/availability/add
Chave + Carregador
Adicione uma programação geral, específica do serviço ou específica do recurso.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Optional
Serviço de destino; omitir ou usar 0 para todos os serviços.
resource_id
inteiro
Optional
Recurso alvo; omitir ou usar 0 para todos os recursos elegíveis.
weekday
inteiro
Necessário
1 de segunda a 7 de domingo.
start_time
time
Necessário
HH:MM
end_time
time
Necessário
HH:MM
Output
Resultados possíveis
201 Recurso criado
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
DELETE
/booking/availability/delete
Chave + Carregador
Apagar um horário.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Identificador do calendário.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/unavailability/list
Chave + Carregador
Listar feriados, encerramentos e períodos bloqueados.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nenhum parâmetro de negócio é esperado. Enviar apenas os cabeçalhos de autenticação indicados.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/unavailability/add
Chave + Carregador
Bloquear um período geral ou específico de recursos.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
resource_id
inteiro
Optional
Omite bloquear todo o negócio.
starts_at
datetime
Necessário
ISO 8601 com o fuso horário recomendado.
ends_at
datetime
Necessário
Após starts_at.
reason
string
Optional
Razão opcional.
Output
Resultados possíveis
201 Recurso criado
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
DELETE
/booking/unavailability/delete
Chave + Carregador
Apagar uma indisponibilidade.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Identificador do período.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/slot/list
Chave + Carregador
Listar slots disponíveis e slots temporariamente pendentes confirmação do administrador.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Necessário
Serviço de reserva.
resource_id
inteiro
Optional
Limitar a um recurso.
from_date
data
Optional
AAAA-MM-DD
days
inteiro
Optional
1 - 31
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/list
Chave + Carregador
Lista de reservas autorizadas.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nome Tipo Requirement Designação das mercadorias
status
enum
Optional
pending | confirmed | in_progress | completed | cancelled | no_show
limit
inteiro
Optional
1 - 200
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"items": [],
"pagination": {
"page": 1,
"per_page": 25,
"total": 0,
"last_page": 1
}
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
GET
/booking/detail
Chave + Carregador
Recuperar uma reserva e sua história.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis URL query
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Identificador da reserva.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/create
Chave + Carregador
Crie e confirme a solicitação do cliente; a aprovação do administrador ainda é necessária.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
service_id
inteiro
Necessário
Serviço seleccionado.
resource_id
inteiro
Necessário
Recurso selecionado.
starts_at
datetime
Necessário
Slot devolvido por reserva/lote/lista.
quantity
inteiro
Optional
Capacity used.
address
string
Optional
Necessário dependendo do serviço.
customer_notes
string
Optional
Optional note.
customer_id
inteiro
Optional
Apenas para fornecedores.
customer_name
string
Optional
Necessário quando nenhum cliente está ligado.
customer_email
e- mail
Optional
Endereço de contacto.
customer_phone
string
Optional
Contact phone.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/customer-confirm
Chave + Carregador
Confirme uma reserva no lado do cliente.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
booking_id
inteiro
Necessário
Reserva pertencente ao cliente assinado.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/admin-confirm
Chave + Carregador
Confirme, retorne à reserva pendente ou rejeite a reserva do lado do administrador.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
booking_id
inteiro
Necessário
Reserva para revisão.
confirmation
enum
Necessário
pending | confirmed | rejected
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/update
Chave + Carregador
Remarcar ou atualizar uma reserva.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Reserva para atualização.
service_id
inteiro
Necessário
Service.
resource_id
inteiro
Necessário
Resource.
starts_at
datetime
Necessário
New start.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
PATCH
/booking/status/update
Chave + Carregador
Avance uma reserva que já foi confirmada por ambos os lados.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
id
inteiro
Necessário
Booking.
status
enum
Necessário
pending | confirmed | in_progress | completed | cancelled | no_show
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}
POST
/booking/cancel
Chave + Carregador
Cancelar de acordo com o prazo configurado.
Parâmetros e respostas ⌄
Testar · Gerar
Input
Parâmetros disponíveis Corpo JSON
Nome Tipo Requirement Designação das mercadorias
booking_id
inteiro
Necessário
Reserva autorizada.
reason
string
Optional
Razão opcional.
Output
Resultados possíveis
200 Operação de sucesso
400 Pedido inválido ou JSON
401 Autenticação em falta ou inválida
403 Acesso insuficiente
404 Recurso solicitado não encontrado
409 Conflito com os dados existentes
422 Parâmetro rejeitado pela validação
429 Limite de solicitação atingido
5xx Incidente técnico temporário
Exemplo de sucesso {
"success": true,
"message": "Operation successful",
"data": {
"id": 123,
"status": "ok"
},
"error": null
}
Error example {
"success": false,
"message": "The request cannot be processed.",
"data": null,
"error": {
"code": "VALIDATION_ERROR",
"category": "validation",
"message": "Check the indicated parameters.",
"details": {
"field": "parameter_name"
}
}
}