EDD REST API – Clientes

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/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25

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

• id – O ID do usuário do WordPress. Se o cliente comprou como convidado, isso retornará -1.
• 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.
• 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.

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": -1,
                "username": "Guest",
                "display_name": "Guest",
                "first_name": "Guest",
                "last_name": "Guest",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 2,
                "total_spent": "20",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": -1,
                "username": "Guest",
                "display_name": "Guest",
                "first_name": "Guest",
                "last_name": "Guest",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 0,
                "total_spent": "0",
                "total_downloads": 0
            }
        }
    ]
}

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/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&customer=1

ou

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

A resposta para um único cliente será assim:

{
    "customers": [
        {
            "info": {
                "id": 1,
                "username": "pippin",
                "display_name": "Pippin Williamson",
                "first_name": "Pippin",
                "last_name": "Williamson",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 61,
                "total_spent": 1139.68,
                "total_downloads": 31
            }
        }
    ]
}