API:et Advanced Integrated Visibility Tracking Number Subscription möjliggör för Advanced Integrated Visibility-prenumeranter att koppla spårningsnummer till ett webhookprojekt via API-slutpunkter. Funktionen koppling av spårningsnummer stöder två bearbetningsprocesser:

• Koppling av spårningsnummer – Synkront returnerar bearbetningsresultaten i samma HTTP-svar. Det här alternativet passar bäst för applikationer som kräver omedelbar bekräftelse vid koppling till ett mindre antal spårningsnummer. 
• Koppling av spårningsnummer – Asynkront skickar begäran om bakgrundsbearbetning och returnerar ett jobb-ID som kan användas för att hämta bearbetningsstatus och resultat senare. Det här alternativet passar bäst för att bearbeta större batcher med spårningsnummer. 

Välj den bearbetningsmetod som bäst uppfyller programmets krav på prestanda och arbetsbelastning.

OBS!

• Du måste ha administratörs- eller deltagaråtkomst till Advanced Integrated Visibility-projektet.
• Mer information om Advanced Integrated Visibility och dess funktioner finns på sidan Dokumentation för Advanced Integrated Visibility.

Advanced Integrated Visibility Tracking Number Subscription API har följande fördelar:

• Du kan enkelt koppla, uppdatera och hantera spårningsnummer i ditt Advanced Integrated Visibility-webhookprojekt genom att använda API-slutpunkterna.
• Du kan koppla flera spårningsnummer i en enda API-begäran i stället för att bearbeta varje spårningsnummer individuellt.
• Du kan välja mellan synkron bearbetning för omedelbara resultat eller asynkron bearbetning för större batcher.

Använd följande slutpunkter för att hantera ditt Advanced Integrated Visibility-projekt:

• Koppling av spårningsnummer – Synkront: tillåter att du kopplar spårningsnummer till en webhook och får den slutgiltiga bearbetningsstatusen i samma HTTP-svar.
• Koppling av spårningsnummer – Asynkront: tillåter att du kopplar spårningsnummer till en webhook, och använder det returnerade jobId senare för att kontrollera det asynkrona jobbets status eller ladda ner information genom att använda de relaterade slutpunkterna:    
  • Jobbstatus för spårningsnummer
  • Jobbuppgifter för spårningsnummer

Dessa API:er är tillgängliga i din översikt över Advanced Integrated Visibility-projekt.

Du kan endast komma åt dessa API:er via din projektöversikt, så som visas i skärmbilden ovan.

Den här tabellen sammanfattar skillnaderna mellan synkrona och asynkrona slutpunkter för koppling av spårningsnummer.
 

Använd den synkrona slutpunkten när du behöver omedelbar bekräftelse av mindre batcher av spårningsnummer. Använd den asynkrona slutpunkten när du bearbetar större batcher som inte kräver ett omedelbart svar.

Använd den här slutpunkten för att koppla ett eller flera spårningsnummer med ett Advanced Integrated Visibility-webhookprojekt och få bearbetningsresultaten i samma HTTP-svar.

Den här slutpunkten är avsedd för applikationer som kräver omedelbar bekräftelse och stöder begäranden som innehåller upp till 150 spårningsnummer.

Obligatoriska uppgifter: 

• Prenumerations-ID
• trackingNumber

Fördelar

Den synkrona slutpunkten ger följande fördelar:

• Omedelbara bearbetningsresultat
• Detaljerad information om lyckade eller misslyckade resultat i samma svar
• Stöder upp till 150 spårningsnummer per begäran
• Validering av begäranden och tillämpning av affärsregler före bearbetning
• Maskinläsbara felkoder och beskrivande felmeddelanden
• Transaktions-ID:n för spårning av begäranden och felsökningar

Koppling av spårningsnummer – Synkrona slutpunkter tillämpar följande valideringsregler:

• Kräver ett giltigt och aktivt subscriptionId
• Tillåter endast ett subscriptionId per begäran
• Kräver ett trackingNumber
• Säkerställer att alla spårningsnummer uppfyller FedEx formateringskrav, inklusive den maximala gränsen för spårningsnummer på 6 till 22 siffror

Felmeddelanden följer en konsekvent struktur med fel[] med en kod och meddelande för enkel parsning.

"errors": [

{

"code": "ERROR.CODE",

"message": "Descriptive error message"

}

Koppling av spårningsnummer – Synkrona slutpunkter stöder delvis lyckade resultat. När vissa spårningsnummer misslyckas returnerar det synkrona API:et fortfarande 200 OK och visar följande:

• failedTrackingNumbers
• Ett beskrivande meddelande

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "Below tracking numbers failed to upload due to validation or system errors"

      }

    }

Se avsnitten om Företagsregler för att läsa mer om regler och få ytterligare information.

Använd den här slutpunkten för att skicka in en eller flera prenumererade spårningsnummer för bakgrundsbearbetning.

Den här begäran returnerar ett jobb-ID som du kan använda med slutpunkten Tracking Number Job Status för att övervaka bearbetningen. Använd sedan slutpunkten Tracking Number Job Details för att ladda ner bearbetningsresultatet när jobbet är slutfört.

Obligatoriska uppgifter:

• Åtgärd
• Information om spårningsnummer

Du kan koppla upp till 1 000 spårningsnummer i en och samma begäran.

Fördelar

Den asynkrona slutpunkten ger följande fördelar:

• Stöder stora batchinlämningar med upp till 1 000 spårningsnummer
• Tillåter att långvariga begäranden bearbetas i bakgrunden
• Möjliggör övervakning av jobbstatus och nedladdningsbara bearbetningsrapporter
• Eliminerar problem med tidsgränser för begäranden vid hög arbetsbelastning

Använd den här slutpunkten för att visa statusen för ett asynkront jobb (en eller flera begäranden i rad i kö) eller status för alla inskickade jobb.

De nödvändiga uppgifterna som är associerade med begäran är:

• jobID – Ange jobb-ID:t som du vill hämta statusen för.

Obs! Jobb-ID är valfria indata för den här slutpunkten. Om du inte anger jobb-ID:t visas statusen för alla inskickade jobb.

Ett lyckat svar för den här begäran kommer att returnera jobb-ID, aktuell jobbstatus och tidsstämpel för jobbets skapande och slutförande. Svaret kommer att visa aktuell status för jobben. Svaret kommer dessutom att innehålla meddelanden om lyckade åtgärder, fel eller varningar som användarna kan visa och felsöka efter behov.

• Om jobbstatusen är SLUTFÖRT innebär det att alla spårningsnummer har validerats och bearbetats.
  • Statusen SLUTFÖRT innebär att spårningsnumren har validerats och bearbetats. Det innebär inte att alla spårningsnummer har lagts till i Advanced Integrated Visibility-projektet. 
  • För jobb med flera spårningsnummer kan statusen anses vara SLUTFÖRT, även om vissa nummer inte kan kopplas till projektet och andra lyckas. Ladda ner batchrapporten för att bekräfta statusen för varje spårningsnummer i den ursprungliga kopplingsbegäran.

Obs! Om jobbstatusen är MISSLYCKAT innebär det att begäran inte kunde bearbetas på grund av olika orsaker/fel och att användaren måste försöka igen.

Följande tabell visar jobbstatusarna och deras beskrivningar:

Använd den här slutpunkten för att ladda ner JSON-rapporten för ett asynkront jobb med statusen SLUTFÖRT.

De nödvändiga uppgifterna associerade med denna begäran är:

• jobID – Ange jobb-ID:t som du vill hämta statusen för. Ett jobb-ID är obligatoriskt för den här slutpunkten.

OBS!

• Du kan endast ladda ner en jobbrapport åt gången.
• Ett felmeddelande kommer att visas om du försöker att ladda ner rapporten för ett jobb som inte har statusen SLUTFÖRT.

Ett lyckat svar för den här begäran kommer att tillhandahålla rapporten för jobbet i JSON-format.

Vanliga företagsregler

• Det finns ingen gräns för det totala antalet spårningsnummer som kan kopplas till ett Advanced Integrated Visibility projekt.
• De spårningsnummer som är kopplade till ett Advanced Integrated Visibility-projekt kommer att kopplas bort 40 dagar efter att de har kopplats till webhooken.
• Skyddad spårningsinformation som mottagaradress, mottagarens signatur och känslig leveransinformation är inte tillgängligt via Tracking Number Subscription API.

Företagsregler för den synkrona slutpunkten

• Maximalt 150 spårningsnummer per begäran.
• Alla spårningsnummer måste använda samma subscriptionId.
• Den angivna Advanced Integrated Visibility-webhookprenumerationen måste vara giltig och aktiv.
• Alla begäranden har en tidsgräns på 30 sekunder.

Företagsregler för den asynkrona slutpunkten

• Maximalt 1 000 spårningsnummer per begäran.
• Jobbstatus och jobbinformation för en asynkron begäran sparas i 90 dagar efter att spårningsnumren har kopplats till Advanced Integrated Visibility-webhooken.