Descrizione
Questo metodo può essere utilizzato per ottenere la lista dei clienti presenti all'interno del sistema.
Utilizzo
I parametri richiesti da questa funzione sono:
- customerId: Id del cliente di cui si vogliono ottenere le informazioni, se impostato a false verranno ritornati tutti i clienti presenti.
- customerEmailAddress: Indirizzo email per cui effettuare la ricerca, false se non necessario.
- customerGroupId: Id del gruppo utenti per cui effettuare la ricerca, false in caso contrario.
In caso di successo ritorna un'array di oggetti così strutturati:
- customerId: Id dell'indirizzo.
- customerFirstName: Nome del cliente
- customerLastName: Cognome del cliente.
- customerEmail: Indirizzo email del cliente.
- customerTelephone: Numero di telefono del cliente.
- customerFax: Numero del fax del cliente.
- lastIpAddress: Ultimo indirizzo ip da cui il cliente ha fatto accesso.
- isFromSocial: True se il cliente proviene da un canale social (facebook / google plus), false in caso contrario.
- totalRewardPoints: Totale punti accumulati dal cliente. Per ottenere maggiori informazioni consultare bGetCustomerRewards.
- secureQuestionId: Id della domanda di sicurezza associata al cliente. Per ottenere maggiori informazioni e la lista delle domande consultare bGetSecureQuestions.
- defaultAddressId: Id della nazione a cui è associato l'indirizzo. Per ottenere informazioni e lista delle nazioni consultare bGetCountries.
- customerGroupId: Id della zona a cui è associato l'indirizzo. Per ottenere informazioni e lista delle zone consultare bGetCountryZones.
- storeId: Id dello store a cui è associato il cliente.
- newsletter: true se il cliente ha autorizzato all'utilizzo dei dati personali per comunicazioni commerciali, false in caso contrario.
- approved: true se il cliente è stato approvato, false in caso il cliente necessiti dell'approvazione da parte dell'amministratore.
- enable: true se il cliente è attivo, false in caso contrario.
- dateCreated: Stringa contenente la data in cui è stato registrato il cliente nel formato YYYY-MM-DD HH:MM:SS.
Gestione errori
In caso di errore il metodo genererà un'eccezione che riporterà uno dei seguenti codici di errore:
- ERROR_INVALID_CUSTOMER_ID: L'id del cliente fornito non è valido.
- ERROR_INVALID_TOKEN: Non è stato effettuato nessun login in precedenza o la sessione è scaduta per inutilizzo.
- ERROR_INVALID_IP: L'indirizzo ip del server che sta effettuando la chiamata non valido perchè non inserito nella whitelist associata alle credenziali.
- ERROR_SERVER_UNAVAILABLE: Il server non è disponibile o si è verificato un errore di comunicazione generico.
PHP
require "vendor/autoload.php" try { $ezPrintSDK = new ezPrintSDKWrapper('http://demo.ezprint.it'); $apiToken = $ezPrintSDK->cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG'); $customers = $ezPrintSDK->backOffice->bGetCustomers(false, false, false); foreach($customers as $customer) { echo $customer['customerId'], ' ', $customer['customerEmail']; } } catch (Exception $e) { echo 'Error Code: ', $e->getMessage(); }
Node.js
try { var util = require('util'); var ezPrintSDK = require('ezprint-sdk-wrapper'); ezPrintSDK.initializeWrapper('http://demo.ezprint.it'); var apiToken = ezPrintSDK.cLoginAPI('1WHm0icsupAEm9fil9en','yCHZ0nKiyn1MU0DhpgmG'); var customers = ezPrintSDK.backOffice.bGetCustomers(false, false, false); customers.forEach(function(customer) { console.log(customer.customerId); console.log(customer.customerEmail); }); } catch (ex) { console.log(ex); }
.NET (C#)
try { ezPrintSDKWrapper.Client ezPrintSDK = new ezPrintSDKWrapper.Client("http://demo.ezprint.it"); ezPrintSDK.cLoginAPI("1WHm0icsupAEm9fil9en","yCHZ0nKiyn1MU0DhpgmG"); List<ezPrintSDKWrapper.Structures.customerItem> customers = ezPrintSDK.BackOffice.bGetCustomers(false, false, false); System.Console.WriteLine("Customer {0}: {1}", customers[0].customerId, customers[0].customerEmail); } catch (ezPrintException ex) { string ErrorMessage = ex.Message; }