Introduktion
Advanced Integrated Visibility-kontonummerprenumerationen är utformad för att Advanced Integrated Visibility-prenumeranter ska kunna hantera sina kontonummerbaserade Advanced Integrated Visibility-projekt. De kan utföra projektrelaterade åtgärder som att redigera eller visa jobbinformation med hjälp av API-slutpunkter.
OBS!
- Du måste ha administrationsåtkomst för att nå API-projektet där API:et är aktiverat.
- Mer information om Advanced Integrated Visibility och dess funktioner finns på dokumentationssidan för Advanced Integrated Visibility.
Fördelarna med en Advanced Integrated Visibility-kontonummerprenumeration
Fördelarna med en Advanced Integrated Visibility-kontonummerprenumeration är:
- Du kan enkelt uppdatera och hantera Advanced Integrated Visibility-projekt genom att använda API-slutpunkterna.
- API:et gör det möjligt att koppla flera konton till ett projekt i en API-transaktion i stället för att välja ett konto i taget.
Så här fungerar Advanced Integrated Visibility-kontonummerprenumerationen
Använd följande slutpunkter för att hantera ditt Advanced Integrated Visibility-projekt:
Uppdatera Advanced Integrated Visibility-projektet
Använd den här slutpunkten för att uppdatera Advanced Integrated Visibility-projektinformationen för organisationen.
Uppgifterna som är associerade med begäran är:
- requestType: Ange typen av uppdateringsbegäran.
- ADD_ACCOUNTS: Använd det här alternativet för att lägga till nya konton i det befintliga projektet om organisationens konton redan är kopplade till ett Advanced Integrated Visibility-projekt.
- DELETE_ACCOUNTS: Använd det här alternativet för att ta bort alla konton från projektet.
- UPDATE_ALL: Använd det här alternativet för regelbundna projektuppdateringar.
Obs! Det är ett valfritt element och UPDATE_ALL är valt som standard, om det inte ändras av användaren. - category: Ange kategorin för den funktion du vill uppdatera för projektet. Till exempel: RETRY_POLICY, PROOF_OF_DELIVERY osv.
- subCategories: Ange de individuella funktionerna för den valda funktionskategorin. Till exempel: BASIC_HRS, PPOD, SPOD, SHIP, TRAN osv.
Ett framgångsrikt svar på den här begäran kommer att returnera prenumerations-ID:t, en indikator om projektet har uppdaterats för alla konton i organisationen och en tidsstämpel för det uppdaterade projektet.
Hämta projektinformation
Använd den här slutpunkten för att hämta projektinformation för ett specifikt Advanced Integrated Visibility-projekt i ett paginerat format.
De nödvändiga uppgifterna som är associerade med begäran är:
- authorization: Ange auktoriseringstoken.
- subscriptionId: Ange prenumerations-ID för att hämta Advanced Integrated Visibility-projektets information.
Ett framgångsrikt svar på den här begäran kommer att generera det specifika webhook-projektets information i ett paginerat format eller returnera en varning eller felinformation vid eventuella misslyckanden.
Företagsregler
- Maximalt 30 000 försändelsekontonummer kan kopplas till Advanced Integrated Visibility-projektet i samma begäran.
Response