EDD REST API V2 – Clientes

Este documento se relaciona especificamente com a Versão 2 da API EDD.
A documentação da Versão 1 está aqui.

A
API REST EDD fornece um endpoint chamado /customers/. O endpoint de clientes permite consultar o banco de dados e recuperar uma lista de clientes que compraram itens em sua loja. Uma consulta básica de clientes se parece com isto:

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

Para cada cliente retornado, as seguintes informações são retornadas para cada cliente:

• customer_id – O ID exclusivo do cliente. Corresponde a id neste resultado da API.
• user_id – O ID do usuário do WordPress. Se o cliente comprou como convidado, isso retornará como vazio.
• username – O nome de login do usuário do WordPress. Se o cliente comprou como convidado, isso retornará como vazio.
• display_name – O nome de exibição do usuário do WordPress. Se o cliente comprou como convidado, isso retornará como vazio.
• first_name – O primeiro nome do cliente.
• last_name – O sobrenome do cliente.
• email – O endereço de e-mail do cliente.
• date_created – A data em que este cliente foi criado no EDD.
• total_purchases – O número total de compras que o cliente fez.
• total_spent – O valor total que o cliente gastou.
• total_downloads – O número total de arquivos que o cliente baixou.
• date – A data para recuperar clientes. Este campo tem três valores aceitos:
  • today – Recuperará clientes criados no dia atual.
  • yesterday – Recuperará clientes criados no dia anterior.
  • range – Recuperará clientes criados dentro de um intervalo de datas.
    • startdate – Formato: YYYYMMDD. Exemplo: 20120224 = 24/02/2012
    • enddate – Formato: YYYYMMDD. Exemplo: 20120531 = 31/05/2012

Junto com os dados retornados para cada cliente, há um objeto stats que mostra o número total de clientes no banco de dados.

Uma resposta de consulta de clientes se parece com isto:

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

Se você deseja recuperar as informações de um cliente específico, pode adicionar o parâmetro
&customer={identifier}, assim:

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

ou

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

A resposta para um único cliente será assim:

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

Uma consulta procurando por clientes criados hoje se pareceria com isto:

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

Um intervalo de datas seria assim:

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