Gestão de Cliente

Informações para gestão de clientes nos exempos usados no fluxos de operações

🚧

As informações dos endpoint nos exemplos usados nos fluxos de operações não representam a totalidade de métodos e parâmetros disponiveis.

🔎 Para saber mais detalhes consulte nossa Referencia de API

❗️

Erros

Consulte o response de cada endpoint em Rerefencia de API

Criar Cliente

MétodoEndpointDescrição
POST/customersCria um novo cliente na base de dados.

Exemplo de parâmetros

 {
   "name": "João da Silva",
   "email": "joao@example.com",
   "document": "12345678900",
   "code": "CUST-123"
 }

Consultar Cliente por ID

MétodoEndpointDescrição
GET/customers/{customer_id}Consulta um cliente específico pelo ID

Exemplo de parâmetros

{
  "customer_id": "123456"
}

Atualizar Cliente

MétodoEndpointDescrição
PUT/customers/{customer_id} Atualiza os dados de um cliente existente.

Exemplo de parâmetros


{
  "name": "João da Silva Jr.",
  "email": "joao.jr@example.com"
}