Actions9
- Message Actions
- Contact Actions
- Group Actions
- Account Actions
- Purchase Actions
Purchase → Get All
AI-generatedOverview
This node operation retrieves a list of purchase records from the Nimba SMS API. It supports filtering by payment type, start date, and end date, and allows pagination through limit and offset parameters. Users can choose to return all results or limit the number of results returned. This operation is useful for viewing purchase history and invoices, enabling users to analyze transaction data or generate reports.
Use Case Examples
- Retrieve all purchase records without limit to analyze complete purchase history.
- Fetch up to 50 purchase records filtered by payment type 'Orange Money' within a specific date range for financial reporting.
- Get a limited number of purchase records with an offset to paginate through purchase data.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all purchase results or only up to a given limit. |
| Limit | Maximum number of purchase results to return when 'Return All' is false. |
| Additional Fields | Optional filters and parameters for the purchase query, including payment type, start date, end date, and offset for pagination. |
Output
JSON
json- The purchase record data returned from the API for each purchase.
Dependencies
- Nimba SMS API with an API key credential
Troubleshooting
- Ensure the API key credential is correctly configured and has permissions to access purchase data.
- Check that date filters (start_date and end_date) are in the correct dateTime format.
- If no results are returned, verify that the filters applied (payment type, date range) match existing purchase records.
- Handle API rate limits or network errors by enabling 'Continue On Fail' to avoid workflow interruption.
Links
- Nimba SMS API Purchase Documentation - Official API documentation for purchase-related endpoints and parameters.