API'en Advanced Integrated Visibility Tracking Number Subscription giver abonnenter på Advanced Visibility muligheden for at tilknytte trackingnumre med et webhook-projekt ved hjælp af API slutpunkter. Tracking Number Association-funktionen understøtter to behandlingsmetoder:

• Tracking Number Association– Synchronous returnerer behandlingsresultaterne i samme HTTP-svar. Denne mulighed egner sig bedst til handlinger, der kræver øjeblikkelig bekræftelse, når der tilknyttes et mindre antal trackingnumre. 
• Tracking Number Association – Asynchronous indsender anmodningen om baggrundsbehandling og returnerer et job-id, der kan bruges til at hente behandlingsstatus og -resultater senere. Denne mulighed egner sig bedst til at behandle store batches med trackingnumre. 

Vælg den behandlingsmetode, der passer bedst til kravene til din applikations ydeevne og arbejdsbyrde.

Bemærk:

• Du skal have administrator- eller bidragsyderadgang til dit Advanced Integrated Visibility-projekt
• For flere oplysninger om Advanced Integrated Visibility og dets funktioner kan du se siden Advanced Integrated Visibility-dokumentation.

Advanced Integrated Visibility Tracking Number Subscription API er forbundet med følgende fordele:

• Du kan nemt tilknytte, opdatere og styre trackingnumre for dit Advanced Integrated Visibility webhook-projekt ved hjælp af API'ens slutpunkter.
• Tilknyt flere trackingnumre i én enkelt API-anmodning i stedet for at behandle hvert trackingnummer enkeltvist.
• Vælg mellem synkron behandling for øjeblikkelige resultater, eller asynkron behandling for tørre batch-behandlinger.

Brug følgende slutpunkter til at administrere dit Advanced Integrated Visibility-projekt:

• Tracking Number Association – Synchronous: giver dig mulighed for at tilknytte trackingnumre med en webhook, og modtage den endelige behandlingsstatus i det samme HTTP-svar.
• Tracking Number Association – Asynchronous: giver dig mulighed for at tilknytte trackingnumre med en webhook og bruge det returnerede jobID senere for at kontrollere status på det asynkrone job, eller downloade oplysninger ved hjælp af relaterede slutpunkter:    
  • Trackingnummerjobstatus
  • Trackingnummerjoboplysninger

Disse API'er er tilgængelige fra din Advanced Integrated Visibility-projektoversigt.

Disse API'er kan udelukkende tilgås via din projektoversigt, som vist på skærmbilledet ovenfor.

Følgende tabel opsummerer forskellene mellem de synkrone og asynkrone trackingnummer-slutpunkter.
 

Brug det synkrone slutpunkt, når du skal bruge øjeblikkelig bekræftelse af mindre batches af trackingnumre. Brug det asynkrone slutpunkt til behandling af større batches, som ikke kræver øjeblikkeligt svar.

Brug dette slutpunkt for at tilknytte et eller flere trackingnumre til er Advanced Integrated Visibility webhook-projekt og få behandlingsresultaterne sammen med det samme HTTP-svar.

Dette slutpunkt er beregnet til applikationer, der kræver øjeblikkelig bekræftelse og understøtter anmodninger, der indeholder op til 150 trackingnumre.

Påkrævet input: 

• subscriptionID
• trackingNumber

Fordele

Det synkrone slutpunkt er forbundet med følgende fordele:

• Øjeblikkelige behandlingsresultater
• Detaljeret succes- og fejlinformation i et enkelt svar
• Understøtter op til 150 trackingnumre pr. anmodning
• Anmod om validering og håndhævelse af forretningsregler inden behandlingen
• Maskinlæsbare fejlkoder og deskriptive fejlmeddelelser
• Transaktions-id'er til sporing og fejlfinding af anmodninger

Slutpunktet Tracking Number Association – synkront håndhæver flere valideringsregler, herunder:

• Kræver er gyldigt og aktivt subscriptionId
• Tillader kun ét subscriptionId pr. anmodning
• Kræver et trackingNumber
• Sikrer, at trackingnumre overholder FedEx' krav til formatering, herunder den maksimale grænse for trackingnumre på 6 til 22 cifre

Fejlsvar følger en konsekvent struktur med fejl[], der indeholder kode og meddelelser for nem parsing.

"errors": [

{

"code": "FEJLKODE",

"message": "Deskriptiv fejlmeddelelse

}

Slutpunktet Transaction Number Association – Synchronous tillader delvis gennemførelse. Hvis der er fejl i nogle trackingnumre vil den synkrone API stadig returnere 200 OK og vise følgende:

• failedTrackingNumbers
• En deskriptiv meddelelse

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "Nedenstående trackingnumre kunne ikke uploades grundet validerings- eller systemfejl"

      }

    }

Se afsnittet om forretningsregler for yderligere information og regler.

Brug dette slutpunkt for at sende et eller flere tilknyttede trackingnumre til baggrundsbehandling.

Anmodningen returnerer et job-id, der kan bruges sammen med slutpunktet Tracking Number Job Status til at overvåge behandling og med slutpunktet Tracking Number Job Details til at downloade behandlingsresultater, når jobbet er afsluttet.

Påkrævet input:

• Handling
• Trackingnummeroplysninger

Du kan tilknytte op til 1.000 trackingnumre i én enkelt anmodning.

Fordele

Det asynkrone slutpunkt er forbundet med følgende fordele:

• Understøtter store batch-indsendelser på op til 1.000 trackingnumre
• Muliggør, at langvarige behandlinger behandles i baggrunden
• Aktiverer overvågning af jobstatus og behandlingsrapporter, der kan downloades
• Fjerner problemer med timeout af anmodninger for store arbejdsbyrder

Brug dette slutpunkt til at få status på et asynkront job (en eller flere på hinanden følgende anmodninger i kø) eller statur på alle sendte jobs.

De påkrævede indtastningsoplysninger for denne anmodning er:

• jobID – Præciser det job-id, for hvilket du vil hente status.

Bemærk: Job-id er et valgfrit input for dette slutpunkt. Hvis du ikke præciserer et job-id, får du status på alle sendte jobs.

Det vellykkede svar på denne anmodning vil returnere jobID, aktuel jobstatus og tidsstempel for joboprettelse og jobfærdiggørelse. Svaret vil vise aktuel status på valgte jobs. Derudover vil svaret også indeholde vellykkede svar, fejl eller advarsler, så brugere kan se og foretage fejlsøgning, når relevant.

• Hvis jobstatus vises som GENNEMFØRT, betyder det, at alle trackingnumre er valideret og behandlet korrekt.
  • Statussen GENNEMFØRT indebærer, at trackingnumrene er valideret og behandlet korrekt. Det indebærer ikke, at alle trackingnumrene er blevet tilføjet Advanced Integrated Visibility-projektet.
  • For jobs med flere trackingnumre kan status betragtes som GENNEMFØRT, selvom nogle numre ikke kan tilknyttes projektet, og andre kan. For at bekræfte status for hvert trackingnummer i den oprindelige trackinganmodning skal batch-rapporten downloades.

Bemærk: Hvis jobstatus vises som MISLYKKEDES, indebærer det, at anmodningen på grund af flere årsager/alvorlige fejl ikke kunne behandles, og brugeren skal prøve igen.

Følgende tabel viser jobstatusserne og de respektive beskrivelser:

Brug dette slutpunkt for at downloade en JSON-rapport for et asynkront job med statussen GENNEMFØRT.

De påkrævede indtastningsoplysninger knyttet til denne anmodning er:

• JobID – Præciser det job-id, for hvilket du vil hente status. Et job-id er påkrævet for dette slutpunkt.

Bemærk:

• Du kan kun downloade én asynkron jobrapport på samme tid.
• Hvis jobbet ikke er GENNEMFØRT, og du forsøger at downloade rapporten, vil en fejlmeddelelse blive vist.

Det vellykkede svar på denne anmodning giver dig jobrapporten i JSON-format.

Almindelige forretningsregler

• Der er ingen grænse for, hvor mange trackingnumre kan tilknyttes et Advanced Integrated Visibility-projekt.
• Trackingnumre, der er tilknyttet et Advanced Integrated Visibility-projekt fjernes 40 dage, efter de er tilknyttet webhook'en.
• Sikre trackingoplysninger, såsom modtagerens adresse, modtagerens underskrift, og følsomme leveringsoplysninger er ikke tilgængelige denne Tracking Number Subscription API'en.

Forretningsregler for slutpunktet Synchronous

• Maks. 150 trackingnumre pr. anmodning.
• Alle trackingnumre skal bruge det samme subscriptionId.
• Det angivne Advanced Integrated Visibility webhook-abonnement skal være gyldigt og aktivt.
• Der gælder en timeout på 30 sekunder for anmodninger.

Forretningsregler for slutpunktet Asynchronous.

• Maks. 1.000 trackingnumre pr. anmodning.
• Jobstatus og -oplysninger for en asynkron anmodning opbevares i 90 dage, efter trackingnumrene er blevet tilknyttet Advance Integrated Visibility webhook'en.