このドキュメントは、EDD APIのバージョン2にspecifically関連しています。
バージョン1のドキュメントはこちら。
EDD REST APIは、/customers/というエンドポイントを提供します。顧客エンドポイントを使用すると、データベースをクエリして、ショップで購入した顧客のリストを取得できます。基本的な顧客クエリは次のようになります。
https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25
返される各顧客について、次の情報が返されます。
- customer_id – 顧客の一意のID。このAPI結果の
idと一致します。 - user_id – WordPressのユーザーID。顧客がゲストとして購入した場合、これは何も返しません。
- username – WordPressのユーザーログイン名。顧客がゲストとして購入した場合、これは何も返しません。
- display_name – WordPressの表示名。顧客がゲストとして購入した場合、これは何も返しません。
- first_name – 顧客の名。
- last_name – 顧客の姓。
- email – 顧客のメールアドレス。
- date_created – この顧客がEDDで作成された日付。
- total_purchases – 顧客が行った購入の総数。
- total_spent – 顧客が費やした総額。
- total_downloads – 顧客がダウンロードしたファイルの総数。
- date – 顧客を取得する日付。次の3つの値が accepted されます：
- today – 当日作成された顧客を取得します。
- yesterday – 前日作成された顧客を取得します。
- range – 日付範囲内で作成された顧客を取得します。
- startdate – フォーマット：YYYYMMDD。例：20120224 = 2012/02/24
- enddate – フォーマット：YYYYMMDD。例：20120531 = 2012/02/24
各顧客に返されるデータとともに、データベース内の顧客の総数を示すstatsオブジェクトがあります。
顧客クエリの応答は次のようになります：
{
"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
}
特定の顧客の情報を取得したい場合は、次のように&customer={identifier}パラメータを追加できます。
https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&customer=1
または
https://yoursite.com/edd-api/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]
単一の顧客の応答は次のようになります：
{
"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
}
}
]
}
本日作成された顧客を検索するクエリは次のようになります：
https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=today
日付範囲は次のようになります：
https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=range&startdate=20130201&enddate=20130210
