EDD REST API – 売上

EDD REST API は、/sales/ エンドポイントを介して売上データへのアクセスを提供します。売上エンドポイントを使用すると、データベースにクエリを実行し、最近の売上情報を取得できます。基本的な売上クエリは次のようになります。

https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70

/sales/ エンドポイントへのリクエストは、次のパラメータを受け付けます。

• key – リクエストを認証するための API キー（必須）。
• token – リクエストを認証するための API トークン（必須）。
• number – 返されるレコードの数（オプション）。
• email – 指定されたメールアドレスと一致する支払いのみを返すための検索パラメータ（オプション）。
• id – 特定の支払いレコードの ID 番号（オプション）。
• purchasekey – 特定の支払いレコードの購入キー（オプション）。

返される各売上について、次の情報が利用可能になります。

• ID – 売上 ID 番号。
• key - 売上の購入キー。
• subtotal – 売上の小計。
• tax – 売上税額。
• fees – 売上に追加された任意の料金。
• total – 売上の合計金額。
• gateway – 購入に使用された支払い方法（例: stripe または paypal）。
• email – 売上に関連付けられたメールアドレス。
• date – 売上が行われた日付。
• discounts – 使用された割引コードのリスト。
• products – 購入された製品のリスト。各製品について:
  • id – 製品 ID。
  • quantity – アイテムのカート数量。
  • name – 製品名。
  • price – 製品の価格（割引後）。
  • price_name – 購入された価格オプション名（製品に価格オプションがある場合）。

売上クエリの応答例は次のようになります。

{
    "sales": [
        {
            "ID": 123,
            "mode": "",
            "status": "publish",
            "transaction_id": 12323461261234,
            "key": "ca2aaaa2a9e9e5369b8280403431b6fd",
            "subtotal": 89,
            "tax": "0",
            "fees": null,
            "total": "8.009",
            "gateway": "manual",
            "customer_id": "2",
            "user_id": "0",
            "email": "[email protected]",
            "date": "2021-09-29 13:47:41",
            "discounts": null,
            "products": [
                {
                    "id": 167,
                    "quantity": 1,
                    "name": "Stripe Pro Payment Gateway",
                    "price": 89,
                    "price_name": "Single Site"
                }
            ],
        },
        {
            "ID": 122,
            "mode": "",
            "status": "publish",
            "transaction_id": 12324621266234,
            "key": "7608c3f1b8f5e00b7f21add193ab7ced",
            "subtotal": 199,
            "tax": "0",
            "fees": null,
            "total": "199.00",
            "gateway": "manual",
            "customer_id": "2",
            "user_id": "0",
            "email": "[email protected]",
            "date": "2021-09-29 13:30:59",
            "discounts": null,
            "products": [
                {
                    "id": 1245716,
                    "quantity": 1,
                    "name": "Extended Pass",
                    "price": 199,
                    "price_name": ""
                }
        }
    ]
}

「&[email protected]」を追加することで、結果をメールで絞り込むことができます。「[email protected]」を、売上を表示したい実際のユーザーのメールアドレスに置き換えてください。

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

特定の売上レコードの取得

特定の売上レコードを取得するには、リクエストに id または purchasekey パラメータを含めることができます。

例えば、購入キーで販売を取得するには、リクエストは次のようになります。

https://example.com/edd-api/sales/?key=&token=&purchasekey=

IDで販売を取得するには、リクエストは次のようになります。

https://example.com/edd-api/sales/?key=&token=&id=

販売記録の検索

email パラメータを渡すと、API は指定されたメールアドレスに一致するすべての販売記録を返します。

https://example.com/edd-api/sales/?key=&token=&email=