Funzione: Products -> List

Questa funzione permette la ricerca dentro al database prodotti.

Parametri

Campo	Obbligatorio	Descrizione	Valori Ammessi
query	facoltativo	Parametri di ricerca Oggetto JSON tramite il quale è possibile specificare le chiavi di ricerca: (chiave = valore). Vedere sezione oggetto query più sotto per maggiori spiegazioni	Oggetto JSON
results	facoltativo	Numero dei risultati da visualizzare per pagina.	Numero. Predefinito: 10 risultati
page	facoltativo	Pagina da visualizzare Il sistema crea un numero di pagine sfogliabili in base al numero di risultati della ricerca e a quanti risultati si desidera vedere per pagina `results`	Numero. Predefinito: pagina 1
orderBy	facoltativo	Ordine di visualizzazione dei risultati Vedere sezione chiavi OrderBy supportate più sotto per maggiori spiegazioni	Stringa di testo contenente una chiave OrderBy supportata

Oggetto Query

Campo	Obbligatorio	Tipologia di ricerca	Descrizione	Valori Ammessi
general	facoltativo	estesa	Nome, marca, linea, versione, codice del prodotto che si desidera ricercare.	Stringa di testo
product	facoltativo	estesa	Nome del Prodotto che si desidera ricercare.	Stringa di testo
brand	facoltativo	estesa	Il nome del Marchio che si desidera ricercare.	Stringa di testo
line	facoltativo	estesa	Il nome della Linea di Prodotto che si desidera ricercare.	Stringa di testo

Chiavi OrderBy Supportate

OrderBy	Descrizione
product_id\|ASC	Ordinato per codice prodotto ascendente
product_id\|DES	Ordinato per codice prodotto discendente
code\|ASC	Ordinato per il codice interno ascendente
code\|DES	Ordinato per il codice interno discendente
brand\|ASC	Ordinato per nome del brand ascendente
brand\|DES	Ordinato per nome del brand discendente
line\|ASC	Ordinato per nome della linea ascendente
line\|DES	Ordinato per nome della linea discendente
name\|ASC	Ordinato per nome del prodotto ascendente
name\|DES	Ordinato per nome del prodotto discendente
version\|ASC	Ordinato per nome della versione del prodotto ascendente
version\|DES	Ordinato per nome della versione del prodotto discendente
price\|ASC	Ordinato per il prezzo di listino ascendente
price\|DES	Ordinato per il prezzo di listino discendente
vat\|ASC	Ordinato per l'aliquota IVA di riferimento ascendente
vat\|DES	Ordinato per l'aliquota IVA di riferimento discendente

Risultato

Campo	Obbligatorio	Descrizione	Valori Ammessi
nav	obbligatorio	Oggetto contenente i dati di navigazione.	Oggetto JSON
nav.page	obbligatorio	Numero di pagina visualizzato	Numero
nav.tot_pages	obbligatorio	Numero di pagine totali	Numero
nav.results	obbligatorio	Numero di risultati per pagina visualizzati	Numero
nav.tot_results	obbligatorio	Numero di risultato totali della ricerca	Numero
nav.orderBy	obbligatorio	Ordine di ricerca realmente applicato	Stringa di testo.
dataset	obbligatorio	Oggetto contenente i risultati	Oggetto JSON
dataset[n]	facoltativo	Oggetto contenente il risultato n	Oggetto JSON

La ricerca sui prodotti genera come risultati oggetti "prodotto". Per visualizzare la struttura di un oggetto prodotto, guarda il risultato della funzione products->get

Esempi

Esempio di ricerca di un prodotto inserito su Sirio.


require("SirioService.php");

//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
	
//Parametri
$dataset = [

	"q" => [						// "q" sta per "query"
		"product" => "viaggi"
	],
	"r"	=>	10,						// "r" sta per "results" , numero risultati per pagina
	"p"	=>	1,						// "p" sta per "page", numero della pagina da visualizzare
	"s"	=>	"name|DES"				// "s" sta per "sort"
	
];

//Eseguo il comando
$result = $sirio->sendCommand("products", "list", $dataset);

/*
{
	nav: {
		page: 1,
		tot_pages: 1,
		results: 10,
		tot_results: 3,
		orderBy: "name|DES"
	},
	dataset: {
		0: {
			product_id:	"1130196823",
			brand: "Alaska AirLines",
			line: "Viaggi",
			name: "Viaggio in Alaska",
			version: "Alta Stagione",
			description: "Viaggio in Alaska in alta stagione",
			unit: 4,
			price: 150,
			vat: 22,
			vat_type: 0,
			code: null,
			code_ean: null,
			code_taric: null,
			code_cpv: null,
			code_ssc: null,
			code_ateco: null,
			date_created: "2017-07-27 18:58:25",
			date_dismissed:	null
		},
		1: {
			...
		},
		2: {
			...
		}
	}
}

*/

Manuale Utenti

Manuale Sviluppatori