L'API REST EDD fournit un accès aux données de ventes via le point de terminaison /sales/. Le point de terminaison des ventes vous permet d'interroger la base de données et de récupérer des informations sur les ventes récentes. Une requête de ventes de base ressemble à ceci :
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Les requêtes au point de terminaison /sales/ acceptent les paramètres suivants :
key– La clé API pour authentifier la requête (obligatoire).token– Le jeton API pour authentifier la requête (obligatoire).number– Le nombre d'enregistrements à retourner (facultatif).email– Un paramètre de recherche pour ne retourner que les paiements correspondant à l'e-mail donné (facultatif).id– Le numéro d'identification d'un enregistrement de paiement spécifique (facultatif).purchasekey– La clé d'achat pour un enregistrement de paiement spécifique (facultatif).
Pour chaque vente retournée, les informations suivantes seront disponibles :
- ID – Le numéro d'identification de la vente.
- key - La clé d'achat de la vente.
- subtotal – Le sous-total de la vente.
- tax – Le montant de la taxe sur les ventes.
- fees – Tous les frais arbitraires ajoutés à la vente.
- total – Le montant total de la vente.
- gateway – La méthode de paiement, telle que stripe ou paypal, utilisée pour effectuer l'achat.
- email – L'adresse e-mail associée à la vente.
- date – La date à laquelle la vente a été effectuée.
- discounts – Liste des codes de réduction utilisés.
- products – A list of products purchased. For each product:
- id – L'ID du produit.
- quantity – La quantité dans le panier pour l'article.
- name – Le nom du produit.
- price – Le prix du produit (après réductions éventuelles).
- price_name – Le nom de l'option de prix qui a été achetée (si le produit a des prix variables).
Un exemple de réponse à une requête de ventes ressemble à ceci :
{
"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": ""
}
}
]
}
Vous pouvez affiner les résultats par e-mail en ajoutant « &[email protected] ». Remplacez « [email protected] » par l'adresse e-mail réelle de l'utilisateur pour lequel vous souhaitez afficher les ventes.
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]
Récupération d'enregistrements de ventes spécifiques
Pour récupérer un enregistrement de vente spécifique, vous pouvez inclure le paramètre id ou purchasekey dans la requête.
Par exemple, pour récupérer une vente par la clé d'achat, la requête ressemble à ceci :
https://example.com/edd-api/sales/?key=&token= &purchasekey=
Pour récupérer une vente par l'ID, la requête ressemble à ceci :
https://example.com/edd-api/sales/?key=&token= &id=
Recherche d'enregistrements de ventes
L'utilisation du paramètre email entraînera le retour par l'API de tous les enregistrements de ventes correspondant à l'adresse e-mail donnée.
https://example.com/edd-api/sales/?key=&token= &email=
