API v1 Documentation
Specifiche dialoghi scontrinato
Chiamate shelf
1. RICHIESTA VENDUTO: SCHEDE GIORNALIERE/SETTIMANALI/MENSILI NELL’INTERVALLO
https://www.irideshelf.com/api/v1/sold?frequency=w&pdv=l1jB13CR5nObreElOA1g0rPUoLr2&from=2021-12-01&to=2021-12-31
Vengono fornite tutte le schede GIORNALIERE/SETTIMANALI/MENSILI nell’intervallo, estremi inclusi, RELATIVAMENTE AI PRODOTTI DI SHELF
Tutti i parametri sono obbligatori, in mancanza di uno o più verrà restituito un array vuoto
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- frequency: può essere d, w o m
- from: Data inizio range
- to: Data fine range
4. RICHIESTA LISTA CATEGORIE ATTIVE NELL’INTERVALLO
https://www.irideshelf.com/api/v1/active-categories?frequency=w&pdv=l1jB13CR5nObreElOA1g0rPUoLr2&from=2021-01-01&to=2021-06-01
Viene fornita la lista di tutte le categorie che sono state movimentate, RELATIVAMENTE ALLO SHELF, nell’intervallo temporale, estremi inclusi
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- frequency: può essere d, w o m
- from: Data inizio range
- to: Data fine range
6. RICHIESTA CODICE MINSAN DA EAN
/richiedi-minsan?codice_ean=3337871320362
Viene restituito il codice minsan corrispondente all’ean inviato, oppure un messaggio di non trovato
Dati Forniti in GET:
- codice_ean: Codice EAN
Esempi di valori ritornati:
- Minsan trovato: {"codice_minsan": "912518471"}
- Minsan non trovato: {"msg": "codice non presente in banca dati"}
8. RICHIESTA DETTAGLI PRODOTTO
/product?codice_minsan=933151209
Viene restituito il dettaglio del prodotto col codice inviato, oppure un messaggio di non trovato
Dati Forniti in GET:
- codice_minsan: Codice MINSAN oppure codice_ean: Codice EAN
Esempi di valori ritornati:
- Minsan trovato: {"codice": "933151209", "codice_ean": "8058697280672", "descrizione": "BETOTAL 40CPR", "categoria": "INTEGRATORI"}
- Minsan non trovato: errore 404 oppure {"msg": "codice non presente in banca dati"}
Chiamate shelf OBSOLETE
1. RICHIESTA SCHEDE GIORNALIERE NELL’INTERVALLO
https://www.irideshelf.com/api/v1/daily-data?codice=001&pdv=l1jB13CR5nObreElOA1g0rPUoLr2&from=2021-12-01&to=2021-12-31
Vengono fornite tutte le schede GIORNALIERE nell’intervallo, estremi inclusi
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- from: Data inizio range
- to: Data fine range
2. RICHIESTA SCHEDE SETTIMANALI NELL’INTERVALLO
https://www.irideshelf.com/api/v1/weekly-data?codice=001&pdv=l1jB13CR5nObreElOA1g0rPUoLr2&from=2021-W26&to=2021-W31
Vengono fornite tutte le schede SETTIMANALI nell’intervallo, estremi inclusi
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- from: Anno e Numero Settimana inizio range
- to: Anno e Numero settimana fine range
3. RICHIESTA SCHEDE MENSILI NELL’INTERVALLO
https://www.irideshelf.com/api/v1/monthly-data?codice=001&pdv=l1jB13CR5nObreElOA1g0rPUoLr2&from=2021-01&to=2021-06
Vengono fornite tutte le schede MENSILI nell’intervallo, estremi inclusi
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- from: Anno e Numero mese inizio range
- to: Anno e Numero mese fine range
5. RICHIESTA DATI DI LISTA PRODOTTI
https://www.irideshelf.com/api/v1/product-list?codici=973321870,973321879
Viene fornito l’array con i dati di tutti i codici forniti con la seguente struttura: [Minsan, EAN, Descrizione, Categoria]
Dati Forniti in GET:
- codici: Lista di codici MINSAN
6. RICHIESTA CODICI MINSAN PER CATEGORIA
https://www.irideshelf.com/api/v1/minsan-for-category?codice=001&pdv=l1jB13CR5nObreElOA1g0rPUoLr2&from=2021-12-01&to=2021-12-31
Vengono forniti tutti i codici MINSAN, completi di descrizione movimentati COMPLESSIVAMENTE (NON SOLO SHELF) nell’intervallo, estremi inclusi
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- from: Data inizio range
- to: Data fine range
- codice: Codice Categoria (Banca Dati Federfarma)
7) RICHIESTA VENDUTO PER CODICE MINSAN NELL’INTERVALLO
https://www.irideshelf.com/api/v1/sold-for-minsan?pdv=l1jB13CR5nObreElOA1g0rPUoLr2&codici=973321870,973321879&from=2021-09-21&to=2021-11-30&frequency=D
Vengono forniti tutte le vendite GIORNALIERE per singolo codice, nell’intervallo temporale selezionato, secondo la seguente struttura:
[DAY, MINSAN, DESCRIZIONE, CATEGORIA, #PEZZI, FATTURATO]
I campi from e to vanno impostati correttamente rispetto alla frequenza, vedi chiamate 1,2 e 3.
Dati Forniti in GET:
- pdv: Codice Punto Vendita
- from: Data inizio range
- to: Data fine range
- freqyency: (D)aily, (W)eekly or (M)onthly
- codici: Codici minsan, separati da virgola