API Ordini#
Descrizione#
L'API Ordini permette a un sistema esterno di inviare ordini ad Areagate e di consultare quelli gia' presenti.
E' utile quando un gestionale di terze parti deve trasmettere ad Areagate i propri ordini in modo automatico, senza doverli reinserire manualmente, e quando deve recuperare lo stato di avanzamento (ad esempio le quantita' gia' evase).
Operazioni disponibili#
| Operazione | Descrizione |
|---|---|
| Invio ordini | Trasmissione di uno o piu' ordini in un'unica richiesta |
| Lettura ordini | Consultazione degli ordini presenti, con filtri per cliente e codice ordine e paginazione |
| Lettura aggiornamenti | Consultazione degli ordini modificati a partire da un punto di sincronizzazione |
Informazioni necessarie per l'invio#
Per inviare un ordine, il sistema esterno deve fornire almeno:
- Tipo di ordine
- Codice dell'ordine nel sistema di origine (usato per riconoscere l'ordine ed evitare duplicati)
- Codice dell'azienda del gruppo a cui l'ordine fa riferimento
- Codice del cliente nel sistema di origine
- Righe dell'ordine, ciascuna con il codice della merce o della prestazione e la quantita'
Opzionalmente, per ogni riga, e' possibile indicare prezzo lordo, sconti, prezzo netto e importo. Se non indicata, la data dell'ordine viene impostata a quella odierna.
Informazioni restituite in lettura#
Per ogni ordine vengono restituiti, tra gli altri, i dati di testata (cliente, magazzino, causale, riferimenti all'ordine cliente, agente, listino, pagamento, vettore e porto) e le righe con codice merce o prestazione, quantita', prezzi, sconti, importo e quantita' gia' evasa.
Ogni ordine e ogni aggiornamento sono accompagnati da un identificativo di sincronizzazione, che il sistema esterno puo' usare per richiedere solo gli ordini cambiati dall'ultima lettura.
Filtri e paginazione#
In lettura e' possibile filtrare gli ordini per identificativo, per codice cliente o per codice ordine (ricerca parziale). I risultati sono paginati e ogni risposta contiene al massimo 200 ordini.
Gestione degli aggiornamenti#
Quando un ordine gia' inviato viene trasmesso nuovamente, Areagate lo riconosce dal codice di origine e ne aggiorna il contenuto: le righe vengono sostituite con quelle della nuova trasmissione.
Gli ordini gia' evasi non sono modificabili: eventuali nuove trasmissioni di un ordine evaso non ne alterano il contenuto.