Shopware icon

Shopware

Shopware

Actions778

Flow → Search Flow

AI-generated

Overview

This node performs a search operation on Flow resources within the Shopware platform. It allows users to query flows with various parameters such as pagination (page, limit), filtering, sorting, and grouping. This is useful for retrieving specific flows based on complex search criteria, for example, finding flows that match certain filters or sorting flows by specific fields.

Use Case Examples

  1. Retrieve the first page of flows with a limit of 10 items per page.
  2. Search flows with specific filters applied to narrow down results.
  3. Sort flows by creation date or other attributes.
  4. Use aggregations and groupings to analyze flow data.

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 JSON array defining aggregations to perform on the search results.
Grouping JSON array specifying fields to group the search results by.
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 only).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, affecting API-level field stripping.
Request Options Node-level settings for batching, SSL certificate validation, proxy usage, and request timeout.

Output

JSON

  • data - The search results data containing the matched Flow entities and related information.

Dependencies

  • Requires Shopware Admin API credentials for authentication.

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause errors. Ensure JSON is well-formed.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • Improper total-count-mode setting may affect performance or result accuracy.
  • Network or authentication issues with Shopware Admin API credentials can cause request failures.

Links

Discussion