Endpoint di transazioni e registri
La tua guida all'integrazione V5!
Introduzione
Oltre agli endpoint di esportazione visti finora nelle nostre guide all'integrazione V5, l'API V5 presenta anche diversi endpoint transazionali che possono essere utilizzati per restituire descrittori di eventi di sistema/logs su un ERP esterno.
Sommario
1. Endpoint del registro di sistema
Gli endpoint generici possono essere utilizzati per restituire un'ampia gamma di descrittori attraverso un numero di moduli diversi.
Questi endpoint restituiranno dati più complessi rispetto agli endpoint transazionali/generici e spesso conterranno più set di dati nidificati relativi agli eventi del descrittore. Sebbene ciò sia utile nel senso che verranno restituiti i dati corretti, questi endpoint dovranno spesso essere filtrati per utilizzare al meglio i dati restituiti.
Di seguito possiamo vedere cosa sono per l'API V5:
1.1. Registri di sistema
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/system_logs
Questo endpoint fornirà un file di ritorno JSON che incorpora contro tutti i evento di sistema descrittori e i dati che li riguardano. Se raggiungiamo questo endpoint otterremo un ritorno simile a questo:
Quindi possiamo vedere qui che sebbene stiamo ricevendo il descrittore 'CONSUMATO' verso il fondo di questa immagine per alcuni fili di zafferano utilizzati per un batch, stiamo anche ricevendo molti dati nidificati aggiuntivi, come un ritorno di classe completa per il fornitore e posizione che possiamo vedere qui.
Puoi impostare filtri nel tuo ERP per selezionare selettivamente i dati che desideri visualizzare.
Questo file di esempio può essere scaricato Qui..
Utile per:
1.2. Registro di sistema
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/system_log/{id}
Questo endpoint fornirà un file di ritorno JSON strutturato in modo simile all'esportazione "Log di sistema" sopra, ma qui possiamo specificare un numero ID di registro individuale per il quale restituire le informazioni associate. Questo è utile se vogliamo concentrarci su un evento specifico o descrittore.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
1.3. Registri di sistema di regolazione
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/adjustment_logs
Questo endpoint restituirà un file JSON con un elenco di eventi del registro di sistema con "ADJUSTMENT" descrittore, restringendo il risultato di ciò che abbiamo visto sopra per i "Registri di sistema" alle voci che contengono solo questo descrittore. Ciò aiuta a fornire dati più rilevanti che l'ERP può elaborare in base alle proprie esigenze.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
1.4. Registri di sistema consumati/prodotti:
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/system_logs_cp
Questo endpoint restituirà un file JSON con un elenco di eventi del log di sistema con "CONSUMED" o "PRODUCED" descrittore, restringendo il risultato di ciò che abbiamo visto sopra per i "Registri di sistema" alle voci che contengono questi descrittori. Questi registri riguardano il principale processo di batching, in particolare la riduzione e la produzione delle scorte. Ciò aiuta a fornire dati più rilevanti che l'ERP può elaborare in base alle proprie esigenze.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
1.5. Registri di sistema non consumati/prodotti:
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/system_logs_noncp
Questo endpoint agisce effettivamente come l'inverso dell'endpoint "Log di sistema consumati/prodotti" sopra e restituirà un file JSON che elenca i log di sistema con qualsiasi cosa tranne "CONSUMATO" o "PRODOTTO" descrittori.
Utile per:
1.6. Registri di utilizzo
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs
Questo endpoint restituirà un file JSON con un elenco di eventi del registro di sistema relativi al batch, restringendo il ritorno da ciò che abbiamo visto sopra per i "Registri di sistema" alle voci che contengono descrittori come 'FASCICOLATO', 'LOTTO SOSPESO' ecc. (oltre a 'CONSUMATO' e 'PRODOTTO'). Ciò aiuta a fornire dati più rilevanti che l'ERP può elaborare in base alle proprie esigenze.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
1.7. Registri di utilizzo (data filtro)
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs/filterFrom/{filterDate}
Questo endpoint restituisce le stesse informazioni dei "Log di utilizzo" sopra, ma consente un filtro dalla data (stamp temporale dell'epoca) per restringere i risultati, se lo si desidera.
Utile per:
1.8. Registri lavori
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/job_logs
Questo endpoint fornirà un file di ritorno JSON che incorpora system descrittori relativi alla produzione di lavoro.
È possibile scaricare un file di esempio di questo tipo Qui..
Utile per:
2. Endpoint transazionali/generici
Gli endpoint transazionali vengono utilizzati per restituire informazioni semplificate descrittore eventi che riguardano più specificamente il modo in cui i vari moduli gestiscono i livelli di inventario. A differenza degli endpoint generici che abbiamo visto sopra che forniscono una varietà di dati nidificati, questi endpoint forniscono informazioni semplificate senza dati nidificati.
Possiamo vedere come sarebbe nei nostri esempi qui sotto:
2.1. Operazioni di rettifica
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/adjustments
Questo endpoint può essere utilizzato per fornire un elenco di transazioni di rettifica che si sono verificate nel sistema. Utilizzando questo endpoint otterremo una voce restituita ogni volta che la quantità di un lotto viene modificata (o adeguata) utilizzando Control Center o WMS. Ciò potrebbe essere il risultato di danni o di merci scadute che devono essere rimosse dal sistema.
Un esempio di esportazione di questo tipo potrebbe assomigliare a questo:
Come possiamo vedere qui, questa è una singola voce per un 'ADJUSTMENT' descrittore evento e non contiene nessuno dei dati nidificati potenzialmente superflui che abbiamo visto con l'endpoint generico.
È possibile scaricare un file di esempio di questo tipo Qui..
Utile per:
2.2. Transazioni di consumo batch
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}
Un'esportazione di transazioni di consumo batch fornirà un file JSON semplificato che fornisce consumo e produzione descrittore dati relativi a uno specifico lotto completato che è stato elaborato dal sistema.
Utilizzando questo endpoint, otterremo un rendimento che mostrerà tutte le materie prime che sono state consumate nel batching e anche la quantità dei lotti stessi che è stata successivamente prodotta.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
2.3. Transazioni di consumo batch (data filtro)
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/filterfrom/{filterDate}
Questo endpoint restituisce le stesse informazioni di "Consumo batch" sopra, ma consente un filtro dalla data (stamp temporale dell'epoca) per restringere i risultati, se lo si desidera.
Utile per:
2.4. Transazioni degli ordini di acquisto
Esporta endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/purchase
Un'esportazione di transazioni di acquisto da questo endpoint fornirà un file JSON semplificato che fornisce i dati di ricezione rilevanti per gli ordini di acquisto, inclusi descrittori di sistema come "RICEVUTO".
L'endpoint fornisce questi dati solo per gli ordini completati che non sono stati contrassegnati come esportati.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
2.5. Transazioni degli ordini di vendita
Esporta endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/sales/{true/false}
Un'esportazione di transazioni di vendita da questo endpoint fornirà un file JSON semplificato che fornisce i dati di allocazione/prelievo/spedizione rilevanti per gli ordini di vendita. L'utilizzo di questo endpoint restituirà i dati relativi a tutti gli articoli venduti tramite ordini di vendita e descrittori come "RACCOLTO" e "Spedito".
L'endpoint può fornire questi dati per gli ordini completati (vero) o per tutti gli ordini (falso), a condizione che tali ordini non siano già stati contrassegnati come esportati.
È possibile scaricare un esempio di questo tipo di file Qui..
Utile per:
