Excluir um endereço

Visão Geral

Este endpoint permite remover permanentemente um endereço do sistema. É especialmente útil para manter os dados do cliente organizados e atualizados, eliminando endereços obsoletos ou incorretos.

Precauções

ATENÇÃO! Por favor, leia estas informações importantes antes de usar este endpoint.

• Operação Irreversível: A exclusão de um endereço é uma operação irreversível. Todos os dados associados ao endereço serão permanentemente removidos.
• ID do Endereço: Certifique-se de utilizar um ID de endereço válido e existente no sistema.
• Endereço Principal: Se o endereço estiver marcado como primary: true, verifique se o cliente possui outros endereços antes de excluí-lo.

Descrição

O endpoint Excluir Endereço permite remover permanentemente um endereço do sistema, ajudando a manter os dados do cliente limpos e organizados.

Requisição

DELETE /v1/addresses/{addressId}

Parâmetros da Requisição

Resposta - 200 OK

A deleção retorna confirmação mínima com status 200 (não 204; o corpo confirma a ação).

{
  "id": "addr_01hqzvabc",
  "resource": "address",
  "deleted": true,
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  }
}

Nota: A confirmação de exclusão de endereço não inclui _links.

Atributos da Resposta de Deleção

Respostas de Erro

400 Bad Request

Esta resposta ocorre quando o ID do endereço fornecido é inválido.

{
  "error": {
    "status": "Bad Request",
    "statusCode": 400,
    "category": "validation",
    "message": "Validation errors occurred.",
    "params": [
      {
        "addressId": "The provided address ID is invalid. Please check the ID and try again."
      }
    ]
  }
}

404 Not Found

Ocorre quando o addressId não existe ou não pertence à sua conta (addressIdNotFound).

{
  "error": {
    "status": "Not Found",
    "statusCode": 404,
    "category": "resource",
    "message": "Address not found."
  }
}

Casos de Uso

1. Manutenção de Perfil: Remoção de endereços obsoletos ou incorretos do perfil do cliente
2. Mudança de Endereço: Exclusão de endereços antigos após o cliente se mudar
3. Privacidade de Dados: Remoção de informações pessoais a pedido do cliente
4. Correção de Dados: Eliminação de endereços duplicados ou com informações inconsistentes

Melhores Práticas

1. Verificação Prévia: Consulte o endereço antes de excluí-lo para confirmar que é o correto
2. Gerenciamento de Endereço Principal: Se excluir um endereço principal, certifique-se de definir outro como principal primeiro
3. Confirmação do Usuário: Solicite confirmação do usuário antes de executar a exclusão
4. Backup de Dados: Considere armazenar temporariamente os dados do endereço caso o cliente precise recuperá-los
5. Atualização de Interfaces: Atualize imediatamente quaisquer interfaces ou caches que possam estar exibindo o endereço excluído

Integração com Outros Endpoints

• Use Consultar Endereço antes da exclusão para verificar os detalhes do endereço
• Use Listar Endereços para encontrar todos os endereços de um cliente e decidir qual excluir
• Use Criar Endereço se o cliente precisar adicionar um novo endereço após a exclusão