Webservice‎ > ‎Inventory API‎ > ‎

List

La chiamata List ha la seguente firma:

InventoryListResponse List(InventoryListRequest request);

Cosa permette di fare

La chiamata List permette di ottenere rapidamente (senza dover passare tramite le Product API) lo stato a magazzino di alcuni prodotti che rispettano un determinato criterio. Può essere necessario, infatti, monitorare con frequenza lo stato di giacenza conosciuto da eDock relativamente a qualche articolo. Oppure può essere interessante verificare quali prodotti stanno per esaurirsi per determinare procedure di riordino. Oppure ancora potrebbe essere necessario verificare di quali prodotti si dispone di una certa quantità per offrire offerte speciali. Gli ambiti di applicazione sono diversi. Abbiamo deciso di rendere disponibile tale chiamata e di non obbligare a passare tramite le Product API per il semplice fatto che le Inventory API sono molto più leggere e rapide permettendo, quindi, una altrettanto rapida comunicazione tra le diverse applicazioni relativamente ad un argomento importante come quello delle giacenze.

Limitazioni

  • Non è possibile impostare un filtro su SKU basati su wildcard. Non è possibile, in altre parole, effettuare una chiamata chiedendo lo stato a magazzino di tutti i prodotti il cui codice inizia per 0001 oppure termina per 0503 oppure contiene 111.

Richiesta

In rosso sono evidenziate le proprietà obbligatorie.

 Proprietà Tipo Descrizione
 MaxQuantity Int Viene ritornato lo stato a magazzino per i soli prodotti che hanno al massimo questa quantità disponibile
 MinQuantity Int Viene ritornato lo stato a magazzino per i soli prodotti che hanno almeno questa quantità disponibile
 SKUList String[] Array di codici prodotto. Viene ritornato lo stato a magazzino per i prodotti che hanno codice prodotto pari ad uno di quelli presenti in questa lista. La lista non accetta il wildcard %.

Risposta

 Proprietà Tipo Descrizione
 InventoryStatus InventoryStatusEntry[] Contenitore delle risposte sullo stato a magazzino
 InventoryStatus.InventoryStatusEntry InventoryStatusEntry Contenitore di una risposta sullo stato a magazzino
 InventoryStatus.InventoryStatusEntry.SKU String
 SKU a cui si riferisce la risposta
 InventoryStatus.InventoryStatusEntry.Quantity Double Quantità dispnibile
 ErrorCode String
 Codice errore
 ErrorMessage String Messaggio d'errore
 Status Status Enumerativo che rappresenta lo stato di esecuzione della chiamata. Valori ammessi:
  • Success: la chiamata è stata eseguita senza errori.
  • Warning: la chiamata è stata eseguita per alcuni prodotti, ma non per tutti.
  • Error: la chiamata non è stata eseguita per nessun prodotto.

Errori possibili

 ErrorCode 
 Significato
 AUTH0001 Impossibile autenticare l'utente. Il nome utente o i token non sono validi o non sono corretti.
 INVENTORYLIST001 E' stato impostato male il filtro sulle quantità. Il valore MaxQuantity è minore del valore MinQuantity.
 GENERIC001 Errore non specificato.