Pular para o conteúdo principal

Adiciona veículo ao cliente

POST /api/{userId}/establishment/{establishmentId}/clients/{clientId}/vehicles/new

Associa um veículo (placa) ao cliente e, se necessário, cria/atualiza o cadastro do veículo no estabelecimento.

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
clientIdstringIdentificador do cliente

Corpo (JSON)

CampoTipoObrigatórioDescrição
establishmentIdnumbersimEstabelecimento
platestringsimPlaca com 7 caracteres (é normalizada para maiúsculas)
vehicleModelstringnãoModelo do veículo
vehicleColorstringnãoCor do veículo
userIdnumbernãoUsuário responsável (quando aplicável)

Requisição

  • Método: POST
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/vehicles/new
  • Headers: Authorization, Accept: application/json, Content-Type: application/json

Formato da resposta (JSON)

  • Sucesso (HTTP 200): { "response": "success", "data": <payload> }
  • Erro de validação (HTTP 422): retorna os erros por campo
  • Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }

Exemplo de resposta (JSON)

Valores ilustrativos; a forma dos campos segue o retorno real.

{
"response": "success",
"data": {
"clientId": "772420260215093421",
"establishmentId": 7724,
"plate": "RXY4E88",
"vehicleModel": "Hatch",
"vehicleColor": "Prata",
"status": 1
}
}

Nuâncias

  • A placa é sempre armazenada/operada em maiúsculo.
  • Se a placa já estiver vinculada ao cliente, o backend pode rejeitar a operação.
  • Se o veículo existir no estabelecimento, pode haver atualização de vehicleModel/vehicleColor quando divergirem.