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.
Campo | Descrição | Tipo | Validação | Obrigatório |
---|---|---|---|---|
externalId | id de rastreamento do parceiro | string | NÃO | |
cpf | CPF | string | Valida se o CPF é Válido | SIM |
numberOnDealership | Código do cliente na concessionária | string | SIM | |
enrollment | Número da residencia | string | SIM | |
firstName | Nome | string | SIM | |
lastName | Sobrenome | string | SIM | |
string | Email Válido | NÃO | ||
birthdate | Data de Nascimento | string | Data válida, formato YYYY-MM-DD | SIM |
phoneNumber | Telefone | string | 11 Digitos - DD + Número | NÃO |
address | Endereço | object | SIM |
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
Campo | Descrição | Tipo | Validação | Obrigatório |
---|---|---|---|---|
neighborhood | Bairro | string | Min. 3 | SIM |
installationNumber | Numera impressa na conta | string | Min. 7 / Máx 11 | SIM |
address | Endereço (Rua, Av) | string | SIM | |
addressNumber | Número da residencia | string | SIM | |
city | Cidade | string | SIM | |
zipCode | CEP | string | Valida se o CEP é Válido | SIM |
🧾 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"
}