EDD REST API – 顧客

EDD REST APIは、/customers/というエンドポイントを提供します。顧客エンドポイントを使用すると、データベースをクエリして、ショップで購入した顧客のリストを取得できます。基本的な顧客クエリは次のようになります。

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

返される各顧客について、次の情報が返されます。

• id – WordPressのユーザーID。顧客がゲストとして購入した場合、これは-1を返します。
• username – WordPressのユーザーログイン名。顧客がゲストとして購入した場合、これは何も返しません。
• display_name – WordPressの表示名。顧客がゲストとして購入した場合、これは何も返しません。
• first_name – 顧客の名。
• last_name – 顧客の姓。
• email – 顧客のメールアドレス。
• total_purchases – 顧客が行った購入の総数。
• total_spent – 顧客が費やした総額。
• total_downloads – 顧客がダウンロードしたファイルの総数。

各顧客に返されるデータとともに、データベース内の顧客の総数を示すstatsオブジェクトがあります。

顧客クエリの応答は次のようになります：

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

特定の顧客の情報を取得したい場合は、次のように&customer={identifier}パラメータを追加できます。

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

または

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

単一の顧客の応答は次のようになります：

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