V2
Clientes
Novo Cliente

Novo cliente

Essa aba contem informações especificas para criar um novo cliente, o mesmo será usado no futuro para criar novas vendas.

Especificações

🔐 Autenticação

A API exige autenticação via token JWT no cabeçalho da requisição:

Authorization: Bearer {token}

📬 Endpoint

POST /clients
Content-Type: application/json
Authorization: Bearer {token}

📥 Corpo da Requisição

{
    "cpf": "84403202055",
    "rg": "9839233",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@email.com",
    "birthdate": "1992-04-12",
    "phoneNumber": "11987653287",
    "address": {
      "neighborhood": "Cool Neighborhood",
      "installationNumber": "32785909",
      "address": "3rd Avenue",
      "addressNumber": "1234",
      "city": "Springfield",
      "zipCode": "66542439"
    }
}

Especificações objeto client

O objeto client se refere as informações do cliente que posteriormente será feita a inclusão de uma nova venda.

CampoDescriçãoTipoValidaçãoObrigatório
externalIdid de rastreamento do parceirostringNÃO
cpfCPFstringValida se o CPF é VálidoSIM
numberOnDealershipCódigo do cliente na concessionáriastringSIM
enrollmentNúmero da residenciastringSIM
firstNameNomestringSIM
lastNameSobrenomestringSIM
emailEmailstringEmail VálidoNÃO
birthdateData de NascimentostringData válida, formato YYYY-MM-DDSIM
phoneNumberTelefonestring11 Digitos - DD + NúmeroNÃO
addressEndereçoobjectSIM

Especificações objeto address

O objeto endereço se refere as informações da UC em que será feita a inclusão de uma nova venda

CampoDescriçãoTipoValidaçãoObrigatório
neighborhoodBairrostringMin. 3SIM
installationNumberNumera impressa na contastringMin. 7 / Máx 11SIM
addressEndereço (Rua, Av)stringSIM
addressNumberNúmero da residenciastringSIM
cityCidadestringSIM
zipCodeCEPstringValida se o CEP é VálidoSIM

🧾 Exemplos de respostas

HTTP Code - 200

Cliente criado com sucesso

{
    "message": "Client registered successfully",
    "clientId": "0197598b-3b58-711b-b203-930679568900",
    "addressId": "0197598b-3b57-711b-b203-8f923db68bf4"
}

HTTP Code - 400

  • Exemplo de erro, cpf não está presente no corpo da requisição
{
    "message": "Request body validation error",
    "code": 400,
    "invalidFieldsErrors": [
        {
            "field": "cpf",
            "message": "Required"
        }
    ]
}

HTTP Code - 401

  • Requisição não autorizada
{
    "message": "Unauthorized"
}