Clientes

POST /api/v1/clientsCopied!

Este endpoint permite criar um ou vários clientes

header da request:

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

O payload deve estar no seguinte formato:

[
   {
        "client_id": "30da23ca-e48c-4f96-b62b-36f6eb613dba", // UUID referente ao cliente no ERP
        "name": "Mariana Oliveira",
        "cnpj_cpf": "419.319.010-23",
        "address": "Rua Heitor Vieira de Almeida",
        "number": "434",
        "neighborhood": "Jardim Aeroporto",
        "city": "Campo Grande",
        "state": "MS",
        "zip_code": "60745-781",
        "complement": "Apartamento 90",
        "telephone": "9342663538",
        "phone_number": "93975035513",
        "email": "mariana.oliveira@example.com",
        "return_client_data": true // Retorna ou não os dados dos clientes registrados
    }
]

Response:

{
  "status": "success",
  "message": "Clientes criados com sucesso.",
  "total_created_clients": [
    // Exemplo quando  "return_data_client": true
    {
      "client_id": "30da23ca-e48c-4f96-b62b-26f6eb613dba",
      "data": {
        "uf": "MS",
        "cep": "60745-781",
        "fone": "9342663538",
        "email": "mariana.oliveira@example.com",
        "razao": "Mariana Oliveira",
        "bairro": "Jardim Aeroporto",
        "cidade": "Campo Grande",
        "numero": "434",
        "cnpj_cpf": "419.319.010-23",
        "endereco": "Rua Heitor Vieira de Almeida",
        "complemento": "Apartamento 90",
        "telefone_celular": "93975035513"
      }
  ]
  "clients_already_registered": []
}
 

PUT /api/v1/clients/{uuid}Copied!

header da request

Authorization: Bearer {access_token}
Accept: application/json 
Idempotency-Key: "asdsad32312dqs"

Permite atualizar as informações de um cliente

Dever ser informado o client_id(UUID) enviado no registro do cliente

O payload deve estar no seguinte formato:

{
  "name": "Mariana Oliveira",
  "cnpj_cpf": "419.319.010-23",
  "address": "Rua Heitor Vieira de Almeida",
  "number": "434",
  "neighborhood": "Jardim Aeroporto",
  "city": "Campo Grande",
  "state": "MS",
  "zip_code": "60745-781",
  "complement": "Apartamento 90",
  "telephone": "9342663538",
  "phone_number": "93975035513",
  "email": "mariana.oliveira@example.com"
}

Response

{
  "status": "success",
  "message": "Cliente atualizado com sucesso.",
  "data": {
    "razao": "Mariana Oliveira",
    "cnpj_cpf": "419.319.010-23",
    "endereco": "Rua Heitor Vieira de Almeida",
    "numero": "434",
    "bairro": "Jardim Aeroporto",
    "cidade": "Campo Grande",
    "uf": "MS",
    "cep": "60745-781",
    "complemento": "Apartamento 90",
    "fone": "9342663538",
    "telefone_celular": "93975035513",
    "email": "mariana.oliveira@example.com"
  }
}