Fedex Logo

Introdução

A API de validação de endereço é uma solução inteligente para resolver detalhes de contato imprecisos e possibilitar a entrega mais rápida de pacotes com precisão. Essa API formata apropriadamente as informações de endereço do destinatário de entrada que se assemelham a um endereço válido e retorna um endereço real que provavelmente é o pretendido.

A API também fornece anotações sobre deficiências no endereço de entrada ou alterações feitas na entrada para chegar a esse endereço real. Você pode usar essa API para validar e determinar as informações de endereço do destinatário antes de enviar um pacote.

Observação: não use essa API para determinar a possibilidade de entrega de um endereço. A FedEx não oferece serviço de entrega para todos os endereços válidos. A FedEx não entrega em caixas postais, exceto via FedEx Ground® Economy (anteriormente conhecido como FedEx SmartPost®).

Detalhes da API de validação de endereço

Essa API permite validar e corrigir as informações de endereço do destinatário antes de enviar um pacote. Endereços precisos na etiqueta de remessa ajudará a eliminar atrasos na entrega e taxas adicionais de correção de endereço (devido a endereços incorretos).

Observação:

  • Os resultados da resolução de endereço variam de acordo com o país/território.
  • O endereço informado na solicitação é comparado com os dados de referência no banco de dados da FedEx e o endereço correspondente é retornado.

Funcionalidades da API de validação de endereço

  • Apresenta as correspondências de endereços de rua.
  • Recebe atualizações mensais para o seu banco de dados de endereços.
  • Diferencia entre endereços comerciais e residenciais quando uma correspondência exata é encontrada.
  • Não verifica atualmente números de apartamentos ou salas.

Recursos da API de validação de endereço

  • Completa o endereço incompleto do destinatário. Em alguns casos, a API de validação de endereço será capaz de adicionar informações ausentes, dependendo da verificação das informações fornecidas em relação aos dados de referência. A API de validação de endereço não adiciona informações secundárias ausentes (ou seja, apartamento ou sala) neste momento.
  • Recebe atualizações mensais para o seu banco de dados de endereços.
  • Corrige endereços de destinatários inválidos. Por exemplo, correção de um código postal incorreto para coincidir com o restante da entrada.
  • Determina se um endereço é comercial ou residencial para aumentar a precisão da cotação gratuita da tarifa. Aplicável apenas a endereços nos EUA e Canadá.
  • Confirma a validade e integralidade dos endereços em muitos países nestas regiões: EUA, Canadá, América Latina, Europa, Oriente Médio e Pacífico Asiático. Você pode validar as informações de endereço doméstico e internacional antes de enviar um pacote, eliminando atrasos desnecessários na entrega e taxas por serviço adicional.
  • Apresenta as correspondências de rua.
  • Até 100 endereços podem ser verificados em uma solicitação de API.

Países/territórios compatíveis com a API de validação de endereço

Você pode usar a API de validação de endereço FedEx nos seguintes países para validar e corrigir os endereços dos destinatários para entregas eficientes.

Holandesas Dinamarca Panamá
Argentina República Dominicana Peru
Aruba Estônia Portugal
Austrália Finlândia Cingapura
Áustria França África do Sul
Bahamas Alemanha Espanha
Barbados Grécia Suécia
Bélgica Guatemala Suíça
Bermudas RAE de Hong Kong, China Trinidad/Tobago
Brasil Itália Reino Unido
Canadá Jamaica Estados Unidos
Ilhas Cayman Malásia Uruguai
Chile México Venezuela
Colômbia Países Baixos Ilhas Virgens Americanas
Costa Rica Nova Zelândia  
República Tcheca Noruega  

 

Observação: as informações retornadas pela solicitação de validação de endereço são apenas sugestões de uso.

Isenção de responsabilidade legal: Os dados aqui fornecidos são propriedade da FedEx e informações confidenciais, fornecidas como cortesia a seu pedido. Nenhuma parte desses dados pode ser distribuída ou divulgada de qualquer forma a terceiros sem a permissão por escrito da FedEx. Eles refletem a classificação atual de endereço comercial/residencial da FedEx no banco de dados de endereço de entrega da FedEx e está sujeito a alterações. Ao fornecer essas informações, a FedEx não garante sua exatidão presente ou futura e não garante que os pacotes enviados para esses endereços serão faturados de acordo com a classificação comercial/residencial aqui fornecida. O fornecimento dessas informações não deve ser considerado como uma alteração dos termos do relacionamento entre as partes. Consulte o Guia de Serviço da FedEx e qualquer contrato de valores aplicável da conta para os termos e condições que regem os fretes e custos da FedEx.

Como a API de validação de endereço funciona

Validar endereço

Use esse endpoint para validar e determinar endereços de entrada e retornar endereços reais. Os detalhes do endereço são fornecidos e validados para determinar um endereço. Um endereço é declarado como definido quando o endereço de entrada corresponde aos dados de referência conhecidos.

As informações de entrada necessárias associadas a essa solicitação são as seguintes:

  • Linhas do endereço
  • Cidade (opcional)
  • Código do estado ou província (opcional)
  • Código postal (opcional)
  • Código do país

Observação: o código do estado ou nome da cidade é suficiente quando o cliente envia para um país que não possui um código postal.

A API de validação de endereço retorna um endereço real, executando as seguintes operações no endereço de entrada:

  • Como primeira etapa, a API tenta ajustar o endereço de entrada. Isso pode incluir a substituição de identificadores de vias comuns, como rua e via pública, por suas abreviações padrão, como R. e Av., bem como a reordenação de componentes do endereço. Se um endereço de entrada não puder ser ajustado, os endereços definidos retornados serão o endereço de entrada. Valores que não correspondem a um endereço são descartados.
  • Na segunda etapa, a API tenta padronizar o endereço ajustado, encontrando um endereço possível ou real que é provavelmente aquele pretendido pelo usuário. Se essa padronização falhar, os endereços definidos retornados serão a forma ajustada do endereço de entrada. Consulte os elementos retornados para ajudar a determinar os problemas com o endereço enviado.
  • Certos elementos desse endereço ajustado também serão retornados. Se a padronização for bem-sucedida, os endereços definidos retornados serão aquele endereço real. Nesse caso, vários elementos adicionais do endereço padronizado e informações sobre como ele foi derivado do endereço ajustado também são retornados.

Valores de retorno da API de validação de endereço

Se o endereço retornado incluir os seguintes valores para os atributos abaixo, o endereço é válido:

  • O estado do endereço é padronizado
  • Os atributos do endereço definido são Verdadeiros
  • Ponto de entrega válido (DPV) é Verdadeiro
  • O endereço interpolado é Falso

Se esses não estiverem listados, use os atributos adicionais para determinar os possíveis problemas com os valores de endereço.

Para obter mais informações sobre atributos de endereço, consulte Atributos de endereço.

Se a mensagem de saída retornada pelo cliente for INTERPOLATED.STREET.ADDRESS, então há uma chance de que o endereço não seja válido. Para obter mais informações sobre o código da mensagem do cliente, consulte a descrição do elemento da mensagem do cliente.

Anotações

A API de validação de endereço retorna anotações com cada endereço validado e retornado. As anotações fornecem informações sobre deficiências, se tiver, e alterações feitas no endereço de entrada para chegar a esse endereço real.

Classificação do endereço

A API de validação de endereço usa dados de referência para determinar a classificação de um determinado endereço. A classificação de um endereço funcional é calculada independentemente do processo de validação do endereço e é baseada no feedback do pessoal operacional, com fontes de dados comerciais usadas apenas para confirmação.

A API de validação de endereço tem apenas quatro classificações possíveis para endereços: desconhecido, comercial, residencial e misto. Todos os endereços começam com uma classificação 'desconhecida' e permanecem assim até que as regras de negócios de validação de endereços determinem que suas classificações devem ser alteradas. Um local só recebe uma classificação 'mista' se for um endereço de vários inquilinos e tiver unidades comerciais e residenciais.

Observação: o serviço FedEx Express fornece uma linha de endereço adicional (linha de endereço 3) para endereços de destinatários. Essas informações adicionais de endereço fornecem detalhes de localização mais completos e precisos, melhorando suas chances de obter um endereço correto.

Os endereços reais são classificados da seguinte maneira:

Endereço comercial

Um endereço comercial é um endereço usado para designar seu local principal de comércio. É onde supostamente sua empresa está operando, mas nem sempre é esse o caso.

O endereço comercial é a localização oficial das instalações de uma empresa. Pode ser qualquer coisa, desde o endereço residencial de alguém até um campus multimilionário, como as grandes empresas de tecnologia preferem, etc.

Endereço residencial

Uma cobrança de entrega residencial será aplicada às remessas dentro dos EUA, enviadas para uma residência particular, incluindo localidades em que haja um negócio funcionando na casa. Use a FedEx Home Delivery para entrega residencial via FedEx Ground em um dia útil, com base na distância até o destino.

Exemplo:

  • Reitoria
  • Convento
  • Presbitério
  • Residentes de residências com várias unidades, como:
    • Edifícios de apartamentos
    • Condomínios
    • Dormitórios universitários
  • Uma residência onde os produtos são vendidos e/ou distribuídos

Dicas para usar a API de validação de endereço

Dicas úteis para usar a API de validação de endereço a seguir:

  • Use espaçamento correto: verifique se os espaços estão corretos e evite espaços desnecessários.
  • Use ortografia correta: evite erros de ortografia e digitação. Verifique também se você está usando corretamente o número zero (0) e a letra O.
  • Evite caracteres especiais: evite usar caracteres especiais sem necessidade no endereço, como pontos e abreviações (Av vs. Av.).
  • Forneça informações adicionais sobre endereços e ruas: insira informações adicionais de endereços para aumentar a precisão dos resultados.
    • Número de edifício ou casa: 1, 1A, 1½, Um
    • Nome da rua: Central, George Washington, 42
    • Prefixo da rua: Estrada, Avenida, Est, Av
  • Informe a cidade, o estado/província e o CEP ou código postal: informe todos os três para aumentar a precisão dos resultados de endereços.
  • Informe a rua e o endereço na ordem: os elementos do endereço físico geralmente seguem um formato que começa com o nome da rua, o número do edifício ou casa, o número do apartamento, e/ou um número e designação de caixa postal privada.
  • Use abreviações corretas: os Correios americanos e canadenses possuem um padrão de abreviação para estado/província, prefixo de rua e designações de apartamento ou salas.
    • Uma abreviação que não seja padrão pode atrapalhar os resultados da pesquisa.
    • Se você não tiver certeza sobre qual abreviação usar, não a utilize.

Por exemplo:

  • Número de edifício ou casa como 1, 1A, Um.
  • Nome da rua como Central, George Washington, 42.
  • Prefixo da rua como Estrada, Avenida, Est, Av.
  • Informe a cidade, o estado/província e o código postal: informe toda a informação do endereço para aumentar a precisão dos resultados. A parte +4 do CEP não é necessária para verificar um endereço.
  • Use abreviações corretas: os Correios americanos e autoridades postais de outros países definem um padrão de abreviação para estado/província, prefixo de rua e designações de apartamento ou salas. Uma abreviação que não seja padrão pode atrapalhar os resultados da pesquisa. Se você não tiver certeza sobre qual abreviação usar, não a utilize.
  • Considere retornar o feedback da resposta de validação de endereço ao usuário para dar a ele a opção de escolher o endereço mais correto para ele.

Regras do negócio

  • Não use essa API para determinar a possibilidade de entrega de um pacote de um endereço. A FedEx não oferece serviço de entrega para todos os endereços válidos. A FedEx não entrega em caixas postais, exceto via FedEx Ground® Economy (anteriormente conhecido como FedEx SmartPost®®).
  • As informações retornadas pelo endereço definido são apenas sugestões de uso.
  • Até 100 endereços podem ser verificados em uma solicitação.
  • Os campos mínimos obrigatórios variam entre os países.

    Por exemplo, para endereços dos EUA, pelo menos uma linha de endereço e um código postal, ou uma cidade e um código de estado são necessários, mas para endereços AUS (formato de endereço da Austrália), o código de estado pode ser omitido mesmo sem um código postal.

  • O resultado da resolução de endereço pode variar de acordo com o país/território.

Observação: a API de validação de endereço pode não ser aplicável para todos os países. Consulte a seção Países/territórios compatíveis com a API de validação de endereço.

Coleção JSON API

CLOSE

Response

Copy