Cliente¶
Importante
Por questões internas, em ambiente sandbox, os cadastros de clientes não serão salvos permanentemente, sendo resetados de 30 em 30 minutos.
Adicionar Cliente¶
Referência¶
POST https://api.dezwork.com/v1/clientes
| Parâmetros | Tipo | Descrição |
|---|---|---|
| Tipo* | string | Tipo do cliente (PF/PJ) |
| name* | string | Nome/Razão social do cliente |
| tradingName*² | string | Nome fantasia do cliente |
| stateRegister*² | string | Inscrição estadual |
| document* | string | Documento (CPF/CNPJ) do cliente |
| phone* | string | Telefone do cliente com DDD |
| birthDate*¹ | string | Data de nascimento no formato AAAA-MM-DD |
| mail* | decimal | E-mail do cliente |
| password | string | Senha do cliente |
| gender*¹ | int | Gênero do cliente? (1 - feminino / 2 - masculino) |
| active | boolean | Cliente ativo? |
| addresses* | array | Endereços do cliente. Objetos do tipo endereço |
¹ Obrigatórios em caso de PF
² Obrigatórios em caso de PJ
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "00857893050",
"phone": "54 999999999",
"birthDate": "1995-02-06",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": 1,
"active": true,
"addresses": [
{
"street": "Rua João Pessoa",
"number": "17",
"complement": "Sala 04",
"district": "Centro",
"city": "Garibaldi",
"state": "RS",
"postcode": "95720000",
"responsibleName": "Nome do responsável",
"reference": "Super Mercado Y",
"type": 1,
"active": true
}
]
}
Resposta¶
Status 201: CREATED¶
{
"success": true,
"data": {
"client": {
"id": 1,
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "008.578.930-50",
"phone": "(54)99999-9999",
"birthDate": "06/02/1995",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": "Feminino",
"active": "1",
"addresses": [
{
"id": 1,
"idClient": 1,
"street": "RUA JOÃO PESSOA",
"number": "17",
"complement": "SALA 04",
"district": "CENTRO",
"city": "GARIBALDI",
"state": "RS",
"postcode": "95720000",
"responsibleName": "NOME DO RESPONSÁVEL",
"reference": "SUPER MERCADO Y",
"type": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Atualizar Cliente¶
Referência¶
PUT https://api.dezwork.com/v1/clientes
Nota
Parâmetros com asterisco ( * ) são obrigatórios
Exemplo de Requisição¶
{
"id": 1,
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "00857893050",
"phone": "54 999999999",
"birthdate": "1995-02-06",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": "1",
"active": true,
"addresses": [
{
"id": 1,
"street": "Rua João Pessoa",
"number": "17",
"complement": "Sala 04",
"district": "Centro",
"city": "Garibaldi",
"state": "RS",
"postcode": "95720000",
"responsibleName": "Nome do Responsável",
"reference": "Super Mercado Y",
"type": 1
}
]
}
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"client": {
"id": 1,
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "008.578.930-50",
"phone": "(54)99999-9999",
"birthDate": "06/02/1995",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": "Feminino",
"active": "1",
"addresses": [
{
"id": 1,
"idClient": 1,
"street": "RUA JOÃO PESSOA",
"number": "17",
"complement": "SALA 04",
"district": "CENTRO",
"city": "GARIBALDI",
"state": "RS",
"postcode": "95720000",
"responsibleName": "NOME DO RESPONSÁVEL",
"reference": "SUPER MERCADO Y",
"type": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar Clientes¶
Referência¶
GET https://api.dezwork.com/v1/clientes/pagina/{numero-pagina}
A API de clientes realiza a consulta com paginação, onde a variável {numero-pagina} corresponde ao número da página desejado (1, 2, 3, …) e são retornados 50 clientes por página.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"clients": [
{
"id": 1,
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "008.578.930-50",
"phone": "(54)99999-9999",
"birthdate": "06/02/1995",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": "Feminino",
"active": "1",
"addresses": [
{
"id": 1,
"idClient": 1,
"street": "RUA JOÃO PESSOA",
"number": "17",
"complement": "SALA 04",
"district": "CENTRO",
"city": "GARIBALDI",
"state": "RS",
"postcode": "95720000",
"responsibleName": "NOME DO RESPONSÁVEL",
"reference": "SUPER MERCADO Y",
"type": "1"
}
]
},
{
"id": 2,
"type": "PJ",
"name": "NOME DO CLIENTE ATUALIZADO",
"tradingName": "NOME FANTASIA DO CLIENTE",
"stateRegister": "ISENTO",
"document": "58.009.342/0001-52",
"phone": "(54)99999-9999",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"active": true,
"addresses": [
{
"id": 4,
"street": "Rua João Pessoa",
"number": "1340",
"complement": "Sala 05",
"district": "Centro",
"city": "Garibaldi",
"state": "RS",
"postcode": "95720000",
"responsibleName": "NOME DO RESPONSÁVEL",
"reference": "SUPER MERCADO X",
"type": 1
}
]
}
]
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Consultar Cliente por ID¶
Referência¶
GET https://api.dezwork.com/v1/clientes/{id}
Basta uma requisição GET simples para esse endpoint, informando o ID do cliente na URL para retornar o cliente em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"client": {
"id": 1,
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "008.578.930-50",
"phone": "(54)99999-9999",
"birthDate": "06/02/1995",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": "Feminino",
"active": "1",
"addresses": [
{
"id": 1,
"idClient": 1,
"street": "RUA JOÃO PESSOA",
"number": "17",
"complement": "SALA 04",
"district": "CENTRO",
"city": "GARIBALDI",
"state": "RS",
"postcode": "95720000",
"responsibleName": "NOME DO RESPONSÁVEL",
"reference": "SUPER MERCADO Y",
"type": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}
Excluir Cliente¶
Referência¶
DELETE https://api.dezwork.com/v1/clientes/{id}
Basta uma requisição DELETE simples para esse endpoint, informando o ID do cliente na URL para excluir o cliente em questão.
Resposta¶
Status 200: OK¶
{
"success": true,
"data": {
"client": {
"id": 1,
"type": "PF",
"name": "NOME DO CLIENTE",
"document": "008.578.930-50",
"phone": "(54)99999-9999",
"birthDate": "06/02/1995",
"mail": "dev@branvo.com",
"password": "senha_exemplo",
"gender": "Feminino",
"active": "1",
"addresses": [
{
"id": 1,
"idClient": 1,
"street": "RUA JOÃO PESSOA",
"number": "17",
"complement": "SALA 04",
"district": "CENTRO",
"city": "GARIBALDI",
"state": "RS",
"postcode": "95720000",
"responsibleName": "NOME DO RESPONSÁVEL",
"reference": "SUPER MERCADO Y",
"type": 1
}
]
}
}
}
Status 400: Bad Request¶
Ocorre quando há algum problema nos parâmetros enviados.
{
"success": false,
"errorCode": "EPT",
"errorMessage": "Parâmetro [parametro] é obrigatório"
}