La EDD REST API proporciona acceso a los datos de ventas a través del endpoint /sales/. El endpoint de ventas te permite consultar la base de datos y recuperar información de ventas recientes. Una consulta básica de ventas se ve así:
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Las solicitudes al endpoint /sales/ aceptan los siguientes parámetros:
key– La clave de la API para autenticar la solicitud (obligatorio).token– El token de la API para autenticar la solicitud (obligatorio).number– El número de registros a devolver (opcional).email– Un parámetro de búsqueda para devolver solo los pagos que coincidan con el correo electrónico proporcionado (opcional).id– El número de ID de un registro de pago específico (opcional).purchasekey– La clave de compra de un registro de pago específico (opcional).
Para cada venta devuelta, la siguiente información estará disponible:
- ID – El número de ID de la venta.
- key - La clave de compra de la venta.
- subtotal – El subtotal de la venta.
- tax – El monto del impuesto sobre las ventas.
- fees – Cualquier tarifa arbitraria que se haya agregado a la venta.
- total – El monto total de la venta.
- gateway – El método de pago, como stripe o paypal, utilizado para realizar la compra.
- email – La dirección de correo electrónico asociada con la venta.
- date – La fecha en que se realizó la venta.
- discounts – Lista de códigos de descuento utilizados.
- products – A list of products purchased. For each product:
- id – El ID del producto.
- quantity – La cantidad en el carrito del artículo.
- name – El nombre del producto.
- price – El precio del producto (después de aplicar descuentos).
- price_name – El nombre de la opción de precio que se compró (si el producto tiene precios variables).
Una respuesta de ejemplo de una consulta de ventas se ve así:
{
"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": ""
}
}
]
}
Puedes acotar los resultados por correo electrónico añadiendo “&[email protected]”. Reemplaza “[email protected]” con la dirección de correo electrónico del usuario para el que deseas mostrar las ventas.
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]
Recuperación de Registros de Ventas Específicos
Para recuperar un registro de venta específico, puedes incluir el parámetro id o purchasekey en la solicitud.
Por ejemplo, para recuperar una venta por la clave de compra, la solicitud se ve así:
https://example.com/edd-api/sales/?key=&token= &purchasekey=
Para recuperar una venta por ID, la solicitud se ve así:
https://example.com/edd-api/sales/?key=&token= &id=
Búsqueda de registros de ventas
Al pasar el parámetro email, la API devolverá todos los registros de ventas que coincidan con la dirección de correo electrónico proporcionada.
https://example.com/edd-api/sales/?key=&token= &email=
