EDD REST API V2 – Klanten

Dit document heeft specifiek betrekking op Versie 2 van de EDD API.
Documentatie voor Versie 1 is hier.

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/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25

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

• customer_id – De unieke ID van de klant. Komt overeen met id in dit API-resultaat.
• user_id – De WordPress gebruikers-ID. Als de klant als gast heeft gekocht, wordt dit als niets 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.
• date_created – De datum waarop deze klant is aangemaakt in EDD.
• 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.
• date – De datum waarvoor klanten moeten worden opgehaald. Dit heeft drie geaccepteerde waarden:
  • today – Haalt klanten op die op de huidige dag zijn aangemaakt.
  • yesterday – Haalt klanten op die op de vorige dag zijn aangemaakt.
  • range – Haalt klanten op die binnen een datumbereik zijn aangemaakt.
    • startdate – Formaat: YYYYMMDD. Voorbeeld: 20120224 = 2012/02/24
    • enddate – Formaat: YYYYMMDD. Voorbeeld: 20120531 = 2012/02/24

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

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

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

of

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

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

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

Een query die zoekt naar klanten die vandaag zijn aangemaakt, ziet er als volgt uit:

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

Een datumbereik ziet er als volgt uit:

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