EDD REST API – Verkopen

De EDD REST API biedt toegang tot verkoopgegevens via het /sales/ eindpunt. Het verkoop-eindpunt stelt u in staat de database te bevragen en informatie voor recente verkopen op te halen. Een basisverkoopquery ziet er als volgt uit:

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

Verzoeken aan het /sales/ eindpunt accepteren de volgende parameters:

• key – De API-sleutel om het verzoek te authenticeren (vereist).
• token – De API-token om het verzoek te authenticeren (vereist).
• number – Het aantal records dat moet worden geretourneerd (optioneel).
• email – Een zoekparameter om alleen betalingen te retourneren die overeenkomen met het opgegeven e-mailadres (optioneel).
• id – Het ID-nummer van een specifiek betalingsrecord (optioneel).
• purchasekey – De aankoopsleutel voor een specifiek betalingsrecord (optioneel).

Voor elke geretourneerde verkoop is de volgende informatie beschikbaar:

• ID – Het verkoop-ID-nummer.
• key - De aankoopsleutel van de verkoop.
• subtotal – Het subtotaal van de verkoop.
• tax – Het btw-bedrag van de verkoop.
• fees – Eventuele willekeurige kosten die aan de verkoop zijn toegevoegd.
• total – Het totale verkoopbedrag.
• gateway – De betaalmethode, zoals stripe of paypal, die is gebruikt om de aankoop te doen.
• email – Het e-mailadres dat aan de verkoop is gekoppeld.
• date – De datum waarop de verkoop is gedaan.
• discounts – Lijst van gebruikte kortingscodes.
• products – Een lijst van gekochte producten. Voor elk product:
  • id – Het product-ID.
  • quantity – De winkelwagenhoeveelheid voor het artikel.
  • name – De naam van het product.
  • price – De prijs van het product (na eventuele kortingen).
  • price_name – De naam van de prijsoptie die is gekocht (als het product variabele prijzen heeft).

Een voorbeeld van een verkoopqueryantwoord ziet er als volgt uit:

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

U kunt de resultaten verfijnen op e-mailadres door "&[email protected]" toe te voegen. Vervang "[email protected]" door het daadwerkelijke e-mailadres van de gebruiker van wie u verkopen wilt weergeven.

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

Specifieke Verkooprecords Ophalen

Om een specifiek verkooprecord op te halen, kunt u de parameter id of purchasekey in het verzoek opnemen.

Bijvoorbeeld, om een verkoop op te halen via de aankoopcode, ziet het verzoek er als volgt uit:

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

Om een verkoop op te halen via de ID, ziet het verzoek er als volgt uit:

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

Verkooprecords zoeken

Het doorgeven van de email parameter zal ertoe leiden dat de API alle verkooprecords retourneert die overeenkomen met het opgegeven e-mailadres.

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