EDD REST API V2 – Klienci

Ten dokument dotyczy wyłącznie wersji 2 EDD API.
Dokumentacja wersji 1 znajduje się tutaj.

EDD REST API
EDD REST API udostępnia punkt końcowy o nazwie /customers/. Punkt końcowy klientów pozwala na przeszukiwanie bazy danych i pobieranie listy klientów, którzy kupili produkty w Twoim sklepie. Podstawowe zapytanie o klientów wygląda następująco:

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

Dla każdego zwróconego klienta dostępne są następujące informacje:

• customer_id – Unikalny identyfikator klienta. Odpowiada id w tym wyniku API.
• user_id – Identyfikator użytkownika WordPress. Jeśli klient kupił jako gość, ta wartość będzie pusta.
• username – Nazwa logowania użytkownika WordPress. Jeśli klient kupił jako gość, ta wartość będzie pusta.
• display_name – Nazwa wyświetlana użytkownika WordPress. Jeśli klient kupił jako gość, ta wartość będzie pusta.
• first_name – Imię klienta.
• last_name – Nazwisko klienta.
• email – Adres e-mail klienta.
• date_created – Data utworzenia tego klienta w EDD.
• total_purchases – Całkowita liczba zakupów dokonanych przez klienta.
• total_spent – Całkowita kwota wydana przez klienta.
• total_downloads – Całkowita liczba pobranych plików przez klienta.
• date – Data, dla której mają zostać pobrani klienci. Dostępne są trzy wartości:
  • today – Pobiera klientów utworzonych bieżącego dnia.
  • yesterday – Pobiera klientów utworzonych poprzedniego dnia.
  • range – Pobiera klientów utworzonych w określonym zakresie dat.
    • startdate – Format: RRRRMMDD. Przykład: 20120224 = 2012/02/24
    • enddate – Format: RRRRMMDD. Przykład: 20120531 = 2012/02/24

Wraz z danymi zwracanymi dla każdego klienta znajduje się obiekt
stats, który pokazuje całkowitą liczbę klientów w bazie danych.

Odpowiedź na zapytanie o klientów wygląda następująco:

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

Jeśli chcesz pobrać informacje o konkretnym kliencie, możesz dodać
parametr &customer={identifier}, na przykład:

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

lub

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

Odpowiedź dla pojedynczego klienta będzie wyglądać następująco:

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

Zapytanie o klientów utworzonych dzisiaj będzie wyglądać następująco:

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

Zakres dat będzie wyglądać następująco:

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