Kiwify icon

Kiwify

Interagir com a API da Kiwify

Actions19

Overview

This node integrates with the Kiwify API to list sales data within a specified date range and with optional filters. It is useful for users who want to retrieve detailed or summary information about sales transactions from their Kiwify account, enabling them to analyze sales performance, track payment statuses, or filter by product and payment method.

Practical examples include:

  • Fetching all approved sales between two dates to generate a sales report.
  • Filtering sales paid via PIX in a given period to reconcile payments.
  • Retrieving full details of each sale for auditing or customer service purposes.

Properties

Name Meaning
Data De Início Start date to search for sales (format: YYYY-MM-DD).
Data De Fim End date to search for sales (format: YYYY-MM-DD).
Status Filter sales by status. Options: Aguardando Pagamento, Aprovado, Autorizado, Estornado, Pago, Pendente, Processando, Recusado, Reembolsado, Reembolso Pendente, Reembolso Solicitado, Todos (all).
Método De Pagamento Filter sales by payment method. Options: Todos (all), Boleto, Cartão De Crédito, PIX.
ID Do Produto Optional filter by product ID to narrow down sales to a specific product.
Detalhes Completos Da Venda Boolean flag indicating whether to return full sale details (true) or just summary data (false).

Output

The node outputs an array of JSON objects representing sales data retrieved from the Kiwify API. Each object corresponds to a sale record and includes fields such as sale ID, date, status, payment method, product details, and optionally full sale details if requested.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kiwify API.
  • The node uses OAuth token retrieval internally by exchanging client credentials.
  • Requires configuration of the Kiwify account ID in the credentials.
  • Network access to https://public-api.kiwify.com is necessary.

Troubleshooting

  • Authentication errors: If the node fails to authenticate, verify that the provided API credentials (client ID, client secret, and account ID) are correct and have sufficient permissions.
  • Invalid date format: Ensure that the start and end dates are provided in the YYYY-MM-DD format; otherwise, the API may reject the request.
  • Empty results: If no sales are returned, check the date range and filters to confirm they match existing sales data.
  • API rate limits or downtime: Temporary failures might occur due to API limits or service issues; retry after some time or check Kiwify's status page.
  • Error messages: The node throws errors with messages from the API response. Review these messages to adjust parameters or credentials accordingly.

Links and References

Discussion