EDD REST API – Klanten

De
EDD REST API biedt een endpoint genaamd /customers/. Het customers-endpoint stelt u in staat om de database te bevragen en een lijst met klanten op te halen die items in uw winkel hebben gekocht. Een basisquery voor klanten ziet er als volgt uit:

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

Voor elke geretourneerde klant wordt de volgende informatie voor elke klant geretourneerd:

• id – De WordPress-gebruikers-ID. Als de klant als gast heeft gekocht, wordt dit -1 geretourneerd.
• username – De WordPress-gebruikersnaam. Als de klant als gast heeft gekocht, wordt dit leeg geretourneerd.
• display_name – De weergavenaam van de WordPress-gebruiker. Als de klant als gast heeft gekocht, wordt dit leeg geretourneerd.
• first_name – De voornaam van de klant.
• last_name – De achternaam van de klant.
• email – Het e-mailadres van de klant.
• total_purchases – Het totale aantal aankopen dat de klant heeft gedaan.
• total_spent – Het totale bedrag dat de klant heeft uitgegeven.
• total_downloads – Het totale aantal bestanden dat de klant heeft gedownload.

Samen met de gegevens die voor elke klant worden geretourneerd, is er een
stats-object dat het totale aantal klanten in de database toont.

Een antwoord op een klantenquery ziet er als volgt uit:

{
    "customers": [
        {
            "info": {
                "id": -1,
                "username": "Guest",
                "display_name": "Guest",
                "first_name": "Guest",
                "last_name": "Guest",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 2,
                "total_spent": "20",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": -1,
                "username": "Guest",
                "display_name": "Guest",
                "first_name": "Guest",
                "last_name": "Guest",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 0,
                "total_spent": "0",
                "total_downloads": 0
            }
        }
    ]
}

Als u de informatie voor een specifieke klant wilt ophalen, kunt u de
&customer={identifier}-parameter toevoegen, zoals hier:

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

of

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

Het antwoord voor een enkele klant zal er als volgt uitzien:

{
    "customers": [
        {
            "info": {
                "id": 1,
                "username": "pippin",
                "display_name": "Pippin Williamson",
                "first_name": "Pippin",
                "last_name": "Williamson",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 61,
                "total_spent": 1139.68,
                "total_downloads": 31
            }
        }
    ]
}