L'API REST di EDD fornisce l'accesso ai dati di vendita tramite l'endpoint /sales/. L'endpoint delle vendite ti consente di interrogare il database e recuperare informazioni sulle vendite recenti. Una query di base per le vendite si presenta così:
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Le richieste all'endpoint /sales/ accettano i seguenti parametri:
key– La chiave API per autenticare la richiesta (richiesto).token– Il token API per autenticare la richiesta (richiesto).number– Il numero di record da restituire (opzionale).email– Un parametro di ricerca per restituire solo i pagamenti che corrispondono all'email fornita (opzionale).id– Il numero ID di un record di pagamento specifico (opzionale).purchasekey– La chiave di acquisto per un record di pagamento specifico (opzionale).
Per ogni vendita restituita, saranno disponibili le seguenti informazioni:
- ID – Il numero ID della vendita.
- key - La chiave di acquisto della vendita.
- subtotal – Il subtotale della vendita.
- tax – L'importo dell'imposta sulle vendite.
- fees – Eventuali commissioni arbitrarie aggiunte alla vendita.
- total – L'importo totale della vendita.
- gateway – Il metodo di pagamento, come stripe o paypal, utilizzato per effettuare l'acquisto.
- email – L'indirizzo email associato alla vendita.
- date – La data in cui è stata effettuata la vendita.
- discounts – Elenco dei codici sconto utilizzati.
- products – Un elenco dei prodotti acquistati. Per ogni prodotto:
- id – L'ID del prodotto.
- quantity – La quantità nel carrello dell'articolo.
- name – Il nome del prodotto.
- price – Il prezzo del prodotto (dopo eventuali sconti).
- price_name – Il nome dell'opzione di prezzo acquistata (se il prodotto ha prezzi variabili).
Una risposta di esempio a una query di vendita si presenta così:
{
"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": ""
}
}
]
}
Puoi restringere i risultati per email aggiungendo “&[email protected]”. Sostituisci “[email protected]” con l'indirizzo email effettivo dell'utente per il quale desideri visualizzare le vendite.
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]
Recupero di Specifici Record di Vendita
Per recuperare un record di vendita specifico, puoi includere il parametro id o purchasekey nella richiesta.
Ad esempio, per recuperare una vendita tramite la chiave di acquisto, la richiesta è la seguente:
https://example.com/edd-api/sales/?key=&token= &purchasekey=
Per recuperare una vendita tramite l'ID, la richiesta è la seguente:
https://example.com/edd-api/sales/?key=&token= &id=
Ricerca dei record di vendita
Il passaggio del parametro email comporterà la restituzione da parte dell'API di tutti i record di vendita che corrispondono all'indirizzo email fornito.
https://example.com/edd-api/sales/?key=&token= &email=
