Shopware icon

Shopware

Shopware

Actions778

Flow Template → Search Flow Template

AI-generated

Overview

This node operation allows searching for flow templates within the Shopware platform. It is useful for retrieving flow templates based on various criteria such as pagination, filtering, sorting, and specific fields. This can help automate workflows that depend on flow templates, for example, fetching templates for display, analysis, or further processing in an automation pipeline.

Use Case Examples

  1. Retrieve the first page of flow templates with a limit of 10 items per page.
  2. Search flow templates with specific filters to find templates matching certain criteria.
  3. Sort flow templates by a specific field and return only selected fields for performance optimization.

Properties

Name Meaning
Page The page number of the search results to retrieve.
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 conditions.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining associations to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying fields to group the search results by.
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 only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.

Output

JSON

  • data - The main search result data containing flow templates matching the search criteria.
  • total - The total number of flow templates matching the search criteria, depending on the total count mode.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure JSON inputs (filter, sort, post-filter, associations, aggregations, grouping, fields, ids, includes) are correctly formatted JSON strings to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times due to full count calculation.
  • Check API credentials and base URL configuration if authentication or connection errors occur.
  • Verify that pagination parameters (page, limit) are within valid ranges to avoid empty or incomplete results.

Links

Discussion