Actions47
- Template Actions
- Communication Actions
- Card Actions
- Create
- Get
- Get All
- Update
- Delete
- Get Balance
- Add Points
- Deduct Points
- Add Amount
- Deduct Amount
- Add Stamps
- Deduct Stamps
- Transfer Points
- Transfer Amount
- Block Card
- Unblock Card
- Generate QR Code
- Get Operations
- Add Visits
- Deduct Visits
- Add Reward
- Deduct Reward
- Receive Reward
- Redeem Coupon
- Set Expiration Date
- Set Membership Tier
- Customer Actions
- Company Actions
- Analytics Actions
- System Actions
Overview
This node interacts with a Digital Wallet Cards loyalty program API, specifically managing company data when the resource is set to "Company" and the operation is "Get All". It retrieves a list of companies from the API, supporting pagination, sorting, and limiting the number of results returned.
Common scenarios for this node include:
- Fetching all companies registered in the loyalty program for reporting or synchronization.
- Retrieving a subset of companies with control over pagination and sorting to display in dashboards or further processing.
- Integrating company data into other workflows where company information is needed.
Example use case:
- An e-commerce platform wants to synchronize its partner companies with the loyalty program. Using this node, it can fetch all companies, page by page, sorted by name ascending, and update its local database accordingly.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or limit to a specific number. |
| Limit | Maximum number of results to return (used if Return All is false). |
| Additional Fields | Optional fields to customize the request: |
| - Page | Page number for pagination (starting at 1). |
| - Sort By | Field name to sort the results by (e.g., "name", "createdAt"). |
| - Sort Order | Sort order for results: "Ascending" or "Descending". |
Output
The output is an array of JSON objects representing companies retrieved from the API. Each object typically contains company details such as:
companyId: Unique identifier of the company.name: Company name.description: Description of the company (if provided).website: Website URL of the company (if provided).logo: URL to the company's logo (if provided).metadata: Additional metadata associated with the company.
The node does not output binary data.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests to the Digital Wallet Cards API.
- The base URL for API requests is
https://api.digitalwallet.cards. - Pagination and sorting parameters are passed as query parameters to the API endpoint
/api/v2/companies.
Troubleshooting
- Empty results: Ensure that the correct pagination parameters are set. If
Return Allis false andLimitis low, only a limited number of companies will be returned. - API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Invalid sort field: If the
Sort Byfield does not match any valid company property, the API may ignore it or return an error. - Pagination issues: The
Pageparameter must be >= 1; otherwise, the API might return an error or unexpected results. - Malformed additional fields: The
Additional Fieldscollection should contain valid values; invalid JSON or unsupported fields may cause request failures.
Links and References
- Digital Wallet Cards API Documentation (hypothetical link)
- n8n documentation on Creating Custom Nodes
- General REST API pagination concepts: https://swagger.io/docs/specification/2-0/pagination/