API REST do EDD – Vendas

A API REST do EDD fornece acesso a dados de vendas através do endpoint /sales/. O endpoint de vendas permite consultar o banco de dados e recuperar informações de vendas recentes. Uma consulta básica de vendas se parece com isto:

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

Requisições para o endpoint /sales/ aceitam os seguintes parâmetros:

• key – A chave da API para autenticar a requisição (obrigatório).
• token – O token da API para autenticar a requisição (obrigatório).
• number – O número de registros a serem retornados (opcional).
• email – Um parâmetro de busca para retornar apenas pagamentos que correspondam ao e-mail fornecido (opcional).
• id – O número de ID de um registro de pagamento específico (opcional).
• purchasekey – A chave de compra para um registro de pagamento específico (opcional).

Para cada venda retornada, as seguintes informações estarão disponíveis:

• ID – O número de ID da venda.
• key - A chave de compra da venda.
• subtotal – O subtotal da venda.
• tax – O valor do imposto sobre vendas.
• fees – Quaisquer taxas arbitrárias que foram adicionadas à venda.
• total – O valor total da venda.
• gateway – O método de pagamento, como stripe ou paypal, usado para fazer a compra.
• email – O endereço de e-mail associado à venda.
• date – A data em que a venda foi realizada.
• discounts – Lista de códigos de desconto utilizados.
• products – Uma lista de produtos comprados. Para cada produto:
  • id – O ID do Produto.
  • quantity – A quantidade do item no carrinho.
  • name – O nome do produto.
  • price – O preço do produto (após quaisquer descontos).
  • price_name – O nome da opção de preço que foi comprada (se o produto tiver preços variáveis).

Um exemplo de resposta de consulta de vendas se parece com isto:

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

Você pode refinar os resultados por e-mail adicionando “&[email protected]”. Substitua “[email protected]” pelo endereço de e-mail real do usuário para o qual você deseja mostrar as vendas.

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

Recuperando Registros de Vendas Específicos

Para recuperar um registro de venda específico, você pode incluir o parâmetro id ou purchasekey na requisição.

Por exemplo, para recuperar uma venda pela chave de compra, a solicitação se parece com isto:

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

Para recuperar uma venda pelo ID, a solicitação se parece com isto:

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

Pesquisando Registros de Vendas

Passar o parâmetro email fará com que a API retorne todos os registros de vendas que correspondem ao endereço de e-mail fornecido.

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