Overview
This node integrates with the Kiwify API to list sales data filtered by various criteria. It is useful for automating the retrieval of sales records within a specified date range, optionally filtered by status, payment method, product ID, or affiliate ID. The node supports fetching either basic or detailed sales information.
Practical examples include:
- Generating daily or monthly sales reports filtered by creation or update dates.
- Monitoring sales statuses such as approved, paid, or refunded.
- Extracting sales related to specific products or affiliates.
- Integrating sales data into other workflows for analytics or customer management.
Properties
| Name | Meaning |
|---|---|
| Data de Início | Start date to filter sales (required). |
| Data de Fim | End date to filter sales (required when start date is provided). |
| Filtrar por | Date type to filter by: "Data de Criação" (created) or "Data de Atualização" (updated). |
| Status | Filter sales by status. Options: Aprovado, Autorizado, Estornado, Pago, Pendente, Reembolso Pendente, Processando, Reembolsado, Reembolso Solicitado, Recusado, Aguardando Pagamento. |
| Método de Pagamento | Filter sales by payment method. Options: Boleto, Cartão de Crédito, Pix. |
| ID do Produto | Filter sales by product ID (string). |
| ID do Afiliado | Filter sales by affiliate ID (string). |
| Exibir Detalhes Completos da Venda | Boolean flag to return full sale details if true. |
| Opções Adicionais > Limite | Maximum number of results to return (default 50). |
| Opções Adicionais > Página | Page number for pagination (default 1). |
Output
The node outputs an array of JSON objects representing sales records matching the filter criteria. Each object contains sales data fields as returned by the Kiwify API. If the option to view full sale details is enabled, the output includes more comprehensive information about each sale.
No binary data is output by this node.
Dependencies
- Requires an API key credential for authenticating with the Kiwify API.
- Needs configuration of the API token and account ID in the node credentials.
- Makes HTTP GET requests to
https://public-api.kiwify.com/v1/saleswith query parameters based on input properties.
Troubleshooting
Common issues:
- Missing or invalid API credentials will cause authentication errors.
- Providing an invalid date range (e.g., end date before start date) may result in no data or API errors.
- Exceeding API rate limits could lead to request failures.
- Incorrect filtering values (e.g., unsupported status or payment method) might return empty results.
Error messages:
- Authentication errors typically indicate missing or incorrect API tokens.
- Network or timeout errors suggest connectivity problems.
- API response errors may include messages about invalid parameters; verify all filters are correctly set.
To resolve errors, ensure valid credentials are configured, input dates are logical, and filter values conform to allowed options.
Links and References
- Kiwify API Documentation (for detailed API usage and available endpoints)
- n8n documentation on HTTP Request Node for understanding underlying request mechanics