info-icon


Webhook-guide för utvecklare

Introduktion

FedEx spårningswebhookar ger försändelseuppdateringar praktiskt taget i realtid under hela försändelseförloppet.

Till skillnad från spårnings-API:er som kräver applikationer för att begära försändelsestatus levererar webhookar automatiskt försändelseuppdateringar allt eftersom ny information blir tillgänglig.

Den här guiden omfattar:

  • Tre integrationsprinciper
  • Så fungerar webhookar
  • Bearbetning av webhook-nyttolaster
  • Kundaviseringar
  • Tidsstämplar
  • Bästa praxis och vanliga integreringsproblem

Tre integrationsprinciper

Lyckade webhook-integreringar följer tre principer.

Se varje webhook-nyttolast som en statusuppdatering för försändelsen

Anta inte att varje nyttolast representerar en ny spårningshändelse. FedEx publicerar en ny nyttolast varje gång ny försändelseinformation finns tillgänglig.

En nyttolast kan innehålla:

  • En ny spårningshändelse
  • Ny beräknad leveranstid
  • Information om leveransbevis
  • Mottagarinformation
  • Andra ändringar av försändelsedata

Flera nyttolaster kan dela spårningshändelse men innehålla olika försändelseinformation.

Lagra och slå ihop försändelsedata

Varje nyttolast kan innehålla ny eller uppdaterad försändelseinformation. Lagra alla webhook-nyttolaster och lägg till ny information i den befintliga försändelseposten.

Skriv inte över den befintliga försändelseposten med den senaste nyttolasten. Bevara i stället tidigare mottagna försändelsedata och komplettera med ny information för att hålla försändelseposten fullständig och aktuell under hela försändelseförloppet.

Låt företagsregler styra åtgärderna

Använd företagsregler för att avgöra när det är dags att uppdatera system eller meddela kunderna.

Utlös inte åtgärder enbart baserat på händelsekoder. Innan du uppdaterar applikationer eller skickar aviseringar till kunderna bör du utvärdera följande:

  • Spårningshändelser
  • Försändelsens tillgänglighet
  • Tidpunkt för aviseringar
  • Företagskrav

Rekommenderad bearbetningsmodell

Följande diagram visar hur de tre principerna för webhook-integrering samverkar i en typisk implementering. Varje webhook-nyttolast behandlas som en statusuppdatering för försändelsen, slås ihop i en centraliserad försändelsepost och utvärderas utifrån företagsregler innan applikationer uppdateras eller aviseringar skickas till kunderna.


Så fungerar webhookar

FedEx publicerar en ny webhook-nyttolast varje gång information om en försändelse ändras eller blir tillgänglig. En försändelse kan generera flera nyttolaster under hela försändelseförloppet, inklusive flera nyttolaster som är kopplade till samma spårningshändelse.

Ytterligare nyttolaster kan omfatta:

  • Spårningshändelser: Upphämtad, Under transport, Ute för leverans och Levererad.
  • Försändelsedata: Leveransbevis i bildformat (PPOD), Signerat leveransbevis (SPOD), Leveransbevis med GPS-data (GPS POD) och mottagarinformation.
  • Uppdateringar av beräknad leverans: Ändringar av beräknat leveransdatum och beräknad leveranstid.
  • Leveransundantag: Uppdateringar av och anledningar till försändelse- och leveransundantag.
  • Uppdateringar av försändelsens metadata: Adressuppdateringar, referenser och tjänsteinformation.
  • Operativa korrigeringar: Ytterligare spårningshändelser och previousEvents-uppdateringar.

Obs! Bildbevis är inte tillgängligt för alla levererade försändelser. Tillgängligheten beror på leveranstyp, krav på signatur och andra företagsregler.

Varje nyttolast representerar försändelsens senast kända tillstånd. Bearbeta varje nyttolast för att se till att försändelseposten förblir fullständig och aktuell.

Så här fungerar webhook-uppdateringar

Följande exempel visar hur flera webhook-nyttolaster kan genereras för samma försändelse under hela försändelseförloppet. Vissa nyttolaster lägger till en ny spårningshändelse. Andra lägger till försändelseinformation som beräknad leverans, leveransbevis eller försändelsedata.

Viktigt: Flera webhook-nyttolaster kan genereras för samma spårningshändelse. Bearbeta varje nyttolast för att se till att ny försändelseinformation läggs till i försändelseposten.


Bearbetning av webhook-nyttolaster

Bearbeta varje webhook-nyttolast som en statusuppdatering för försändelsen.

Anta inte att varje webhook-nyttolast representerar en ny spårningshändelse. FedEx skickar en ny nyttolast varje gång ny försändelseinformation tillkommer. Till exempel kan en levererad försändelse generera ytterligare nyttolaster när leveransbevis, mottagarinformation eller annan försändelseinformation läggs till eller uppdateras.

För varje nyttolast ska du fråga dig:

  • Vilken spårningshändelse ändrades?
  • Vilken försändelseinformation ändrades?
  • Påverkar uppdateringen en applikation som kunder använder?
  • Utlöser uppdateringen en avisering?

Bearbeta försändelsens historik

Övervaka både scanEvent och previousEvents.

  • scanEvent innehåller den aktuella spårningshändelsen som är kopplad till nyttolasten.
  • previousEvents innehåller ytterligare historik för försändelsen, inklusive händelser som kanske inte visas som det aktuella scanEvent.

Vissa spårningshändelser visas i previousEvents i stället för att visas som ett nytt scanEvent. Applikationer som endast bearbetar scanEvent kan missa försändelseuppdateringar och generera ofullständig försändelsehistorik. Bearbeta båda upphämtningarna för att få en fullständig bild av försändelsen.

Upprätthåll försändelseposten

Lagra alla webhook-nyttolaster och lägg till ny information i den befintliga försändelseposten.

En fullständig försändelsepost ger en överblick praktiskt taget i realtid över:

  • Instrumentpaneler för spårning av försändelser
  • Kundtjänstapplikationer
  • System för beställningshantering (OMS)

Uppdatera försändelseposten med varje nyttolast för att upprätthålla en korrekt och fullständig överblick över försändelsen.


Kundaviseringar

Välj en aviseringsstrategi utifrån dina företagskrav och hur pass detaljerad information om försändelsen du vill ge.

FedEx spårningswebhookar skickar uppdateringar om spårningshändelser och ändringar av försändelsedata praktiskt taget i realtid. Använd företagsregler för att avgöra vilka uppdateringar som är relevanta för företaget och vilka som kan ignoreras.

Vanliga aviseringsstrategier är:

Aviseringar praktiskt taget i realtid

Skicka aviseringar direkt efter att en spårningshändelse inträffar.

Fördelar

  • Den snabbaste kundkommunikationen
  • Den minsta fördröjningen

Att tänka på: Ytterligare försändelseinformation kanske inte är tillgänglig än.

Informationsrika aviseringar

Vänta i några minuter efter en spårningshändelse så att ytterligare försändelseinformation kan komma in.

Till exempel kan du vänta i några minuter efter en uppdatering om utförd leverans innan du samlar in:

  • Leveransbevis (POD)
  • Signerat leveransbevis (SPOD)
  • Leveransbevis med GPS-data
  • Mottagarinformation

Fördelar

  • Mer fullständiga försändelseuppdateringar för kunder
  • Färre uppföljningsaviseringar
  • Mindre kontakt med kundtjänst

FedEx rekommenderar att du väntar i ungefär fem minuter efter en uppdatering om utförd leverans eftersom leveransbevis ofta läggs till en kort stund efter den första leveransuppdateringen.

Rekommendationer om tidpunkt för aviseringar

Tidpunkten för aviseringar varierar beroende på kund och användningsområde. Dock används följande rekommendationer ofta för aviseringar till mottagaren efter ett köp. För andra sorters aviseringar (företagsanvändare, kundtjänstmedarbetare och så vidare) väljer du en aviseringsstrategi som passar användningsområdet.

  • Beräknad leverans: Vänta i ungefär 15 minuter efter att både det utfästa leveransdatumet och det första beräknade leveransdatumet (EDD) finns tillgängliga.
  • Ute för leverans: Skicka direkt eller enligt ditt företagsschema (till exempel dagligen kl. 08.00).
  • Levererad: Vänta i ungefär 5 minuter så att kompletterande leveransinformation hinner komma in.
  • Leveransförsök: Använd samma strategi som för Levererad för att få med leveransinformationen.

Skapa aviseringsregler utifrån företagsdata

Alla försändelseuppdateringar kräver inte en avisering. Skapa aviseringsregler som uppfyller företagets behov.

Rekommenderat tillvägagångssätt

Utlös inte aviseringar endast baserat på eventCode.

Utvärdera:

  • Spårningshändelsen
  • Den försändelsedata som krävs
  • Företagsregler

Generera endast aviseringar när information som krävs finns tillgänglig.

Det här tillvägagångssättet hjälper till att förhindra:

  • Dubbla aviseringar
  • Leveransinformation som saknas
  • Leveransaviseringar som är ofullständiga
  • Onödiga uppföljningsaviseringar

Tidsstämplar

Använd den tidsstämpel som passar ditt användningsområde.

  • eventCreateTime: Tidpunkten då försändelsehändelsen inträffade. Använd den i spårningshistoriken som visas för kunderna.
  • Message sent time: Tidpunkten då FedEx skickade webhook-nyttolasten. Använd den endast för felsökning och övervakning, inte i kundinriktat innehåll.

eventCreateTime anger när försändelsehändelsen inträffade. FedEx uppdaterar inte det här värdet när ytterligare försändelseinformation läggs till i efterhand. Till exempel behåller en leveranshändelse sin ursprungliga eventCreateTime även om senare nyttolaster lägger till information om leveransbevis eller andra försändelseuppdateringar. Därför ska eventCreateTime användas för att fastställa när händelsen inträffade, inte när relaterad försändelseinformation lades till.

I vissa fall kan händelsens tidpunkt vara otillgänglig. När det inträffar kan tidsstämpeln innehålla standardvärdet 00.00.00. Senare nyttolaster kan innehålla en mer exakt tidsstämpel när sådan finns tillgänglig.


Bästa praxis och vanliga integreringsproblem

Bästa praxis

  • Bearbeta alla webhook-nyttolaster – alla meddelanden kan innehålla nya spårningshändelser eller uppdaterad försändelseinformation.
  • Slå ihop stegvisa uppdateringar med din befintliga försändelsepost.
  • Övervaka både scanEvent och previousEvents för att få med hela försändelsens historik.
  • Utlös kundaviseringar utifrån företagsregler, inte bara själva händelserna.
  • Avsätt tid för förväntad tilläggsinformation (till exempel PPOD, SPOD, GPS) innan du meddelar kunderna.
  • Skapa en robust och feltålig bearbetning som kan hantera dubbla meddelanden och meddelanden som kommer i fel ordning.

Vanliga integreringsproblem

  • Att man antar att varje nyttolast representerar en ny spårningshändelse.
  • Att man skriver över försändelseposten med den senaste nyttolasten.
  • Att man enbart förlitar sig på scanEvent.
  • Att man utlöser aviseringar enbart baserat på eventCode.
  • Att man antar att den första nyttolasten innehåller all leveransinformation.
  • Att man antar att webhook-meddelanden bara kommer en gång eller i kronologisk ordning.

Sammanfattning

Bearbeta varje webhook-nyttolast som en statusuppdatering för försändelsen. Lagra och slå ihop försändelseuppdateringar, övervaka både scanEvent och previousEvents och använd företagsregler för att avgöra när du ska uppdatera applikationer eller meddela kunderna.

Det här tillvägagångssättet bidrar till en korrekt överblick över försändelsen, en fullständig spårningshistorik och mer välgrundad kundkommunikation.