Este módulo reúne funcionalidades voltadas ao cadastro de clientes e à estruturação lógica de dados geográficos, essenciais para a correta configuração e operação da plataforma.

Funcionalidades Principais

Blocos - Listagem
Local
- Países
- Estados
- Cidades
Novo Cliente e Cadastro de Veículos

Blocos - Listagem

Acesse informações geográficas organizadas por localidade, úteis para cadastro e filtragem de dados:

Endpoint: api/v2/blocks?page=0&size=30

Método: GET

Response:

200	Return pagination blocks

{
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "blockCode": "string",
      "tag": "string",
      "parentId": 0,
      "parent": {
        "id": 0,
        "clientCode": "string",
        "sapId": "string",
        "corporateName": "string",
        "tradingName": "string",
        "taxIdentifier": "string",
        "isParent": true,
        "clientType": "DEFAULT"
      },
      "address": {
        "id": 0,
        "street": "string",
        "zipCode": "string",
        "number": "string",
        "district": "string",
        "complement": "string",
        "cityId": 0,
        "city": {
          "id": 0,
          "name": "string",
          "state": {
            "id": 0,
            "name": "string",
            "country": {
              "id": 0,
              "name": "string",
              "code": "string",
              "currency": {
                "id": 0,
                "code": "string"
              },
              "countryPhoneCode": {
                "id": 0,
                "code": "string"
              },
              "locale": {
                "id": 0,
                "code": "string",
                "description": "string"
              }
            }
          }
        },
        "cityName": "string",
        "stateName": "string",
        "countryName": "string"
      }
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0
  },
  "first": true,
  "last": true,
  "numberOfElements": 0,
  "empty": true
}

Error Messages:

403	Unauthorized

500	Unknown Server Error

Local

Informações disponíveis apenas para consulta, necessário reservar o ID de locais para chamadas específicas, por exemplo, o cadastro de um novo veículo.

Países

Endpoint: api/countries

Método: GET

Response:

[
  {
    "id": 0,
    "name": "string",
    "code": "string",
    "currencyId": 0,
    "localeId": 0
  }
]

Estados

Endpoint: states/filters?&name=Pa&countryId=1

Método: GET

Request payload - query parameters:

{
  "countryId": 0,
  "name": "string"
}

Response:

[
  {
    "id": 0,
    "name": "string",
    "countryId": 0
  }
]

Cidades

Endpoint: api/cities/filters?&name={iniciaisCidade}&stateId={stateId}

Método: GET

Request payload - query parameters:

{
  "stateId": 0,
  "name": "string"
}

Response:

[
  {
    "id": 0,
    "name": "string",
    "stateId": 0
  }
]

Novo Cliente e Cadastro de Veículos

Endpoint: customer-register

Método: POST

Content-Type: application/json

Request Body:

{
  "cnpj": "[cnpj]",
  "user": {
    "name": "xx",
    "email": "xxx",
    "phone": "xxx"
  },
  "vehicles": [
    "licensePlates"
  ],
  "manager": true
}

Field	Description	Required
cnpj

Response

Code	Status	Body	Message
200	Created	customer_id	Register successfully
400	Bad request		Invalid input data
401	Unauthorized		Invalid credential
500	Internal server error		Internal server error