Funzione: CustomersOrders -> List

Questa funzione permette la ricerca dentro al database ordini clienti.

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, negozio, prodotto dell'ordine cliente che si desidera ricercare.	Stringa di testo
customer_name	facoltativo	estesa	Nome cliente dell'ordine che si desidera ricercare.	Stringa di testo
product_name	facoltativo	estesa	Nome prodotto a cui è associato l'ordine che si desidera ricercare.	Stringa di testo
shop_name	facoltativo	estesa	Nome negozio a cui è associato l'ordine che si desidera ricercare.	Stringa di testo
status	facoltativo	flag	Stato dell'ordine che si desidera ricercare.	Codice numerico: 0 = Completato 1 = Sospeso 2 = Bloccato 3 = In lavorazione 4 = Assegnato 5 = Inevaso 6 = Tutti gli stati
status_invoice	facoltativo	flag	Stato della fattura associata all'ordine che si desidera ricercare.	Codice numerico: 0 = Solo Incompleti 1 = Solo 100% fatturati 2 = Tutti

Chiavi OrderBy Supportate

OrderBy	Descrizione
customer_order_id\|ASC	Ordinato per id ordine cliente ascendente
shop_name\|DES	Ordinato per id ordine cliente discendente
shop_name\|ASC	Ordinato per nome negozio ascendente
shop_name\|DES	Ordinato per nome negozio discendente
customer_name\|ASC	Ordinato per nome cliente ascendente
customer_name\|DES	Ordinato per nome cliente discendente
product_name\|ASC	Ordinato per nome prodotto ascendente
product_name\|DES	Ordinato per nome prodotto discendente
quantity\|ASC	Ordinato per la quantità ascendente
quantity\|DES	Ordinato per quantità discendente
vat_rate\|ASC	Ordinato per l'aliquota IVA di riferimento ascendente
vat_rate\|DES	Ordinato per l'aliquota IVA di riferimento discendente
date_order\|ASC	Ordinato per data ordine ascendente
data_order\|DES	Ordinato per data ordine 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 sugli ordini clienti genera come risultati oggetti "Ordini Clienti". Per visualizzare la struttura di un oggetto ordine cliente, guarda il risultato della funzione customersOrders->get

Esempi

Esempio di ricerca di un ordine cliente inserito su Sirio.


require("SirioService.php");

//Creo l'oggetto per eseguire il servizio
$sirio = new SirioService();
	
//Parametri
$dataset = [
	"q" => [							// "q" sta per "query"
		"customer_name" => "progetto"		
	],
	"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("cutomersOrders", "list", $dataset);

/*

{
	nav: {
		page: 1,
		tot_pages: 1,
		results: 10,
		tot_results: 3,
		orderBy: "customer_name|DES"
	},
	dataset: {
		0: {  
			customer_order_id: 95,
			customer_id: 273,
			product_id: 963,
			description: srg,
			contact_name: Bianchi Mario,
			entity_type: 100,
			product_name: Design Interno Casa Tipo E,
			code: null,
			code_ean: null,
			code_cpv: null,
			code_taric: null,
			code_ssc: null,
			status: 5,
			unit: 4,
			quantity: 10,
			price: 100,
			discount: 0,
			vat_rate: 22,
			vat_type: 0,
			socialsurcharge_rate: 0,
			socialfund_rate: 0,
			withholding_base: 100,
			withholding_rate: 0,
			manager_id: null,
			manager_name: null,
			shop_id: 3,
			shop_name: Negozio Roma,
			num_invoices: 0,
			invoiced_percentage: 0,
			date_start: null,
			date_end: null,
			date_created: 2018-09-13 09:34:28,
			amounts: {
				order_unit: {
					price: 100,
					discount: 0,
					net: 100,
					vat: 22,
					gross: 122
				},
				order_total: {
					price: 1000,
					discount: 0,
					net: 1000,
					vat: 220,
					gross: 1220
				}
				invoiced: {
					price: 0,
					discount: 0,
					net: 0,
					vat: 0,
					gross: 0,
					withholding: 0
				}
			}
		},
		1: {
			...
		},
		2: {
			...
		},
		...
	}
}

*/

Manuale Utenti

Manuale Sviluppatori