EDD REST API V2 – Clienti

Questo documento si riferisce specificamente alla Versione 2 dell'API EDD.
La documentazione per la Versione 1 è qui.

La
EDD REST API fornisce un endpoint chiamato /customers/. L'endpoint clienti ti consente di interrogare il database e recuperare un elenco di clienti che hanno acquistato articoli dal tuo negozio. Una query di base per i clienti si presenta così:

https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25

Per ogni cliente restituito, vengono fornite le seguenti informazioni per ciascun cliente:

• customer_id – L'ID univoco del cliente. Corrisponde a id in questo risultato dell'API.
• user_id – L'ID utente di WordPress. Se il cliente ha acquistato come ospite, questo valore sarà vuoto.
• username – Il nome di accesso dell'utente di WordPress. Se il cliente ha acquistato come ospite, questo non restituirà nulla.
• display_name – Il nome visualizzato dell'utente di WordPress. Se il cliente ha acquistato come ospite, questo non restituirà nulla.
• first_name – Il nome del cliente.
• last_name – Il cognome del cliente.
• email – L'indirizzo email del cliente.
• date_created – La data in cui questo cliente è stato creato in EDD.
• total_purchases – Il numero totale di acquisti effettuati dal cliente.
• total_spent – L'importo totale speso dal cliente.
• total_downloads – Il numero totale di file scaricati dal cliente.
• date – La data per recuperare i clienti. Questo ha tre valori accettati:
  • today – Recupererà i clienti creati nel giorno corrente.
  • yesterday – Recupererà i clienti creati il giorno precedente.
  • range – Recupererà i clienti creati all'interno di un intervallo di date.
    • startdate – Formato: YYYYMMDD. Esempio: 20120224 = 24/02/2012
    • enddate – Formato: YYYYMMDD. Esempio: 20120531 = 31/05/2012

Insieme ai dati restituiti per ogni cliente c'è un oggetto
stats che mostra il numero totale di clienti nel database.

Una risposta di query per i clienti si presenta così:

{
    "customers": [
        {
            "info": {
                "id": "3",
                "user_id": "",
                "username": "",
                "display_name": "",
                "customer_id": "3",
                "first_name": "Matthew",
                "last_name": "Dixon",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-28 00:09:40"
            },
            "stats": {
                "total_purchases": "1",
                "total_spent": "20.000000",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": "2",
                "user_id": "2",
                "username": "bob",
                "display_name": "bob",
                "customer_id": "2",
                "first_name": "",
                "last_name": "",
                "email": "[email protected]",
                "additional_emails": [
                    "[email protected]"
                ],
                "date_created": "2016-05-17 14:17:15"
            },
            "stats": {
                "total_purchases": "1",
                "total_spent": "0.000000",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": "1",
                "user_id": "1",
                "username": "jose",
                "display_name": "Jose",
                "customer_id": "1",
                "first_name": "Jose",
                "last_name": "Espinoza",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-17 14:08:57"
            },
            "stats": {
                "total_purchases": "6",
                "total_spent": "70.000000",
                "total_downloads": 2
            }
        }
    ],
    "request_speed": 0.0081720352172852
}

Se desideri recuperare le informazioni per un cliente specifico, puoi aggiungere il
parametro &customer={identifier}, così:

https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&customer=1

o

https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]

La risposta per un singolo cliente sarà così:

{
    "customers": [
        {
            "info": {
                "id": "1",
                "user_id": "1",
                "username": "jose",
                "display_name": "Jose",
                "customer_id": "1",
                "first_name": "Jose",
                "last_name": "Espinoza",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-17 14:08:57"
            },
            "stats": {
                "total_purchases": "6",
                "total_spent": "70.000000",
                "total_downloads": 2
            }
        }
    ]
}

Una query per cercare i clienti creati oggi sarebbe simile a questa:

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=today

Un intervallo di date sarebbe simile a questo:

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=range&startdate=20130201&enddate=20130210