Shopware icon

Shopware

Shopware

Actions778

Newsletter Recipient → Search Newsletter Recipient

AI-generated

Overview

This node operation allows searching for newsletter recipients within the Shopware system. It supports pagination, filtering, sorting, and various advanced search query options to refine the search results. This is useful for scenarios where you need to retrieve specific newsletter recipient data based on complex criteria, such as filtering by attributes, sorting by certain fields, or limiting the number of results per page.

Use Case Examples

  1. Retrieve a list of newsletter recipients who subscribed within a certain date range.
  2. Search for newsletter recipients with specific attributes or tags using filters.
  3. Paginate through newsletter recipients in batches for processing or reporting.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
Ids A JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data fields.

Output

JSON

  • data - The array of newsletter recipient objects returned from the search.
  • total - The total number of newsletter recipients matching the search criteria, if total count mode is enabled.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access newsletter recipient data.
  • Verify that JSON inputs for filters, sorting, and other advanced options are correctly formatted to avoid parsing errors.
  • If pagination parameters (page, limit) are set incorrectly, the node may return empty or incomplete results.

Links

Discussion