curl -X DELETE "https://api.sistema-representantes.com.br/api/v1/representadas/123e4567-e89b-12d3-a456-426614174111" \
-H "x-api-key: sua-api-key-aqui"
const representadaId = '123e4567-e89b-12d3-a456-426614174111';
const response = await fetch(`https://api.sistema-representantes.com.br/api/v1/representadas/${representadaId}`, {
method: 'DELETE',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Representada deletada com sucesso');
console.log(result.message);
} else {
console.error('Erro ao deletar:', result.error);
if (result.error.includes('venda(s) associada(s)')) {
console.log('A representada possui vendas e não pode ser deletada.');
console.log('Considere desativá-la em vez de deletar.');
}
}
import requests
representada_id = "123e4567-e89b-12d3-a456-426614174111"
url = f"https://api.sistema-representantes.com.br/api/v1/representadas/{representada_id}"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.delete(url, headers=headers)
result = response.json()
if response.status_code == 200:
print("Representada deletada com sucesso!")
print(result['message'])
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
# Verificar tipo de erro
error_msg = result.get('error', '')
if 'venda(s) associada(s)' in error_msg:
print("\n⚠️ A representada possui vendas no sistema.")
print("Não é possível deletar para manter o histórico.")
print("Considere desativar a representada em vez de deletar.")
elif 'produto(s) associado(s)' in error_msg:
print("\n⚠️ A representada possui produtos cadastrados.")
print("Remova ou reatribua os produtos antes de deletar.")
<?php
$representadaId = '123e4567-e89b-12d3-a456-426614174111';
$url = "https://api.sistema-representantes.com.br/api/v1/representadas/{$representadaId}";
$headers = [
'x-api-key: sua-api-key-aqui'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$result = json_decode($response, true);
if ($httpCode === 200) {
echo "Representada deletada com sucesso!\n";
echo $result['message'] . "\n";
} else {
echo "Erro: " . $result['error'] . "\n";
if (strpos($result['error'], 'venda(s) associada(s)') !== false) {
echo "\nA representada possui vendas associadas.\n";
echo "Recomendamos desativar em vez de deletar.\n";
}
}
?>
{
"success": true,
"message": "Representada deletada com sucesso"
}
{
"error": "Representada não encontrada"
}
{
"error": "Representada possui 87 venda(s) associada(s) e não pode ser deletada"
}
{
"error": "Representada possui 15 produto(s) associado(s) e não pode ser deletada"
}
{
"error": "API key ausente"
}
{
"error": "Empresa inativa"
}
{
"error": "Erro ao deletar representada"
}
Representadas
Deletar Representada
Remove permanentemente uma representada do sistema
DELETE
/
api
/
v1
/
representadas
/
{id}
curl -X DELETE "https://api.sistema-representantes.com.br/api/v1/representadas/123e4567-e89b-12d3-a456-426614174111" \
-H "x-api-key: sua-api-key-aqui"
const representadaId = '123e4567-e89b-12d3-a456-426614174111';
const response = await fetch(`https://api.sistema-representantes.com.br/api/v1/representadas/${representadaId}`, {
method: 'DELETE',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Representada deletada com sucesso');
console.log(result.message);
} else {
console.error('Erro ao deletar:', result.error);
if (result.error.includes('venda(s) associada(s)')) {
console.log('A representada possui vendas e não pode ser deletada.');
console.log('Considere desativá-la em vez de deletar.');
}
}
import requests
representada_id = "123e4567-e89b-12d3-a456-426614174111"
url = f"https://api.sistema-representantes.com.br/api/v1/representadas/{representada_id}"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.delete(url, headers=headers)
result = response.json()
if response.status_code == 200:
print("Representada deletada com sucesso!")
print(result['message'])
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
# Verificar tipo de erro
error_msg = result.get('error', '')
if 'venda(s) associada(s)' in error_msg:
print("\n⚠️ A representada possui vendas no sistema.")
print("Não é possível deletar para manter o histórico.")
print("Considere desativar a representada em vez de deletar.")
elif 'produto(s) associado(s)' in error_msg:
print("\n⚠️ A representada possui produtos cadastrados.")
print("Remova ou reatribua os produtos antes de deletar.")
<?php
$representadaId = '123e4567-e89b-12d3-a456-426614174111';
$url = "https://api.sistema-representantes.com.br/api/v1/representadas/{$representadaId}";
$headers = [
'x-api-key: sua-api-key-aqui'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$result = json_decode($response, true);
if ($httpCode === 200) {
echo "Representada deletada com sucesso!\n";
echo $result['message'] . "\n";
} else {
echo "Erro: " . $result['error'] . "\n";
if (strpos($result['error'], 'venda(s) associada(s)') !== false) {
echo "\nA representada possui vendas associadas.\n";
echo "Recomendamos desativar em vez de deletar.\n";
}
}
?>
{
"success": true,
"message": "Representada deletada com sucesso"
}
{
"error": "Representada não encontrada"
}
{
"error": "Representada possui 87 venda(s) associada(s) e não pode ser deletada"
}
{
"error": "Representada possui 15 produto(s) associado(s) e não pode ser deletada"
}
{
"error": "API key ausente"
}
{
"error": "Empresa inativa"
}
{
"error": "Erro ao deletar representada"
}
Esta ação é irreversível. A representada será permanentemente removida do sistema.
Representadas com vendas ou produtos associados não podem ser deletadas para manter a integridade do sistema.
Path Parameters
string
required
ID único da representada (UUID)
Headers
string
required
API key de autenticação
curl -X DELETE "https://api.sistema-representantes.com.br/api/v1/representadas/123e4567-e89b-12d3-a456-426614174111" \
-H "x-api-key: sua-api-key-aqui"
const representadaId = '123e4567-e89b-12d3-a456-426614174111';
const response = await fetch(`https://api.sistema-representantes.com.br/api/v1/representadas/${representadaId}`, {
method: 'DELETE',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Representada deletada com sucesso');
console.log(result.message);
} else {
console.error('Erro ao deletar:', result.error);
if (result.error.includes('venda(s) associada(s)')) {
console.log('A representada possui vendas e não pode ser deletada.');
console.log('Considere desativá-la em vez de deletar.');
}
}
import requests
representada_id = "123e4567-e89b-12d3-a456-426614174111"
url = f"https://api.sistema-representantes.com.br/api/v1/representadas/{representada_id}"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.delete(url, headers=headers)
result = response.json()
if response.status_code == 200:
print("Representada deletada com sucesso!")
print(result['message'])
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
# Verificar tipo de erro
error_msg = result.get('error', '')
if 'venda(s) associada(s)' in error_msg:
print("\n⚠️ A representada possui vendas no sistema.")
print("Não é possível deletar para manter o histórico.")
print("Considere desativar a representada em vez de deletar.")
elif 'produto(s) associado(s)' in error_msg:
print("\n⚠️ A representada possui produtos cadastrados.")
print("Remova ou reatribua os produtos antes de deletar.")
<?php
$representadaId = '123e4567-e89b-12d3-a456-426614174111';
$url = "https://api.sistema-representantes.com.br/api/v1/representadas/{$representadaId}";
$headers = [
'x-api-key: sua-api-key-aqui'
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$result = json_decode($response, true);
if ($httpCode === 200) {
echo "Representada deletada com sucesso!\n";
echo $result['message'] . "\n";
} else {
echo "Erro: " . $result['error'] . "\n";
if (strpos($result['error'], 'venda(s) associada(s)') !== false) {
echo "\nA representada possui vendas associadas.\n";
echo "Recomendamos desativar em vez de deletar.\n";
}
}
?>
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
string
Mensagem de confirmação
Erro
string
Mensagem de erro descritiva
{
"success": true,
"message": "Representada deletada com sucesso"
}
{
"error": "Representada não encontrada"
}
{
"error": "Representada possui 87 venda(s) associada(s) e não pode ser deletada"
}
{
"error": "Representada possui 15 produto(s) associado(s) e não pode ser deletada"
}
{
"error": "API key ausente"
}
{
"error": "Empresa inativa"
}
{
"error": "Erro ao deletar representada"
}
Considerações Importantes
Antes de deletar uma representada:
- Verifique se não há vendas associadas
- Verifique se não há produtos vinculados
- Considere o impacto no histórico e relatórios
- Faça backup se necessário
- Avalie se desativar não seria mais apropriado
Restrições de Integridade
Uma representada NÃO pode ser deletada se:
- Possui vendas realizadas (mesmo antigas)
- Possui produtos cadastrados
- Está sendo referenciada em outros registros
Alternativa Recomendada
Em vez de deletar, considere desativar a representada:Vantagens de desativar:
curl -X PUT "https://api.sistema-representantes.com.br/api/v1/representadas/{id}" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"ativo": false,
"observacao": "Contrato encerrado em XX/XX/XXXX"
}'
- Mantém histórico de vendas intacto
- Preserva relatórios e análises
- Permite reativar no futuro se necessário
- Mantém rastreabilidade completa
Quando Deletar
Delete representadas apenas quando:
- Foram criadas por engano
- São dados de teste
- Nunca foram utilizadas (sem vendas ou produtos)
- Não há necessidade de manter histórico