curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"comissao": 10.0,
"observacao": "Comissão aumentada devido ao alto volume de vendas"
}'
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"contato": "Maria Santos",
"email": "[email protected]",
"telefone": "(11) 98765-4321"
}'
// Desativar representada
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify({
ativo: false,
observacao: "Contrato encerrado em 26/01/2024 - Não renovado"
})
});
const result = await response.json();
if (result.success) {
console.log('Representada atualizada:', result.data);
console.log('Status:', result.data.ativo ? 'Ativa' : 'Inativa');
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Atualização completa de dados
data = {
"endereco": "Av. Industrial, 2000",
"cidade": "Guarulhos",
"estado": "SP",
"telefone": "(11) 2222-3333",
"comissao": 9.0,
"observacao": "Mudança de endereço - Nova sede a partir de 01/02/2024"
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
if response.status_code == 200:
print("Representada atualizada com sucesso!")
print(f"Nome: {result['data']['nome']}")
print(f"Novo endereço: {result['data']['endereco']}")
print(f"Cidade: {result['data']['cidade']}/{result['data']['estado']}")
print(f"Comissão atual: {result['data']['comissao']}%")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "987e6543-e89b-12d3-a456-426614174999",
"nome": "Laticínios Exemplo LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": "Av. Industrial, 2000",
"cidade": "Guarulhos",
"estado": "SP",
"contato": "Maria Santos",
"observacao": "Mudança de endereço - Nova sede a partir de 01/02/2024",
"comissao": 9.0,
"ativo": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-26T16:45:00Z"
}
}
{
"error": "Representada não encontrada"
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "too_big",
"maximum": 100,
"type": "number",
"inclusive": true,
"message": "Number must be less than or equal to 100",
"path": ["comissao"]
}
]
}
Representadas
Atualizar Representada
Atualiza os dados de uma representada existente
PUT
/
api
/
v1
/
representadas
/
{id}
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"comissao": 10.0,
"observacao": "Comissão aumentada devido ao alto volume de vendas"
}'
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"contato": "Maria Santos",
"email": "[email protected]",
"telefone": "(11) 98765-4321"
}'
// Desativar representada
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify({
ativo: false,
observacao: "Contrato encerrado em 26/01/2024 - Não renovado"
})
});
const result = await response.json();
if (result.success) {
console.log('Representada atualizada:', result.data);
console.log('Status:', result.data.ativo ? 'Ativa' : 'Inativa');
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Atualização completa de dados
data = {
"endereco": "Av. Industrial, 2000",
"cidade": "Guarulhos",
"estado": "SP",
"telefone": "(11) 2222-3333",
"comissao": 9.0,
"observacao": "Mudança de endereço - Nova sede a partir de 01/02/2024"
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
if response.status_code == 200:
print("Representada atualizada com sucesso!")
print(f"Nome: {result['data']['nome']}")
print(f"Novo endereço: {result['data']['endereco']}")
print(f"Cidade: {result['data']['cidade']}/{result['data']['estado']}")
print(f"Comissão atual: {result['data']['comissao']}%")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "987e6543-e89b-12d3-a456-426614174999",
"nome": "Laticínios Exemplo LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": "Av. Industrial, 2000",
"cidade": "Guarulhos",
"estado": "SP",
"contato": "Maria Santos",
"observacao": "Mudança de endereço - Nova sede a partir de 01/02/2024",
"comissao": 9.0,
"ativo": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-26T16:45:00Z"
}
}
{
"error": "Representada não encontrada"
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "too_big",
"maximum": 100,
"type": "number",
"inclusive": true,
"message": "Number must be less than or equal to 100",
"path": ["comissao"]
}
]
}
Use este endpoint para atualizar informações de contato, comissão ou status de representadas.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.
Path Parameters
string
required
ID único da representada (UUID)
Headers
string
required
application/json
string
required
API key de autenticação
Body
Todos os campos são opcionais. Envie apenas os campos que deseja atualizar.
string
Nome/Razão social da representadaMínimo de 1 caractere
string
CNPJ da representadaPode ser nulo para remover
string
Email de contatoDeve ser um email válido ou nulo
string
Telefone de contatoPode ser nulo para remover
string
Endereço completoPode ser nulo para remover
string
CidadePode ser nulo para remover
string
Estado (UF)Pode ser nulo para remover
string
Nome da pessoa de contatoPode ser nulo para remover
string
Observações geraisPode ser nulo para remover
boolean
Status da representada
true- Representada ativafalse- Representada inativa
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"comissao": 10.0,
"observacao": "Comissão aumentada devido ao alto volume de vendas"
}'
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"contato": "Maria Santos",
"email": "[email protected]",
"telefone": "(11) 98765-4321"
}'
// Desativar representada
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify({
ativo: false,
observacao: "Contrato encerrado em 26/01/2024 - Não renovado"
})
});
const result = await response.json();
if (result.success) {
console.log('Representada atualizada:', result.data);
console.log('Status:', result.data.ativo ? 'Ativa' : 'Inativa');
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Atualização completa de dados
data = {
"endereco": "Av. Industrial, 2000",
"cidade": "Guarulhos",
"estado": "SP",
"telefone": "(11) 2222-3333",
"comissao": 9.0,
"observacao": "Mudança de endereço - Nova sede a partir de 01/02/2024"
}
response = requests.put(url, headers=headers, json=data)
result = response.json()
if response.status_code == 200:
print("Representada atualizada com sucesso!")
print(f"Nome: {result['data']['nome']}")
print(f"Novo endereço: {result['data']['endereco']}")
print(f"Cidade: {result['data']['cidade']}/{result['data']['estado']}")
print(f"Comissão atual: {result['data']['comissao']}%")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
object
Dados completos da representada atualizada (mesma estrutura do GET)
{
"success": true,
"data": {
"id": "987e6543-e89b-12d3-a456-426614174999",
"nome": "Laticínios Exemplo LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": "Av. Industrial, 2000",
"cidade": "Guarulhos",
"estado": "SP",
"contato": "Maria Santos",
"observacao": "Mudança de endereço - Nova sede a partir de 01/02/2024",
"comissao": 9.0,
"ativo": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-26T16:45:00Z"
}
}
{
"error": "Representada não encontrada"
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "too_big",
"maximum": 100,
"type": "number",
"inclusive": true,
"message": "Number must be less than or equal to 100",
"path": ["comissao"]
}
]
}
Validações
Validações aplicadas:
- Nome deve ter pelo menos 1 caractere se fornecido
- Email deve ser válido se fornecido
- Comissão deve estar entre 0 e 100
- Representada deve existir no sistema
Casos de Uso Comuns
Exemplos práticos:
- Ajustar comissão: Modifique apenas o campo
comissaoapós negociação - Atualizar contato: Atualize
contato,emailetelefonequando houver mudança - Mudança de endereço: Atualize
endereco,cidadeeestado - Desativar representada: Defina
ativo: falseao encerrar contrato - Adicionar observações: Use o campo
observacaopara registrar informações importantes
Dicas
Boas práticas:
- Sempre adicione uma observação ao desativar uma representada explicando o motivo
- Mantenha os dados de contato sempre atualizados
- Revise periodicamente as comissões conforme desempenho
- Use o campo observação para registrar acordos especiais ou condições