Die EDD REST API bietet Zugriff auf Verkaufsdaten über den Endpunkt /sales/. Der Verkaufs-Endpunkt ermöglicht es Ihnen, die Datenbank abzufragen und Informationen für aktuelle Verkäufe abzurufen. Eine grundlegende Verkaufsabfrage sieht wie folgt aus:
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Anfragen an den Endpunkt /sales/ akzeptieren die folgenden Parameter:
key– Der API-Schlüssel zur Authentifizierung der Anfrage (erforderlich).token– Das API-Token zur Authentifizierung der Anfrage (erforderlich).number– Die Anzahl der zurückzugebenden Datensätze (optional).email– Ein Suchparameter, um nur Zahlungen zurückzugeben, die der angegebenen E-Mail-Adresse entsprechen (optional).id– Die ID-Nummer eines bestimmten Zahlungsdatensatzes (optional).purchasekey– Der Kaufschlüssel für einen bestimmten Zahlungsdatensatz (optional).
Für jeden zurückgegebenen Verkauf sind die folgenden Informationen verfügbar:
- ID – Die Verkaufs-ID-Nummer.
- key - Der Kaufschlüssel des Verkaufs.
- subtotal – Der Verkauf-Nettobetrag.
- tax – Der Betrag der Verkaufssteuer.
- fees – Alle beliebigen Gebühren, die dem Verkauf hinzugefügt wurden.
- total – Der Gesamtbetrag des Verkaufs.
- gateway – Die Zahlungsmethode, wie z. B. Stripe oder PayPal, die für den Kauf verwendet wurde.
- email – Die mit dem Verkauf verknüpfte E-Mail-Adresse.
- date – Das Datum, an dem der Verkauf getätigt wurde.
- discounts – Liste der verwendeten Rabattcodes.
- products – A list of products purchased. For each product:
- id – Die Produkt-ID.
- quantity – Die Warenkorb-Menge für den Artikel.
- name – Der Name des Produkts.
- price – Der Preis des Produkts (nach Abzug von Rabatten).
- price_name – Der Name der gekauften Preisoption (wenn das Produkt variable Preise hat).
Eine Beispielantwort auf eine Verkaufsabfrage sieht wie folgt aus:
{
"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": ""
}
}
]
}
Sie können die Ergebnisse nach E-Mail eingrenzen, indem Sie „&[email protected]“ hinzufügen. Ersetzen Sie „[email protected]“ durch die tatsächliche E-Mail-Adresse des Benutzers, für den Sie Verkäufe anzeigen möchten.
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]
Abrufen spezifischer Verkaufsdatensätze
Um einen bestimmten Verkaufsdatensatz abzurufen, können Sie entweder den Parameter id oder purchasekey in die Anfrage aufnehmen.
Um beispielsweise einen Verkauf anhand des Kaufschlüssels abzurufen, sieht die Anfrage wie folgt aus:
https://example.com/edd-api/sales/?key=&token= &purchasekey=
Um einen Verkauf anhand der ID abzurufen, sieht die Anfrage wie folgt aus:
https://example.com/edd-api/sales/?key=&token= &id=
Verkaufseinträge durchsuchen
Die Übergabe des email-Parameters führt dazu, dass die API alle Verkaufseinträge zurückgibt, die der angegebenen E-Mail-Adresse entsprechen.
https://example.com/edd-api/sales/?key=&token= &email=
