Типы webhook Advanced Integrated Visibility
С помощью webhook Advanced Integrated Visibility FedEx рассылает по целевым URL-адресам защищенные оперативные сведения о событиях отслеживания посылок, связанных с соответствующими клиентскими номерами FedEx.
Вы можете создать проект webhook Advanced Integrated Visibility на FedEx Developer Portal, а затем связать его с одним или несколькими клиентскими номерами FedEx или номерами отслеживания FedEx в зависимости от выбранного вами типа подписки.
Перейдите по ссылке:
ПОДПИСКА НА ADVANCED INTEGRATED VISIBILITY ПО КЛИЕНТСКОМУ НОМЕРУ или ПОДПИСКА НА ADVANCED INTEGRATED VISIBILITY ПО НОМЕРУ ОТСЛЕЖИВАНИЯ, чтобы просмотреть шаги по созданию соответствующего webhook Advanced Integrated Visibility.
Обзор FedEx Advanced Integrated Visibility
Клиенты FedEx могут оформить подписку на оперативное получение уведомлений о связанных с отправлениями событиях для клиентского номера или номера отслеживания. Уведомления отправляются практически в режиме реального времени и затрагивают различные события — от создания этикеток до подтверждения доставки посылок (включая подтверждение доставки с помощью фото).
Типы подписки
Клиенты FedEx могут оформить подписку на Advanced Integrated Visibility следующими способами:
- по номеру счета, чтобы получать уведомления об отправлениях, связанных с определенной учетной записью;
- По номеру отслеживания: подпишитесь на номер отслеживания FedEx, чтобы получать обновления для отправлений с указанными номерами отслеживания через конечные точки API.
Примечание. В настоящее время для выставления счетов за подписку требуется 9-значный номер учетной записи FedEx, зарегистрированной в США. Размер ежемесячной оплаты зависит от количества номеров отслеживания. Более подробную информацию о тарифах Advanced Integrated Visibility можно найти в Обзорном справочнике по тарифам Advanced Integrated Visibility.
Для подписки по клиентскому номеру в настоящее время требуется 9-значная учетная запись отправителя FedEx из США.
В таблице ниже приведены особенности подписки на Advanced Integrated Visibility через клиентский номер и через номер отслеживания
| Функции | Подписка по клиентскому номеру | Подписка по номеру отслеживания |
|---|---|---|
| Ответ | Защищенные данные — это персональные данные, данные отправителя и получателя, данные удобных условий доставки (CDO) для подтверждения доставки подписью получателя/ответа | Анонимные данные включают в себя информацию об отправлении и состоянии доставки (кроме персональных данных/ответа) |
| Привязка | Привязка по клиентскому номеру = привязка всех связанных номеров отслеживания одновременно | Привязка номеров отслеживания |
| Принадлежность | Клиентские номера должны принадлежать пользователю | Номера отслеживания не должны принадлежать пользователю |
| Фильтрация | Возможность фильтровать события по статусу отправлений: получаемые, исходящие и сторонние |
Невозможно фильтровать события |
| Интеграция | Привязка клиентских номеров осуществляется через пользовательский интерфейс | Привязка номеров отслеживания осуществляется через конечные точки API |
| Ограничения | Можно добавить до 100 клиентских номеров | Можно добавить до 1000 номеров отслеживания за один запрос |
| Предполагаемые пользователи | Клиенты первой стороны (если номер принадлежит клиенту) | Клиенты третьей стороны (если клиент имеет номера отслеживания, принадлежащие клиентам первой стороны) |
FedEx Integrated Visibility — сравнение типов подписки
| Функция или элемент данных | Подписка по номеру отслеживания | Подписка по клиентскому номеру | Примечания |
|---|---|---|---|
| Подтверждение доставки подписью получателя (SPOD) | Недоступно | Есть (требует настройки) | TIFF-файл цифровой подписи в полезной нагрузке запроса |
| Подтверждение доставки с помощью фото (PPOD) | Есть (требует настройки) | Есть (требует настройки) | JPEG-файл с изображением места доставки в кодировке Base64 |
| Подтверждение попыток доставки с помощью фото (PPODA) | Есть (требует настройки) | Есть (требует настройки) | JPEG-файл с подтверждением попытки доставки |
| GPS-координаты (gpsPodCoordinates) | Недоступно | Доступно | Данные, замаскированные для подписок по номеру отслеживания |
| Контактная информация (имя, телефон, компания) | Замаскированные данные | Доступно | Отправитель, получатель, пункт отправления, пункт назначения, брокер и т. д. |
| Адрес и почтовый индекс | Замаскированные данные | Доступно | Улица и номер дома, а также почтовый индекс не отображаются в полезной нагрузке запроса по номеру отслеживания |
| Учетные записи | Замаскированные данные | Доступно | Параметры учетных записей плательщика, отправителя, получателя |
| Финансовые данные о посылке (declaredValue, codAmount) | Замаскированные данные | Доступно | Сведения о таможенном оформлении, наложенном платеже и объявленной стоимости |
| Сведения о запросе и данные для возврата (код запроса, причина возврата) | Замаскированные данные | Доступно | Подробные сведения доступны только при подписке по клиентскому номеру |
| Сведения о товаре и содержимом отправления | Замаскированные данные | Доступно | Коды мест груза, описание, количество |
| Идентификатор сотрудника (например, связанного с событием) | Замаскированные данные | Недоступно | Эти данные скрыты в обоих случаях в целях конфиденциальности |
| Уведомления о событиях, дате ожидаемой доставки и временном промежутке ожидаемой доставки | Доступно | Доступно | Сведения о дате и времени ожидаемой доставки доступны в обоих вариантах |
| Многоместное отправление (MPS) | Доступно | Доступно | Дополнительные данные отслеживания |
| Оценка рисков и ожидаемой доставки | Доступно | Доступно | Только на уровне Premium |
Поля маскировки данных для подписки номера отслеживания Advanced Integrated Visibility
Сводка
Если клиент подписывается на обновления статусов отслеживания по Номеру отслеживания, а не Учетной записи, для соблюдения конфиденциальности и выполнения требований безопасности данных отдельные поля данных маскируются.
Таким образом, вся конфиденциальная информация (личные контактные данные, адреса и финансовые показатели) будет доступна только уполномоченным лицам. Клиенты с подпиской по номеру отслеживания, будут видеть в соответствующих полях сообщения вида «XXXXX», даже если эти данные доступны по подписке.
Маскировка также подразумевает:
- ограниченный доступ к сведениям о пунктах отправления и назначения, а также об участниках события;
- отсутствие личных данных (имен, номеров телефонов), а также финансовых показателей и данных о таможенном оформлении;
- защита конфиденциальной и (или) служебной информации о посылках, в соответствии с требованиями законодательства и безопасности данных.
Если вам требуется доступ к замаскированным полям, лучше использовать для подписки учетную запись.
Поля МАСКИРОВКИ данных для подписки номера отслеживания Advanced Integrated Visibility:
Данные о сканировании
- scanEvent/location/locationContactAndAddress/address/streetLines
- scanEvent/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/location/locationContactAndAddress/contact/companyName
- scanEvent/location/locationContactAndAddress/contact/personName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/address/streetLines
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/companyName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/personName
Информация об отправителе
- trackResult/shipperInfo/contactAndAddress/address/postalCode
- trackResult/shipperInfo/contactAndAddress/address/streetLines
- trackResult/shipperInfo/contactAndAddress/contact/phoneNumber
- trackResult/shipperInfo/contactAndAddress/contact/companyName
- trackResult/shipperInfo/contactAndAddress/contact/personName
- trackResult/shipperInfo/account/value
Информация о получателе
- trackResult/recipientInfo/contactAndAddress/address/postalCode
- trackResult/recipientInfo/contactAndAddress/address/streetLines
- trackResult/recipientInfo/account/value
- trackResult/recipientInfo/contactAndAddress/contact/phoneNumber
- trackResult/recipientInfo/contactAndAddress/contact/companyName
- trackResultecipientInfo/contactAndAddress/contact/personName
Пункт отправления и пункт назначения
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/postalCode
Данные о доставке и об изменении адреса
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/gpsPodCoordinates
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/personName
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/personName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/companyName
Информация о брокере
- trackResult/broker/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/broker/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/broker/locationDetail/locationContactAndAddress/contact/personName
- trackResult/broker/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/broker/locationDetail/locationContactAndAddress/address/postalCode
Информация о посылке и оплате
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
Информация о товарах и запросах
- trackResult/inquiries/[Array]/categoryCode
- trackResult/inquiries/[Array]/code
- trackResult/inquiries/[Array]/createTime
- trackResult/inquiries/[Array]/statusCode
- trackResult/commodityInfo/[Array]/description
- trackResult/commodityInfo/[Array]/code
Содержимое посылки и причины возврата
- trackResult/contents/[Array]/partNumber
- trackResult/contents/[Array]/partCode
- trackResult/contents/[Array]/description
- trackResult/contents/[Array]/quantity
- trackResult/returnReason/[Array]/code
- trackResult/returnReason/[Array]/description
Информация для выставления счета
- trackResult/billToParties/[Array]/billToParty/accountNumber
Преимущества для клиентов
- Уведомления об изменениях даты ожидаемой доставки и ее временного диапазона в процессе пересылки увеличивают уверенности клиентов в своевременной доставке.
- Благодаря фотоподтверждению доставки FedEx снижаются расходы на обработку запросов о местонахождении заказов и споров о доставках.
- Уведомления о статусе доставки практически в реальном времени улучшают общие впечатления клиентов.
- Уведомления о статусе отправлений в реальном времени вместо непрерывного отслеживания отдельных посылок увеличивают операционную эффективность.
Функции и события отслеживания
События отслеживания
Это функция отправки уведомлений о различных этапах процесса доставки, позволяющая отслеживать статус отправлений. Клиент может выбрать определенный этап процесса доставки или конкретные события, для которых будут отправляться уведомления или оповещения. Можно указывать следующие события:
- Отправка — уведомления о событиях, связанные с выбранным отправлением. Например: создание этикетки, забор посылки и т. д.
- В пути. Уведомления, связанные с процессом перевозки отправления. Пример: отправление в пути, прибыло в отдел доставки и т п.
- Доставка. Уведомления, связанные с процессом доставки. Пример: передано для доставки, доставлено и т. п.
- Исключения. Уведомление отправляется в случае исключений при доставке. Пример: задержка таможенного отправления и т. п.
- Удобные условия доставки — выберите этот вариант, чтобы получать уведомления о событиях отслеживания, связанных с особыми клиентскими запросами. Например: принят запрос на хранение в офисе.
Дополнительную информацию о доступных событиях доставки см. в таблице Статусы и коды статусов для событий отслеживания Advanced Integrated Visibility.
Подтверждение доставки
Эта функция позволяет подтвердить успешную доставку заказа в пункт назначения. Это включает:
- Подтверждение доставки с помощью фото (PPOD). Эта функция позволяет клиентам получить снимок с точным положением посылки после ее доставки до двери.
Advanced Integrated Visibility передает фото для подтверждения доставки в полезной нагрузке JSON в формате Base64. Их можно преобразовать в формат JPEG.
Примечание:
- Функция подтверждения доставки с помощью фото доступна в Великобритании, Гонконге, Ирландии, Канаде, Новой Зеландии, Пуэрто-Рико и США.
- Функция подтверждения доставки с помощью фото доступна только для отправлений FedEx Ground и FedEx Express, а также для отправлений, доставляемых по жилым адресам.
- Функция подтверждения доставки с помощью фото доступна для соответствующих отправлений, если не требуется подтверждение доставки подписью получателя. Одновременное подтверждение доставки с помощью фото и подписи получателя невозможно.
- Функция подтверждения доставки с помощью фото доступна при доставке, для которой не требуется подпись, когда которые не вручаются клиенту лично.
- Функция подтверждения доставки с помощью фото поддерживает размер изображения от 14 000 до 33 000 байт (применимо для изображения с разрешением 320 x 240).
- Подтверждение доставки с помощью фото (PPODA) — эта функция позволяет клиентам получить фотографию места, куда должна быть доставлена посылка, если завершить доставку не удается. Advanced Integrated Visibility передает фото для подтверждения доставки в полезных данных JSON в формате Base64. Эти изображения можно затем преобразовать в формат JPEG.
- Функция подтверждения попытки доставки с помощью фото доступна в США и Пуэрто-Рико.
- Подтверждение попытки доставки с помощью фото доступно для услуг FedEx Ground, FedEx Express и при доставке личных и деловых отправлений на домашние адреса и адреса компаний.
- Возможные изображения для подтверждения попытки доставки с помощью фото:
- фотография дверной таблички на двери;
- фотография препятствия, мешающего попасть к точке доставки (например, запертых ворот);
- изображение доставленных отправлений в точке остановки.
- Функция подтверждения попытки доставки с помощью фото поддерживает размер изображения от 14 000 до 33 000 байт (применимо для разрешения 320 x 240)
- Подтверждение доставки подписью (SPOD). Эта функция позволяет клиентам получить изображение подписи получателя, а также его имя, адрес, время и место доставки. Данные о подтверждении доставки подписью будут представлены в виде массива байтов, а не изображения. Массив байтов — это строка в кодировке Base64, которую необходимо расшифровать, чтобы получить изображение в формате PNG.
- Подтверждение доставки подписью получателя (SPOD) недоступно при подписке на Advanced Integrated Visibility по номеру отслеживания.
- Функция подтверждения доставки подписью поддерживает размер изображения от 4000 до 6000 байт (применимо для изображения с разрешением 400 x 95).
- Функция подтверждения доставки подписью поддерживает размер изображения от 5000 до 8000 байт (применимо для изображения с разрешением 230 x 150).
- Подтверждение доставки с помощью GPS (GPSPOD)
- Функция подтверждения доставки с помощью GPS позволяет клиентам получать географические координаты местонахождения посылки.
Примечание. Подтверждение доставки с помощью GPS (GPSPOD) доступно по умолчанию при подписке на Advanced Integrated Visibility по клиентскому номеру.
- Функция подтверждения доставки с помощью GPS позволяет клиентам получать географические координаты местонахождения посылки.
События, связанные с датой ожидаемой доставки и временным диапазоном
Эта функция позволяет получателям планировать свое время, устанавливая дату и (или) временной диапазон доставки. Это включает:
- Дата ожидаемой доставки. Планируемая дата доставки отправления получателю. Пример: 20 ноября 20XX г.
- Временной промежуток ожидаемой доставки (EDTW) — планируемый временной диапазон доставки отправления в указанный день. Пример: с 14:00 до 18:00.
Фильтрация по событиям
Эта функция позволяет клиентам упорядочивать свои проекты Webhook по способам выставления счетов за отправления. Ниже перечислены доступные варианты.
- Получаемые. Выбирайте этот вариант для отправлений, которые будут доставлены вам и оплачены вами как получателем.
- Исходящие. Выбирайте этот вариант для отправлений, которые будут отправлены вами и оплачены вами как отправителем.
- Третье лицо. Выбирайте этот вариант для получаемых и исходящих отправлений, которые вы оплачиваете как сторонний плательщик.
Примечание. Для выставления счета и оплаты отправлений используется ваш клиентский номер FedEx. Выступая в роли стороннего плательщика, вы можете не быть отправителем или получателем, однако оплата будет списываться по вашему клиентскому номеру FedEx.
Политика повторных попыток
Эта функция не позволяет FedEx отправлять данные о событии отслеживания при возникновении проблемы на стороне клиента. FedEx сохраняет эти данные и пытается отправить их снова 3 раза с интервалом в 5 минут.
Если FedEx не получит ответ об успешной доставке в установленный срок, повторная доставка данных об этом событии прекращается. Однако клиент может запросить данные пропущенных событий за последние 7 дней с помощью кнопки «ПОВТОРИТЬ» на странице с подробными данными о проекте webhook Advanced Integrated Visibility.
Дополнительную информацию о политиках повтора см. в разделе Механизм повторов.
