Shopware icon

Shopware

Shopware

Actions778

Notification → Search Notification

AI-generated

Overview

This node operation performs a search query for notifications within the Shopware platform. It allows users to specify various parameters to control the search results, such as pagination (page and limit), filtering criteria, sorting order, and fields to be returned. This operation is useful for retrieving notifications based on specific conditions, aggregating data, or grouping results, which can be applied in scenarios like monitoring system alerts, user notifications, or any event-driven messages within Shopware.

Use Case Examples

  1. Retrieve the first page of notifications with a limit of 10 items per page.
  2. Search notifications filtered by specific criteria such as date range or notification type.
  3. Sort notifications by creation date in descending order.
  4. Fetch only certain fields of notifications to optimize data transfer.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result, controlling the page size.
Filter A JSON array of filters to restrict the search results based on specific conditions.
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 JSON array specifying aggregations to perform on the search results.
Grouping JSON array defining groupings over certain fields in the search results.
Fields 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 calculation).
Ids JSON array of specific notification IDs to search for.
Includes JSON object specifying fields to be returned for given entities, used to control the response content at the API level.
Request Options Collection of additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The search results containing the notifications matching the query parameters.
  • total - The total number of notifications found matching the search criteria, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON input for filters, sorting, and other JSON properties is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', the search may be slow for large datasets; consider using 'next-pages' or 'none' for performance.
  • Check network and proxy settings if requests fail or time out.
  • If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, the request will be rejected.

Links

Discussion