V2
Instalações
Nova Instalação

Nova instalação

Essa aba contem informações especificas para criar uma instalação para um cliente, a mesma será usada 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 /installations
Content-Type: application/json
Authorization: Bearer {token}

📥 Corpo da Requisição

{
    "clientId": "0197599f-e790-733c-98ea-3b12973bd4d1",
    "installationNumber": "00000010",
    "dealershipId": "1",
    "addressId": "019745b4-9307-7778-adb8-d6fe78815e2b"
}

Especificações objeto installation

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

CampoDescriçãoTipoValidaçãoObrigatório
clientIdId do clientestringSIM
installationNumberNúmero da instalação do clientestringSIM
dealershipIdId da concessionáriastringNÃO
addressIdId da do endereço cadastradostringNÃO

🧾 Exemplos de respostas

HTTP Code - 200

Cliente criado com sucesso

{
    "message": "Installation registered successfully",
    "installationId": {
        "installationId": "0196ac96-a8fa-7eef-a3f5-432368284021",
        "addressId": "019745b4-9307-7778-adb8-d6fe78815e2b"
    }
}

HTTP Code - 400

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

HTTP Code - 401

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