platestringObrigatóriopattern"^[A-Z]{3}[0-9][A-Z0-9][0-9]{2}$"← InícioFleetPay / API
Cadastrar veículo
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/fiscal/veiculosDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
Autenticação
[
{
"oauth2": []
},
{
"chaveApi": []
}
]A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.
Parâmetros
Nenhum parâmetro declarado nesta operação.
Corpo da Requisição
Obrigatório
application/json
plate_statestring | nullOpcionalminLength2maxLength2renavamstring | nullOpcionalpattern"^\\d{11}$"tare_kgnumber | nullOpcionalminimum0capacity_kgnumber | nullOpcionalminimum0capacity_m3number | nullOpcionalminimum0axlesnumber | nullOpcionalminimum0maximum255body_typenumber | nullOpcionalminimum0maximum255wheel_typenumber | nullOpcionalminimum0maximum255owner_typestring | nullOpcional"own" · "third"owner_documentstring | nullOpcionalmaxLength14owner_namestring | nullOpcionalmaxLength120owner_rntrcstring | nullOpcionalmaxLength8default_driver_user_idinteger | nullOpcionalminimum1Respostas
201 Resposta HTTP
Veículo cadastrado.
application/json
dataobjectObrigatórioenvironmentobjectObrigatórioHeaders
X-Request-IdIdentificador de correlação da chamada.
401 Resposta HTTP
Chave de API FleetPay ausente ou inválida.
Headers
X-Request-IdIdentificador de correlação da chamada.
403 Resposta HTTP
Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.
Headers
X-Request-IdIdentificador de correlação da chamada.
422 Resposta HTTP
Payload inválido, pendência ou regra de negócio.
Headers
X-Request-IdIdentificador de correlação da chamada.
429 Resposta HTTP
Limite por transportadora excedido.
Headers
X-Request-IdIdentificador de correlação da chamada.
Retry-AfterSegundos até uma nova tentativa.
500 Resposta HTTP
Falha interna sem detalhes de integrações operacionais.
Headers
X-Request-IdIdentificador de correlação da chamada.
Definição Completa da Operação
{
"tags": [
"Veículos"
],
"summary": "Cadastrar veículo",
"operationId": "createVehicle",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VehicleCreateInput"
}
}
}
},
"responses": {
"201": {
"$ref": "#/components/responses/VehicleCreated"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"422": {
"$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "POST",
"path": "/fiscal/veiculos",
"parameters": []
}