EDD REST API – Vânzări

API-ul EDD REST oferă acces la datele de vânzări prin intermediul endpoint-ului /sales/. Endpoint-ul de vânzări vă permite să interogați baza de date și să preluați informații pentru vânzările recente. O interogare de bază pentru vânzări arată astfel:

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

Solicitările către endpoint-ul /sales/ acceptă următorii parametri:

• key – Cheia API pentru autentificarea solicitării (obligatoriu).
• token – Tokenul API pentru autentificarea solicitării (obligatoriu).
• number – Numărul de înregistrări de returnat (opțional).
• email – Un parametru de căutare pentru a returna doar plățile care corespund emailului furnizat (opțional).
• id – Numărul ID al unei înregistrări specifice de plată (opțional).
• purchasekey – Cheia de achiziție pentru o înregistrare specifică de plată (opțional).

Pentru fiecare vânzare returnată, vor fi disponibile următoarele informații:

• ID – Numărul ID al vânzării.
• key - Cheia de achiziție a vânzării.
• subtotal – Subtotalul vânzării.
• tax – Suma taxei pe vânzări.
• fees – Orice taxe arbitrare adăugate la vânzare.
• total – Suma totală a vânzării.
• gateway – Metoda de plată, cum ar fi stripe sau paypal, utilizată pentru efectuarea achiziției.
• email – Adresa de email asociată vânzării.
• date – Data la care a fost efectuată vânzarea.
• discounts – Lista codurilor de reducere utilizate.
• products – O listă de produse achiziționate. Pentru fiecare produs:
  • id – ID-ul produsului.
  • quantity – Cantitatea din coș pentru articol.
  • name – Numele produsului.
  • price – Prețul produsului (după orice reduceri).
  • price_name – Numele opțiunii de preț care a fost achiziționat (dacă produsul are prețuri variabile).

Un exemplu de răspuns la o interogare de vânzări arată astfel:

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

Puteți restrânge rezultatele după email adăugând „&[email protected]”. Înlocuiți „[email protected]” cu adresa de email reală a utilizatorului pentru care doriți să afișați vânzările.

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

Preluarea Înregistrărilor Specifice de Vânzare

Pentru a prelua o înregistrare specifică de vânzare, puteți include fie parametrul id, fie parametrul purchasekey în solicitare.

De exemplu, pentru a prelua o vânzare după cheia de achiziție, cererea arată astfel:

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

Pentru a prelua o vânzare după ID, cererea arată astfel:

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

Căutare înregistrări de vânzări

Transmiterea parametrului email va face ca API-ul să returneze toate înregistrările de vânzări care corespund adresei de e-mail specificate.

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