EDD REST API V2 – Clientes

Este documento se relaciona específicamente con la Versión 2 de la API de EDD.
La documentación de la Versión 1 está aquí.

La
API REST de EDD proporciona un punto final llamado /customers/. El punto final de clientes le permite consultar la base de datos y recuperar una lista de clientes que han comprado artículos en su tienda. Una consulta básica de clientes se ve así:

https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25

Por cada cliente devuelto, se devuelve la siguiente información para cada cliente:

• customer_id – El ID único del cliente. Coincide con id en este resultado de la API.
• user_id – El ID de usuario de WordPress. Si el cliente compró como invitado, esto se devolverá como nada.
• username – El nombre de inicio de sesión del usuario de WordPress. Si el cliente compró como invitado, esto no devolverá nada.
• display_name – El nombre para mostrar del usuario de WordPress. Si el cliente compró como invitado, esto no devolverá nada.
• first_name – El nombre del cliente.
• last_name – El apellido del cliente.
• email – La dirección de correo electrónico del cliente.
• date_created – La fecha en que se creó este cliente en EDD.
• total_purchases – El número total de compras que ha realizado el cliente.
• total_spent – El importe total que ha gastado el cliente.
• total_downloads – El número total de archivos que ha descargado el cliente.
• date – The date to retrieve cutomers for. This has three accepted values:
  • today – Recuperará los clientes creados en el día actual.
  • yesterday – Recuperará los clientes creados en el día anterior.
  • range – Will retrieve customers created within a date range.
    • startdate – Formato: YYYYMMDD. Ejemplo: 20120224 = 24/02/2012
    • enddate – Formato: YYYYMMDD. Ejemplo: 20120531 = 31/05/2012

Junto con los datos devueltos para cada cliente hay un objeto
stats que muestra el número total de clientes en la base de datos.

Una respuesta de consulta de clientes se ve así:

{
    "customers": [
        {
            "info": {
                "id": "3",
                "user_id": "",
                "username": "",
                "display_name": "",
                "customer_id": "3",
                "first_name": "Matthew",
                "last_name": "Dixon",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-28 00:09:40"
            },
            "stats": {
                "total_purchases": "1",
                "total_spent": "20.000000",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": "2",
                "user_id": "2",
                "username": "bob",
                "display_name": "bob",
                "customer_id": "2",
                "first_name": "",
                "last_name": "",
                "email": "[email protected]",
                "additional_emails": [
                    "[email protected]"
                ],
                "date_created": "2016-05-17 14:17:15"
            },
            "stats": {
                "total_purchases": "1",
                "total_spent": "0.000000",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": "1",
                "user_id": "1",
                "username": "jose",
                "display_name": "Jose",
                "customer_id": "1",
                "first_name": "Jose",
                "last_name": "Espinoza",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-17 14:08:57"
            },
            "stats": {
                "total_purchases": "6",
                "total_spent": "70.000000",
                "total_downloads": 2
            }
        }
    ],
    "request_speed": 0.0081720352172852
}

Si desea recuperar la información de un cliente específico, puede agregar el
parámetro &customer={identifier}, así:

https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&customer=1

o

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

La respuesta para un solo cliente será así:

{
    "customers": [
        {
            "info": {
                "id": "1",
                "user_id": "1",
                "username": "jose",
                "display_name": "Jose",
                "customer_id": "1",
                "first_name": "Jose",
                "last_name": "Espinoza",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-17 14:08:57"
            },
            "stats": {
                "total_purchases": "6",
                "total_spent": "70.000000",
                "total_downloads": 2
            }
        }
    ]
}

Una consulta que busca clientes creados hoy se vería así:

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=today

Un rango de fechas se vería así:

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=range&startdate=20130201&enddate=20130210