Rodzaje elementów webhook Advanced Integrated Visibility
Dzięki elementom webhook Advanced Integrated Visibility system FedEx może przesyłać w czasie zbliżonym do rzeczywistego zabezpieczone dane dotyczące zdarzeń monitorowania na docelowy adres URL w przypadku przesyłek powiązanych z konkretnymi numerami kont FedEx.
W FedEx Developer Portal można utworzyć projekt elementu webhook Advanced Integrated Visibility, a następnie powiązać go z jednym lub kilkoma numerami kont FedEx lub numerami monitorowania przesyłek FedEx w zależności od wybranego typu subskrypcji.
Przejdź do:
SUBSKRYPCJA ADVANCED INTEGRATED VISIBILITY OPARTA NA NUMERZE KONTA lub SUBSKRYPCJA ADVANCED INTEGRATED VISIBILITY OPARTA NA NUMERZE PRZESYŁKI, aby się dowiedzieć, jak utworzyć odpowiedni element webhook Advanced Integrated Visibility.
Omówienie usługi FedEx Advanced Integrated Visibility
Klienci FedEx mogą zasubskrybować numer konta lub numer monitorowania przesyłki, aby w czasie zbliżonym do rzeczywistego otrzymywać zdarzenia związane z przesyłką będącą w drodze, od momentu utworzenia etykiety po doręczenie paczek, w tym potwierdzenie doręczenia ze zdjęciem.
Typy subskrypcji
Klienci FedEx mogą zasubskrybować usługę Advanced Integrated Visibility za pomocą następujących opcji:
- Według numeru konta — subskrypcja numeru konta FedEx w celu otrzymywania aktualizacji dotyczących przesyłek przyporządkowanych do danego konta.
- Według numeru monitorowania przesyłki — subskrypcja numeru monitorowania przesyłki FedEx w celu otrzymywania aktualizacji dotyczących przesyłek przyporządkowanych do określonych numerów monitorowania za pośrednictwem punktów końcowych API.
Uwaga: subskrypcje wymagają obecnie 9-cyfrowego numeru konta FedEx do rozliczeń w Stanach Zjednoczonych, a klienci są obciążani miesięczną opłatą na podstawie liczby numerów monitorowania. Aby dowiedzieć się więcej na temat cen usługi Advanced Integrated Visibility, zapoznaj się z Przewodnikiem po wycenie i Omówieniem usługi Advanced Integrated Visibility.
W przypadku subskrypcji według numeru konta subskrypcje wymagają obecnie 9-cyfrowych numerów kont wysyłkowych FedEx utworzonych w Stanach Zjednoczonych.
W poniższej tabeli znajdują się informacje o funkcjach subskrypcji opartych na numerze konta oraz subskrypcji Advanced Integrated Visibility opartej na numerze przesyłki
| Funkcje | Subskrypcja oparta na numerze konta | Subskrypcja oparta na numerze przesyłki |
|---|---|---|
| Odpowiedź | Dane zabezpieczone = dane umożliwiające identyfikację (PII) dane Nadawcy i Odbiorcy SPOD CDO (Wygodne opcje doręczeń)/odpowiedź | Dane anonimowe (obejmują aktualne informacje dotyczące przesyłki, transportu oprócz PII — danych umożliwiających identyfikację/odpowiedź |
| Powiązanie | Powiązanie jednego numeru konta = jednoczesne powiązanie wszystkich połączonych numerów monitorowania przesyłek | Powiązanie numerów monitorowania przesyłek |
| Własność | Numery kont muszą być własnością użytkowników | Numery monitorowania nie muszą być własnością użytkowników |
| Filtrowanie | Możliwość filtrowania zdarzeń według przesyłek przychodzących, wychodzących i przesyłek stron trzecich |
Nie można filtrować zdarzeń |
| Integracja | Powiązanie numerów kont odbywa się za pośrednictwem interfejsu użytkownika | Powiązanie numerów monitorowania odbywa się za pośrednictwem punktu końcowego API |
| Ograniczenie | Można dodać maksymalnie 100 numerów kont | Można dodać maksymalnie 1000 numerów monitorowania w żądaniu |
| Odpowiedni przypadek użycia | Klienci bezpośredni — jeśli klient jest właścicielem numerów kont | Klienci strony trzeciej — jeśli klient posiada numery monitorowania należące do klientów bezpośrednich |
FedEx Integrated Visibility — porównanie funkcji według typu subskrypcji
| Funkcja / element danych | Subskrypcja oparta na numerze przesyłki | Subskrypcja oparta na numerze konta | Uwagi |
|---|---|---|---|
| Potwierdzenie doręczenia podpisem (SPOD) | Niedostępne | Dostępne (wymaga konfiguracji) | Obraz podpisu w formacie TIFF, dostarczany w ładunku |
| Potwierdzenie doręczenia ze zdjęciem (PPOD) | Dostępne (wymaga konfiguracji) | Dostępne (wymaga konfiguracji) | Obraz JPEG przedstawiający miejsce doręczenia, zakodowany w standardzie base64 |
| Potwierdzenie prób doręczenia ze zdjęciem (PPODA) | Dostępne (wymaga konfiguracji) | Dostępne (wymaga konfiguracji) | Obraz JPEG dostarczany w ramach próby doręczenia |
| Współrzędne GPS (gpsPodCoordinates) | Niedostępne | Dostępne | Zamaskowane w subskrypcjach opartych na monitorowaniu |
| Informacje kontaktowe (imię i nazwisko lub nazwa, telefon, firma) | Zamaskowane | Dostępne | Dotyczy nadawcy, odbiorcy, pochodzenia, miejsca przeznaczenia, brokera itd. |
| Adres i kod pocztowy | Zamaskowane | Dostępne | W ładunkach opartych na monitorowaniu parametry streetLines i postalCode są zamaskowane |
| Numery kont | Zamaskowane | Dostępne | Obejmuje wartości billTo, nadawcy i konta odbiorcy |
| Informacje finansowe dotyczące paczki (np. declaredValue, codAmount) | Zamaskowane | Dostępne | Wartości deklarowane oraz dotyczące cła i płatności przy odbiorze są zamaskowane |
| Szczegóły zapytań i zwrotów (kody zapytań, przyczyny zwrotów) | Zamaskowane | Dostępne | Pełne informacje są wyświetlane tylko w przypadku subskrybentów mających konto |
| Dane dotyczące towaru i zawartości | Zamaskowane | Dostępne | Obejmuje numery części, opisy i ilość/liczbę |
| Identyfikator pracownika (np. personel związany ze zdarzeniem) | Zamaskowane | Niedostępne | Zamaskowany w obu przypadkach ze względu na ochronę prywatności |
| Powiadomienia o zdarzeniach oraz o EDD/EDTW | Dostępne | Dostępne | W obu przypadkach obsługiwane są funkcje dotyczące spodziewanej daty/szacowanych godzin doręczenia |
| Przesyłka wielopaczkowa (MPS) | Dostępne | Dostępne | Z dodatkowymi informacjami związanymi z monitorowaniem |
| Pewność co do spodziewanego terminu doręczenia i ocena ryzyka | Dostępne | Dostępne | Tylko na poziomie Premium |
Zamaskowane pola danych w przypadku subskrypcji Advanced Integrated Visibility opartej na numerze monitorowania
Podsumowanie
Gdy klienci subskrybują aktualizacje monitorowania przesyłek za pomocą subskrypcji Advanced Integrated Visibility opartej na numerze monitorowania zamiast subskrypcji Advanced Integrated Visibility opartej na numerze konta, określone pola danych są maskowane w celu zapewnienia prywatności klienta oraz zgodności z zasadami dotyczącymi bezpieczeństwa danych.
Dzięki maskowaniu informacje poufne — takie jak kontaktowe dane osobowe, adresy czy informacje finansowe — są dostępne tylko dla upoważnionych osób. Klienci korzystający z subskrypcji Advanced Integrated Visibility opartej na numerze monitorowania zobaczą w wymienionych poniżej zamaskowanych polach oznaczenie „XXXXX”, mimo że dane te mogą być dostępne w ramach tej subskrypcji.
Konsekwencje tego maskowania to między innymi:
- Ograniczona widoczność szczegółów dotyczących pochodzenia/miejsca przeznaczenia oraz zaangażowanych stron.
- Brak danych osobowych (np. imion i nazwisk, numerów telefonów) oraz danych finansowych lub celnych.
- Ochrona informacji zastrzeżonych lub poufnych dotyczących przesyłki mająca na celu zapewnienie bezpieczeństwa i zgodności z przepisami.
Klienci wymagający dostępu do tych maskowanych pól do celów operacyjnych lub biznesowych powinni wybrać subskrypcję opartą na numerze konta.
Dane MASKOWANE w przypadku subskrypcji Advanced Integrated Visibility opartej na numerze monitorowania:
Zdarzenia skanowania
- 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
Informacje o nadawcy
- 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
Informacje o odbiorcy
- 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
Pochodzenie i miejsce przeznaczenia
- 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
Szczegóły doręczenia i zmiany adresu
- 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
Informacja o brokerze
- 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
Szczegóły paczki i informacje finansowe
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
Zapytania i informacje o towarze
- trackResult/inquiries/[Array]/categoryCode
- trackResult/inquiries/[Array]/code
- trackResult/inquiries/[Array]/createTime
- trackResult/inquiries/[Array]/statusCode
- trackResult/commodityInfo/[Array]/description
- trackResult/commodityInfo/[Array]/code
Zawartość paczki i przyczyna zwrotu
- trackResult/contents/[Array]/partNumber
- trackResult/contents/[Array]/partCode
- trackResult/contents/[Array]/description
- trackResult/contents/[Array]/quantity
- trackResult/returnReason/[Array]/code
- trackResult/returnReason/[Array]/description
Informacje rozliczeniowe
- trackResult/billToParties/[Array]/billToParty/accountNumber
Korzyści dla klientów:
- Zwiększenie zaufania odbiorców dzięki proaktywnym powiadomieniom o zmianach spodziewanej daty doręczenia i okna czasowego doręczenia w trakcie przewozu.
- Obniżenie kosztów obsługi klienta związanych z połączeniami WISMO (gdzie jest moje zamówienie), a także sporami dotyczącymi doręczeń dzięki zapewnieniu przez FedEx potwierdzenia doręczenia ze zdjęciem.
- Zwiększenie komfortu obsługi klienta przez dostarczanie powiadomień o statusie przesyłki w czasie zbliżonym do rzeczywistego.
- Zwiększenie wydajności operacyjnej dzięki otrzymywaniu aktualizacji push na temat przesyłek w czasie rzeczywistym, zamiast ciągłego odpytywania w celu sprawdzenia aktualnych informacji dotyczących monitorowania poszczególnych przesyłek.
Funkcje i monitorowanie zdarzeń
Zdarzenia monitorowania
Ta funkcja umożliwia monitorowanie statusu przesyłek i powiadamianie klientów z wyprzedzeniem o różnych aktualizacjach w cyklu życia przesyłki. Klient może określić konkretny etap w procesie transportu przesyłki lub zdarzenia, o których chce otrzymywać powiadomienia. Dostępne zdarzenia związane z przesyłką:
- Wysyłka: w przypadku tej opcji powiadomienia są wysyłane w momencie wystąpienia wybranego zdarzenia związanego z przesyłką. Przykład: utworzenie etykiety, odbiór przesyłki itp.
- W drodze: w przypadku tej opcji powiadomienia są wysyłane w momencie wystąpienia zdarzeń związanych z transportem przesyłki. Przykład: przesyłka w drodze, przesyłka wstrzymana w dziale doręczeń itp.
- Doręczenie: w przypadku tej opcji powiadomienia są wysyłane w momencie wystąpienia zdarzeń związanych z doręczeniem przesyłki. Przykład: przesyłka wydana do doręczenia, przesyłka doręczona itp.
- Wyjątki: w przypadku tej opcji powiadomienia są wysyłane w razie wystąpienia wyjątków w doręczeniu. Przykład: opóźnienie w odprawie itp.
- Wygodne opcje doręczenia : w przypadku tej opcji powiadomienia są wysyłane w momencie wystąpienia niestandardowych zdarzeń związanych z monitorowaniem. Przykład: przyjęcie zgłoszenia zatrzymania w placówce.
Więcej informacji na temat dostępnych opcji zdarzeń dotyczących przesyłki można znaleźć w tabeli Kody statusów i statusy zdarzeń w usłudze Advanced Integrated Visibility.
Potwierdzenie doręczenia
Ta funkcja służy do potwierdzenia skutecznego doręczenia zamówienia do wskazanego miejsca przeznaczenia. Obejmuje to następujące elementy:
- Potwierdzenie doręczenia ze zdjęciem (PPOD): funkcja PPOD umożliwia klientom otrzymanie zdjęcia pokazującego dokładną lokalizację paczki po jej doręczeniu pod ich drzwi.
Usługa Advanced Integrated Visibility dostarcza obrazy PPOD w ładunku JSON w formacie base64. Obrazy można następnie konwertować na format JPEG.
Uwaga:
- Funkcja PPOD jest dostępna w USA, Kanadzie, Puerto Rico, Hongkongu, Nowej Zelandii, Wielkiej Brytanii i Irlandii.
- Funkcja PPOD jest dostępna tylko w przypadku usług FedEx Ground, FedEx Express oraz paczek doręczanych na adresy prywatne.
- Funkcja PPOD jest dostępna dla kwalifikujących się doręczeń, gdy nie jest wymagana funkcja SPOD. Nie jest możliwe jednoczesne korzystanie z funkcji PPOD i SPOD.
- Funkcja PPOD jest dostępna w przypadku doręczeń niewymagających podpisu, które nie obejmują przekazania przesyłki bezpośrednio klientowi (np. doręczenia do rąk własnych).
- Funkcja PPOD obsługuje obrazy o rozmiarze od 14 000 do 33 000 bajtów (dotyczy obrazów o rozdzielczości 320x240).
- Potwierdzenie próby doręczenia ze zdjęciem (PPODA): funkcja PPODA umożliwia klientom otrzymanie zdjęcia dokładnej lokalizacji miejsca dostarczenia paczki, na wypadek gdyby nie można było zrealizować doręczenia. Usługa Advanced Integrated Visibility dostarcza obrazy PPODA jako dane właściwe JSON w formacie base64. Obrazy można następnie przekonwertować do formatu JPEG.
- Funkcja PPODA jest dostępna w USA i Portoryko.
- Funkcja PPODA jest dostępna tylko w przypadku usług FedEx Ground, FedEx Express oraz paczek doręczanych na adresy prywatne i adresy firm.
- Obrazem PPODA może być:
- Zdjęcie obrazu PPODA awizo na drzwiach.
- Zdjęcie punktu zablokowania doręczenia (tj. zamknięta na klucz brama).
- Obraz PPOD paczek doręczonych do placówki.
- Funkcja PPODA obsługuje obrazy o rozmiarze od 14 000 do 33 000 bajtów (dotyczy obrazów o rozdzielczości 320x240).
- Potwierdzenie doręczenia podpisem (SPOD): pozwala klientom otrzymać zdjęcie podpisu odbiorcy, jego imienia i nazwiska oraz lokalizacji, a także daty i czasu doręczenia. Informacje dotyczące potwierdzenia doręczenia podpisem będą prezentowane jako tablica bajtów zamiast obrazu. Tablica bajtów to ciąg zakodowany w formacie base64, który należy odszyfrować w celu uzyskania docelowego zdjęcia podpisu w formacie PNG.
- W przypadku subskrypcji Advanced Integrated Visibility opartej na numerze monitorowania potwierdzenie doręczenia podpisem (SPOD) nie jest dostępne.
- Rozmiar obrazu SPOD będzie wynosił od 4000 do 6000 bajtów (dotyczy obrazów o rozdzielczości 400x95).
- Rozmiar obrazu SPOD będzie wynosił od 5000 do 8000 bajtów (dotyczy obrazów o rozdzielczości 230x150).
- Potwierdzenie doręczenia GPS (GPSPOD):
- GPS POD umożliwia klientom otrzymywanie współrzędnych geograficznych miejsca doręczenia.
Uwaga: w przypadku subskrypcji Advanced Integrated Visibility opartej na numerze konta domyślnie dostępne jest potwierdzenie doręczenia GPS (GPSPOD).
- GPS POD umożliwia klientom otrzymywanie współrzędnych geograficznych miejsca doręczenia.
Zdarzenia spodziewanej daty doręczenia i okna czasowego doręczenia
Ta funkcja pomaga odbiorcom przesyłek zaplanować harmonogram, wskazując datę i/lub przedział godzin doręczeń przesyłek. Obejmuje to następujące elementy:
- Spodziewana data doręczenia (EDD): w przypadku tej opcji jest podawana oczekiwana data doręczenia przesyłki do odbiorcy. Przykład: 20 listopada 20XX r.
- Szacowane godziny doręczenia (EDTW): w przypadku tej opcji odbiorcy jest podawane okno czasowe, w którym zgodnie z oczekiwaniami przesyłka ma zostać dostarczona w dniu doręczenia. Przykład: między godziną 14:00 a 18:00.
Filtrowanie na podstawie zdarzeń
Ta funkcja umożliwia klientom organizację projektów elementów webhook w zależności od metod rozliczenia przesyłek. Dostępne są następujące opcje:
- Przychodząca: wybierz tę opcję w przypadku przesyłek, które zostaną odebrane i opłacone przez Ciebie jako odbiorcę.
- Wychodząca: wybierz tę opcję w przypadku przesyłek, które zostaną wysłane i opłacone przez Ciebie jako nadawcę.
- Strona trzecia: wybierz tę opcję w przypadku przesyłek przychodzących i wychodzących, które opłacisz jako płatnik będący stroną trzecią.
Uwaga: do obciążenia lub zapłaty za przesyłki posłuży Twój numer konta FedEx. Chociaż płatnik będący stroną trzecią może nie być nadawcą przesyłki ani jej odbiorcą, jego konto FedEx zostanie obciążone związanymi z nią opłatami.
Zasady ponawiania
Ta funkcja uniemożliwia FedEx wysyłanie danych dotyczących zdarzeń monitorowania w przypadku problemu po stronie klienta. FedEx zachowa te dane i podejmie 3 próby ich ponownego wysłania w 5-minutowych odstępach.
Jeśli FedEx nie otrzyma prawidłowej odpowiedzi w zdefiniowanym przedziale czasowym, zaprzestanie ponownych prób dostarczenia informacji w odniesieniu do danego zdarzenia. Klient może jednak poprosić o przesłanie informacji o pominiętych zdarzeniach w okresie ostatnich 7 dni za pomocą ręcznego przycisku „PONÓW” na stronie szczegółów projektu elementu webhook Advanced Integrated Visibility.
Aby dowiedzieć się więcej na temat zasad ponawiania, zapoznaj się z sekcją Mechanizm ponawiania.
