EDD REST API V2 – Kunden

Dieses Dokument bezieht sich speziell auf Version 2 der EDD API.
Dokumentation für Version 1 finden Sie hier.

Die
EDD REST API bietet einen Endpunkt namens /customers/. Der Kundenendpunkt ermöglicht es Ihnen, die Datenbank abzufragen und eine Liste von Kunden abzurufen, die Artikel in Ihrem Shop gekauft haben. Eine einfache Kundenabfrage sieht wie folgt aus:

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

Für jeden zurückgegebenen Kunden werden die folgenden Informationen bereitgestellt:

• customer_id – Die eindeutige ID des Kunden. Entspricht id in diesem API-Ergebnis.
• user_id – Die WordPress-Benutzer-ID. Wenn der Kunde als Gast gekauft hat, wird hier nichts zurückgegeben.
• username – Der WordPress-Benutzer-Loginname. Wenn der Kunde als Gast gekauft hat, wird hier nichts zurückgegeben.
• display_name – Der Anzeigename des WordPress-Benutzers. Wenn der Kunde als Gast gekauft hat, wird hier nichts zurückgegeben.
• first_name – Der Vorname des Kunden.
• last_name – Der Nachname des Kunden.
• email – Die E-Mail-Adresse des Kunden.
• date_created – Das Datum, an dem dieser Kunde in EDD erstellt wurde.
• total_purchases – Die Gesamtzahl der Käufe, die der Kunde getätigt hat.
• total_spent – Der Gesamtbetrag, den der Kunde ausgegeben hat.
• total_downloads – Die Gesamtzahl der Dateien, die der Kunde heruntergeladen hat.
• date – The date to retrieve cutomers for. This has three accepted values:
  • today – Ruft Kunden ab, die am aktuellen Tag erstellt wurden.
  • yesterday – Ruft Kunden ab, die am Vortag erstellt wurden.
  • range – Will retrieve customers created within a date range.
    • startdate – Format: YYYYMMDD. Beispiel: 20120224 = 24.02.2012
    • enddate – Format: YYYYMMDD. Beispiel: 20120531 = 31.05.2012

Zusammen mit den für jeden Kunden zurückgegebenen Daten gibt es ein
stats-Objekt, das die Gesamtzahl der Kunden in der Datenbank anzeigt.

Eine Kundenabfrageantwort sieht wie folgt aus:

{
    "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
}

Wenn Sie die Informationen für einen bestimmten Kunden abrufen möchten, können Sie den
&customer={identifier}-Parameter hinzufügen, wie hier:

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

oder

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

Die Antwort für einen einzelnen Kunden wird wie folgt aussehen:

{
    "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
            }
        }
    ]
}

Eine Abfrage nach heute erstellten Kunden würde wie folgt aussehen:

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

Ein Datumsbereich würde wie folgt aussehen:

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