La Sottoscrizione dei Codici Cliente alla Visibilità integrata avanzata è progettata per consentire agli iscritti alla Visibilità integrata avanzata di gestire il proprio Codice Cliente in base ai progetti di Visibilità integrata avanzata e di eseguire operazioni relative ai progetti come la modifica o la visualizzazione dei dettagli usando gli endpoint API.

Nota:

• È necessario disporre dell'accesso amministrativo per il progetto API in cui è abilitata questa API.
• Maggiori informazioni sulla Visibilità integrata avanzata e sulle sue funzionalità sono disponibili nella pagina della documentazione sulla Visibilità integrata avanzata.

I vantaggi della Sottoscrizione dei Codici Cliente alla Visibilità integrata avanzata sono i seguenti:

• La possibilità di aggiornare e gestire facilmente i Codici Cliente del progetto Visibilità integrata avanzata attraverso gli endpoint API.
• Questa API consente di associare più Codici Cliente al progetto in un'unica transazione API, invece di selezionare ciascun Codice Cliente uno alla volta.

Utilizzate i seguenti endpoint per gestire il progetto Visibilità integrata avanzata:

Aggiornare il progetto di Visibilità integrata avanzata

Utilizzate questo endpoint per aggiornare i dettagli della Visibilità integrata avanzata nell'organizzazione.

Le informazioni di input per questa richiesta sono:

• requestType: specificate il tipo di richiesta di aggiornamento. 
  • ADD_ACCOUNTS: utilizzate questa opzione per aggiungere nuovi Codici Cliente nel progetto esistente se l'organizzazione è già associata a un progetto di Visibilità integrata avanzata per tutti i Codici Cliente.
  • DELETE_ACCOUNTS: utilizzate questa opzione per eliminare qualsiasi Codice Cliente dal progetto.
  • UPDATE_ALL: utilizzate questa opzione per i normali aggiornamenti del progetto.
Nota: questo è un elemento facoltativo e UPDATE_ALL viene selezionato per impostazione predefinita, se non specificato dall'utente.
• category: specificate la categoria della funzionalità che desiderate aggiornare per il progetto. Esempio: RETRY_POLICY, PROOF_OF_DELIVERY ecc.
• subCategories: specificate le singole funzionalità per la categoria di funzionalità selezionata. Esempio: BASIC_HRS, PPOD, SPOD, SHIP, TRAN ecc.

Se la richiesta ha esito positivo, verrà restituito l'Id di sottoscrizione, un indicatore se il progetto è stato aggiornato per tutti i Codici Cliente nell'organizzazione e una marcatura oraria del progetto aggiornato.

Recuperare i dettagli del progetto

Utilizzare questo endpoint per recuperare i dettagli del progetto per un progetto di Visibilità integrata avanzata specificato in un formato impaginato.

Le informazioni di input necessarie per questa richiesta sono:

• authorization: specificate il token di autorizzazione.
• subscriptionId: specificate l'Id di sottoscrizione del progetto di Visibilità integrata avanzata per recuperare i dettagli.

Se la richiesta ha esito positivo, i dettagli del progetto webhook specificato verranno generati in formato impaginato, oppure verrà restituito un avviso o i dettagli sull'errore in caso di anomalie.

• In ogni richiesta è possibile associare un massimo di 30.000 Codici Cliente di spedizione a un progetto Visibilità integrata avanzata in una determinata richiesta.