Fedex Logo
Developer Portal

Address Validation APi

Введение

API проверки адресов — это умное решение, предназначенное для устранения неточностей в контактных данных и помогающее отправлять посылки быстрее и более точно. Данный API форматирует введенные данные адреса получателя, которые выглядят как действительный адрес, соответствующим образом и возвращает реально существующий адрес, который, скорее всего, и имелся в виду.

Кроме того, API сообщает, что было не так в указанном адресе и какие изменения были в него внесены для получения реально существующего адреса. Вы можете использовать этот API для проверки и уточнения адреса получателя перед отправкой посылки.

Примечание. Не используйте этот API для определения возможности доставки по указанному адресу. FedEx не доставляет отправления на все существующие адреса. FedEx не доставляет отправления в абонентские ящики, кроме отправлений FedEx Ground® Economy (ранее FedEx SmartPost®).

Подробные сведения об API проверки адресов

Данный API позволяет проверить и исправить адрес получателя перед отправкой посылки. Точный адрес на транспортной этикетке поможет избежать задержек при доставке и дополнительных сборов за уточнение адреса (если адрес был сформирован неправильно).

Примечание:

  • Результаты уточнения адресов зависят от страны и региона.
  • Адрес, указанный в запросе, сопоставляется со справочными данными в базе данных FedEx, и выдается совпадающий адрес.

Функции API проверки адресов

  • Предоставляет совпадения по названию улицы.
  • Получает ежемесячные обновления базы данных адресов.
  • Различает юридические и жилые адреса при обнаружении точного совпадения.
  • Пока не может проверять номера офисов или квартир.

Возможности API проверки адресов

  • Заполняет неполный адрес получателя. В некоторых случаях API проверки адресов может добавлять недостающую информацию, если предоставленные сведения можно проверить по справочным данным. API проверки адресов пока не может добавлять вторичную информацию (например, номера квартир или офисов).
  • Получает ежемесячные обновления базы данных адресов.
  • Исправляет недействительные адреса получателей. Например, исправляет неверный почтовый индекс в соответствии с остальными указанными данными.
  • Определяет, является ли адрес юридическим или жилым, что повышает точность применения льготных тарифов. Это относится только к адресам в США и Канаде.
  • Проверяет действительность и полноту адресов в США, Канаде и во многих странах Латинской Америки, Европы, Ближнего Востока и Азиатско-Тихоокеанского региона. Теперь вы можете проверить внутренние и зарубежные адреса перед отправкой посылки и, таким образом, избежать лишних задержек и дополнительных сервисных сборов.
  • Выдает совпадения по названию улицы.
  • В одном запросе API могут проверяться до 100 адресов.

Страны/территории, поддерживающие API проверки адресов

Вы можете использовать API проверки адресов FedEx для подтверждения и уточнения адресов получателей и эффективной доставки посылок в следующих странах:

Антильские острова Дания Панама
Аргентина Доминиканская Республика Перу
Аруба Эстония Португалия
Австралия Финляндия Сингапур
Австрия Франция Южно-Африканская Республика
Багамские острова Германия Испания
Барбадос Греция Швеция
Бельгия Гватемала Швейцария
Бермудские острова Специальный административный район Гонконг, Китай Тринидад и Тобаго
Бразилия Италия Соединенное Королевство
Канада Ямайка Соединенные Штаты Америки
Острова Кайман Малайзия Уругвай
Чили Мексика Венесуэла
Колумбия Нидерланды Виргинские острова
Коста-Рика Новая Зеландия  
Чехия Норвегия  

 

Примечание. Информация, отображаемая при запросе подтверждения адреса, носит исключительно рекомендательный характер.

Заявление об отказе от ответственности. Эти данные являются частной и конфиденциальной информацией FedEx, предоставленной по вашему запросу. Передавать какую бы то ни было часть этих данных в какой бы то ни было форме третьим сторонам без письменного разрешения FedEx запрещено. Эти данные отражают текущую классификацию юридических/жилых адресов FedEx в базе данных FedEx по адресам доставки и подлежат изменениям. Предоставляя эту информацию, FedEx не гарантирует ее точность на данный момент или в будущем, а также не гарантирует, что оплата посылок, отправляемых по этим адресам, будет взиматься в соответствии с указанной здесь классификацией юридических/жилых адресов. Предоставление этой информации не составляет изменение условий отношений между сторонами. Положения и условия, регулирующие доставку и сборы FedEx, см. в Руководстве по обслуживанию FedEx и в любом применимом соглашении о ценообразовании с клиентом FedEx.

Как работает API проверки адресов

Проверка адреса

Эту конечную точку можно использовать для проверки и уточнения введенных адресов и получения реально существующих адресов. Для уточнения адреса его нужно ввести и проверить. Адрес отмечается как уточненный, если введенный адрес совпадает с известными справочными данными.

С этим запросом связана следующая необходимая вводная информация:

  • улица, строки;
  • Город (необязательно)
  • код штата (необязательно);
  • почтовый индекс (необязательно);
  • Код страны

Примечание. Кода штата или названия города достаточно, если посылка отправляется в страну, где почтовые индексы не используются.

API проверки адресов возвращает реально существующий адрес, выполняя с указанным адресом следующие действия:

  • В первую очередь API пытается нормализовать указанный адрес. Сюда может входить замена общих идентификаторов улиц и проспектов на стандартные сокращения, например «ул» или «пр», а также изменение порядка компонентов адреса. Если указанный адрес нормализовать невозможно, в качестве уточненного адреса возвращается исходный указанный адрес. Неадресные значения отбрасываются.
  • Затем API пытается стандартизировать нормализованный адрес с помощью поиска возможного или фактического адреса, который имел в виду пользователь. Если стандартизация невозможна, в качестве уточненного адреса возвращается нормализованная форма исходного адреса. Возвращенные элементы помогут определить, какие проблемы возникли с указанным адресом.
  • Также возвращаются определенные элементы нормализованного адреса. Если стандартизация выполнена успешна, возвращаемый уточненный адрес будет реально существующим. В этом случае также возвращаются различные дополнительные элементы стандартизированного адреса и информация о том, каким образом он был получен из нормализованного адреса.

Значения, возвращаемые API проверки адресов

Если возвращенный адрес включает следующие значения для указанных ниже характеристик, значит, адрес действительный:

  • адрес штата стандартизирован;
  • характеристики уточненного адреса — верно;
  • действительный пункт доставки — верно;
  • интерполированный адрес — неверно.

Если эти характеристики не указаны, используйте для определения возможных проблем с данными адреса дополнительные атрибуты.

Дополнительную информацию по атрибутам адресов см. в разделе Атрибуты адресов.

Если отображается сообщение INTERPOLATED.STREET.ADDRESS, то существует вероятность, что адрес недействителен. Дополнительную информацию о кодах сообщений см. в описании элементов сообщений.

Код района (только для Пуэрто-Рико): этот дискриптор обычно используется в городских зонах Пуэрто-Рико и является важной частью адреса, т. к. описывает расположение указанной улицы. В Пуэрто-Рико к одному почтовому индексу могут относиться повторяющиеся названия улиц и номера домов. На этих улицах могут находиться дома с одинаковой нумерацией. В этих случаях код района необходим для правильной идентификации местонахождения конкретного адреса.

Например: Sr Pedro Rivera Urb Hermosillo 123 Calle 1 Bayamon, PR 00961-1212.

Примечания

API проверки адресов вместе с каждым проверенным и возвращенным адресом выдает примечания. В примечании содержится информация о том, что было не так в указанном адресе и какие изменения были в него внесены для получения реально существующего адреса.

Классификация адреса

Для определения классификации того или иного адреса API проверки адресов использует справочные данные. Классификация для функционального адреса определяется независимо от процесса проверки и основана на комментариях операционного персонала, в то время как источники коммерческих данных применяются только для подтверждения.

API проверки адресов предусматривает всего четыре возможных классификации для адресов: неизвестные, юридические, жилые и смешанные. Все адреса сначала получают классификацию «неизвестный» и сохраняют ее до тех пор, пока бизнес-правила не покажут, что классификацию следует изменить. Адрес получает классификацию «смешанный», если в здании размещаются как юридические адреса, так и жилые.

Примечание. FedEx Express предоставляет дополнительную строку адреса (строка адреса 3) для адресов получателей. Дополнительные данные позволяют получить более полную и точную информацию о местонахождении получателя и повышают вероятность выяснения точного адреса.

Реально существующие адреса классифицируются следующим образом:

Юридический адрес

Юридический адрес — это адрес, который используется для обозначения основного места деятельности. Предполагается, что по этому адресу организация осуществляет свою работу, но это не всегда так.

Юридический адрес — это официальное расположение офиса компании. Он может быть где угодно, от обычной квартиры до многомиллионного офисного здания (таким отдают предпочтения крупные технологические компании).

Адрес проживания

Тариф на доставку по жилому адресу применяется к посылкам в пределах США, отправляемым в многоквартирные или частные дома, включая домашние офисы. Услуга FedEx Home Delivery для доставки по жилому адресу через FedEx Ground в течение одного рабочего дня предоставляется в зависимости от расстояния до места назначения.

Примеры:

  • Дом священника
  • Монастырь
  • Дом пастора
  • Многоквартирные дома, например:
    • Апарт-отели
    • Кондоминиумы
    • Общежития учебных заведений
  • Жилой дом, где продаются и/или распространяются товары

Советы по использованию API проверки адресов

Несколько полезных советов по использованию API проверки адресов:

  • Правильно используйте пробелы: следите за правильной расстановкой пробелов, избегайте ненужных пробелов.
  • Проверяйте написание: избегайте орфографических ошибок и опечаток. Также проверяйте правильность использования цифры «0» и буквы «О».
  • Старайтесь не использовать специальные символы: избегайте использования специальных символов там, где они не требуются для написания адреса, например точек после аббревиатур («ул», а не «ул.»).
  • Указывайте дополнительную информацию об адресе и названии улицы: предоставляя дополнительную информацию об адресе, можно повысить точность результатов его проверки.
    • Номер дома или строения — 1, 1A, 1/2, один
    • Название улицы — Main, George Washington, 42nd
    • Описание улицы — улица, проспект, ул, пр
  • Указывайте город, штат/провинцию и ZIP-код или почтовый индекс: предоставление всех этих трех элементов повысит точность результатов проверки адреса.
  • Вводите название улицы и адрес в правильном порядке: элементы адреса обычно указываются в формате, который начинается с номера дома или строения, за которым следуют направление, название улицы, тип или обозначение улицы, дополнительный элемент направления, обозначение апартаментов, номер квартиры и/или обозначение и номер личного почтового ящика.
  • Используйте верные сокращения: в почтовых службах США и Канады приняты стандартные сокращения для обозначения штатов/провинций, улиц, апартаментов или офисов.
    • Нестандартное сокращение может привести к неверным результатам поиска.
    • Если вы не уверены в правильности сокращения, не используйте его.
  • Код района — код района обозначает область, сектор или жилой комплекс на определенной территории.

Например:

  • Номер дома или строения, например: 1, 1A, один.
  • Название улицы, например: Main, George Washington, 42nd.
  • Описание улицы, например: улица, проспект, ул, пр.
  • Указывайте название города, штат/провинцию и почтовый индекс: предоставление всех элементов адреса увеличит точность результатов. Код ZIP+4 в почтовом индексе для проверки адреса не требуется.
  • Используйте верные сокращения: в почтовых службах США и других стран приняты стандартные сокращения для обозначения штатов/провинций, улиц, апартаментов или офисов. Нестандартное сокращение может привести к неверным результатам поиска. Если вы не уверены в правильности сокращения, не используйте его.
  • Подумайте, не нужно ли сообщить результаты проверки адреса пользователю, чтобы он мог выбрать наиболее правильный для него адрес.

Правила работы

  • Не используйте этот API для определения возможности доставки по указанному адресу. FedEx не доставляет отправления на все существующие адреса. FedEx не доставляет отправления в абонентские ящики (кроме отправлений FedEx Ground® Economy, ранее FedEx SmartPost®).
  • Информация, отображаемая при запросе подтверждения адреса, носит исключительно рекомендательный характер.
  • В одном запросе могут проверяться до 100 адресов.
  • Минимально необходимые для заполнения поля могут различаться в зависимости от страны.

    Например, для США нужно заполнить как минимум одну строку адреса и почтовый индекс или город и код штата, а в австралийских адресах код штата можно опустить, даже если почтовый индекс не указан.

  • Результаты уточнения адресов зависят от страны и региона.

Примечание. API проверки адресов может работать не для всех стран. См. раздел Страны/территории, поддерживающие API проверки адресов.

Address Validation APi (1.0.0)

Validate Address

Use this endpointtt to get address resolution details. These details areee the outcome of validation and resolution of the input address. An address is stated as resolved when the input address matches the known reference data.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • Full_Schema_Validate_Address
  • Address_Validation_Canada
  • Address_Validation_US
  • Address_Validation_for_Germany
  • Address_Validation_for_Italy
  • Address_Validation_for_UK
inEffectAsOfTimestamp
string

This can be used to request the characteristics of an address had at a particular time in history. This defaults to current date time (of the Address Validation System). This is useful because the AddressValidation database is dynamic and stores historical data. Characteristics such as Business/Residential indicator may change over time.
Example: 2019-09-06

validateAddressControlParameters
object (AddressResolutionControlParameters)

Specify the parameters applied to validate the address.

addressesToValidate
required
Array of objects (ResolveContactAndAddress)

Indicate the address to be validated and resolved. This includes the address details, such as streetline, state or province code, country code and postal code.

Note: Up to 100 of these can be submitted in a single request.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /address/v1/addresses/resolve

Sandbox Server

https://apis-sandbox.fedex.com/address/v1/addresses/resolve

Production Server

https://apis.fedex.com/address/v1/addresses/resolve

Request samples - Validate Address

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "inEffectAsOfTimestamp": "2019-09-06",
  • "validateAddressControlParameters":
    {
    },
  • "addressesToValidate":
    [
    ]
}

Response samples - Validate Address

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "XXX_ORDERXXXX789",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Error Codes

  • DATESTAMP.FORMAT.INVALID

    Не удается обработать вашу заявку. Повторите попытку позже или обратитесь в отдел по работе с клиентами FedEx.

  • COUNTRY.CODE.INVALID

    Указан недопустимый код страны: {country_code}

  • STANDARDIZED.ADDRESS.NOTFOUND

    Нормализованный адрес не найден.

  • ACCOUNTVERIFICATION.ACCOUNT.NOTFOUND

    По указанным данным нельзя осуществить доставку.

CLOSE

Response

Copy