EDD REST API – Sprzedaże

EDD REST API zapewnia dostęp do danych sprzedaży za pośrednictwem punktu końcowego /sales/. Punkt końcowy sprzedaży pozwala na przeszukiwanie bazy danych i pobieranie informacji o ostatnich transakcjach. Podstawowe zapytanie o sprzedaż wygląda następująco:

https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70

Żądania do punktu końcowego /sales/ akceptują następujące parametry:

• key – Klucz API do uwierzytelnienia żądania (wymagany).
• token – Token API do uwierzytelnienia żądania (wymagany).
• number – Liczba rekordów do zwrócenia (opcjonalnie).
• email – Parametr wyszukiwania, aby zwrócić tylko płatności pasujące do podanego adresu e-mail (opcjonalnie).
• id – Numer identyfikacyjny konkretnego rekordu płatności (opcjonalnie).
• purchasekey – Klucz zakupu dla konkretnego rekordu płatności (opcjonalnie).

Dla każdej zwróconej sprzedaży dostępne będą następujące informacje:

• ID – Numer identyfikacyjny sprzedaży.
• key - Klucz zakupu sprzedaży.
• subtotal – Kwota sprzedaży netto.
• tax – Kwota podatku od sprzedaży.
• fees – Wszelkie dodatkowe opłaty, które zostały dodane do sprzedaży.
• total – Całkowita kwota sprzedaży.
• gateway – Metoda płatności, taka jak stripe lub paypal, użyta do dokonania zakupu.
• email – Adres e-mail powiązany ze sprzedażą.
• date – Data dokonania sprzedaży.
• discounts – Lista użytych kodów rabatowych.
• products – Lista zakupionych produktów. Dla każdego produktu:
  • id – Identyfikator produktu.
  • quantity – Ilość produktu w koszyku.
  • name – Nazwa produktu.
  • price – Cena produktu (po uwzględnieniu rabatów).
  • price_name – Nazwa opcji ceny, która została zakupiona (jeśli produkt ma różne ceny).

Przykładowa odpowiedź na zapytanie o sprzedaż wygląda następująco:

{
    "sales": [
        {
            "ID": 123,
            "mode": "",
            "status": "publish",
            "transaction_id": 12323461261234,
            "key": "ca2aaaa2a9e9e5369b8280403431b6fd",
            "subtotal": 89,
            "tax": "0",
            "fees": null,
            "total": "8.009",
            "gateway": "manual",
            "customer_id": "2",
            "user_id": "0",
            "email": "[email protected]",
            "date": "2021-09-29 13:47:41",
            "discounts": null,
            "products": [
                {
                    "id": 167,
                    "quantity": 1,
                    "name": "Stripe Pro Payment Gateway",
                    "price": 89,
                    "price_name": "Single Site"
                }
            ],
        },
        {
            "ID": 122,
            "mode": "",
            "status": "publish",
            "transaction_id": 12324621266234,
            "key": "7608c3f1b8f5e00b7f21add193ab7ced",
            "subtotal": 199,
            "tax": "0",
            "fees": null,
            "total": "199.00",
            "gateway": "manual",
            "customer_id": "2",
            "user_id": "0",
            "email": "[email protected]",
            "date": "2021-09-29 13:30:59",
            "discounts": null,
            "products": [
                {
                    "id": 1245716,
                    "quantity": 1,
                    "name": "Extended Pass",
                    "price": 199,
                    "price_name": ""
                }
        }
    ]
}

Możesz zawęzić wyniki według adresu e-mail, dodając „&[email protected]”. Zastąp „[email protected]” rzeczywistym adresem e-mail użytkownika, dla którego chcesz wyświetlić sprzedaż.

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

Pobieranie konkretnych rekordów sprzedaży

Aby pobrać konkretny rekord sprzedaży, możesz uwzględnić w żądaniu parametr id lub purchasekey.

Na przykład, aby pobrać sprzedaż według klucza zakupu, żądanie wygląda następująco:

https://example.com/edd-api/sales/?key=&token=&purchasekey=

Aby pobrać sprzedaż według identyfikatora, żądanie wygląda następująco:

https://example.com/edd-api/sales/?key=&token=&id=

Wyszukiwanie rekordów sprzedaży

Przekazanie parametru email spowoduje, że API zwróci wszystkie rekordy sprzedaży pasujące do podanego adresu e-mail.

https://example.com/edd-api/sales/?key=&token=&email=