Endpoint di transazioni e registri
La tua guida all'integrazione V5!
Introduzione
Oltre agli endpoint di esportazione visti finora nelle nostre guide di integrazione V5, l'API V5 include anche diversi endpoint transazionali che possono essere utilizzati per restituire descrittori /log di eventi di sistema a un ERP esterno.
Sommario
1. Endpoint del registro di sistema
Gli endpoint generici possono essere utilizzati per restituire un'ampia gamma di descrittori provenienti da diversi moduli.
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 risposta JSON che include tutti i descrittori degli eventi di sistema e i dati ad essi relativi. Se accediamo a questo endpoint, otterremo una risposta simile a questa:
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 "Registri di sistema" descritta sopra, ma qui possiamo specificare un singolo ID di registro per il quale restituire le informazioni associate. Ciò è utile se si desidera concentrarsi su un evento o un descrittore specifico.
Un esempio di questo tipo di file può essere scaricato 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 di registro di sistema con il descrittore 'ADJUSTMENT' , restringendo il risultato rispetto a quanto visto in precedenza per i "Registri di sistema" alle sole voci che contengono questo descrittore. Ciò consente di fornire dati più pertinenti che il sistema ERP potrà elaborare in base alle vostre esigenze.
Un esempio di questo tipo di file può essere scaricato 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 contenente un elenco di eventi di registro di sistema con il descrittore "CONSUMED" o "PRODUCED" , restringendo il risultato rispetto a quanto visto in precedenza per i "Registri di sistema" alle sole voci che contengono questi descrittori. Questi registri si riferiscono al processo di elaborazione batch principale, in particolare alla riduzione e alla produzione delle scorte. Ciò contribuisce a fornire dati più pertinenti che il sistema ERP potrà elaborare in base alle vostre esigenze.
Un esempio di questo tipo di file può essere scaricato 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 funge di fatto da inverso dell'endpoint "Log di sistema consumati/prodotti" descritto sopra e restituirà un file JSON che elenca i log di sistema con qualsiasi descrittore tranne "CONSUMED" o "PRODUCED".
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 di registro di sistema relativi al batching, restringendo il risultato rispetto a quanto visto in precedenza per i "Registri di sistema" a voci che contengono descrittori come "COLLATED", "BATCH SUSPENDED" ecc. (oltre a "CONSUMED" e "PRODUCED"). Ciò consente di fornire dati più pertinenti che il sistema ERP potrà elaborare in base alle proprie esigenze.
Un esempio di questo tipo di file può essere scaricato 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 include i descrittori di sistema relativi alla produzione dei processi.
Un file di esempio di questo tipo può essere scaricato qui.
Utile per:
2. Endpoint transazionali/generici
Gli endpoint transazionali vengono utilizzati per restituire informazioni semplificate sugli eventi descrittivi che riguardano più specificamente il modo in cui i vari moduli gestiscono i livelli di inventario. A differenza degli endpoint generici visti in precedenza, che forniscono una varietà di dati annidati, questi endpoint forniscono informazioni semplificate senza dati annidati.
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, questa è una singola voce per un evento descrittore 'ADJUSTMENT' e non contiene alcuno dei dati annidati potenzialmente superflui che abbiamo visto con l'endpoint generico.
Un file di esempio di questo tipo può essere scaricato qui.
Utile per:
2.2. Transazioni di consumo batch
Endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}
L'esportazione delle transazioni di consumo in batch fornirà un file JSON semplificato contenente i dati descrittivi di consumo e produzione relativi a uno specifico batch completato ed 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.
Un esempio di questo tipo di file può essere scaricato 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
L'esportazione delle transazioni di acquisto da questo endpoint fornirà un file JSON semplificato contenente i dati di ricezione relativi agli ordini di acquisto, inclusi i descrittori di sistema come 'RECEIVED'.
L'endpoint fornisce questi dati solo per gli ordini completati che non sono stati contrassegnati come esportati.
Un esempio di questo tipo di file può essere scaricato 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}
L'esportazione delle transazioni di vendita da questo endpoint fornirà un file JSON semplificato contenente i dati di allocazione, prelievo e spedizione relativi agli ordini di vendita. L'utilizzo di questo endpoint restituirà i dati relativi a tutti gli articoli venduti tramite ordini di vendita e descrittori come "PRELEVATO" 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.
Un esempio di questo tipo di file può essere scaricato qui.
Utile per:
