API Distinte Base¶
Cosa permette di fare¶
L'API Distinte Base consente a un sistema esterno di:
- Consultare le distinte base presenti su Areagate, con possibilita' di filtrare per gruppo, sottogruppo o codice della merce padre
- Sincronizzare le distinte modificate dopo un determinato momento
Gli endpoint sono di sola lettura: le distinte vengono alimentate dal gestionale.
Consultazione distinte base¶
Lista distinte¶
Permette di ottenere l'elenco delle distinte base attive. E' possibile filtrare per:
- Gruppo: ricerca esatta per gruppo della merce padre
- Sottogruppo: ricerca esatta per sottogruppo della merce padre
- Codice: ricerca esatta per codice merce della distinta
I risultati sono impaginati (massimo 200 per pagina).
Per ogni distinta vengono restituiti:
- I dati della merce padre (gruppo, sottogruppo, codice, codice host, stato cancellazione)
- L'elenco completo dei componenti, ciascuno con progressivo, codice, codice host, quantita' e stato cancellazione
- L'ID di sincronizzazione massimo tra i componenti
Distinte aggiornate¶
Permette di ottenere solo le distinte in cui almeno un componente e' stato modificato dopo un determinato punto di sincronizzazione. Utile per mantenere allineato un sistema esterno senza dover rileggere tutte le distinte ogni volta.
Quando una distinta viene restituita, contiene tutti i componenti (non solo quelli modificati), cosi' il sistema esterno puo' ricostruire lo stato completo.
Dati restituiti¶
Testata distinta¶
| Campo | Descrizione |
|---|---|
| Gruppo, sottogruppo, codice | Identificativi della merce padre |
| Codice host | Codice della merce padre nel sistema esterno |
| Sincronizzazione | Punto di sincronizzazione (il massimo tra i componenti) |
| Cancellato | Indica se la merce padre e' stata rimossa |
| Componenti | Elenco dei componenti della distinta |
Componente¶
| Campo | Descrizione |
|---|---|
| Progressivo | Numero d'ordine del componente nella distinta |
| Gruppo, sottogruppo, codice | Identificativi della merce componente |
| Codice host | Codice del componente nel sistema esterno |
| Quantita' | Quantita' necessaria per una unita' di distinta |
| Cancellato | Indica se il componente e' stato rimosso dalla distinta |
Note¶
- Il punto di sincronizzazione della testata e' il massimo tra tutti i componenti: usare questo valore come punto di partenza per la chiamata successiva.
- I componenti con stato "cancellato" indicano righe rimosse dalla distinta: il sistema esterno deve aggiornare il proprio stato di conseguenza.
- Le distinte con stato "cancellato" sulla testata indicano che la merce padre e' stata rimossa: il sistema esterno deve rimuovere la distinta.
- Limite massimo per risposta: 200 distinte.