Shopware icon

Shopware

Shopware

Actions778

Flow Sequence → Search Flow Sequence

AI-generated

Overview

This node operation allows users to search for flow sequences within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and aggregation options, making it useful for retrieving specific flow sequences based on complex criteria. Practical applications include managing and analyzing flow sequences in e-commerce workflows or automating business processes by querying relevant flow sequences.

Use Case Examples

  1. Retrieve the first page of flow sequences with a limit of 10 items per page.
  2. Search flow sequences filtered by specific criteria such as status or creation date.
  3. Sort flow sequences by a particular field and apply aggregations to analyze grouped 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 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 specifying related entities 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 listing the fields to 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 which fields should be returned for given entities, optimizing API response.

Output

JSON

  • data - The search results containing flow sequence records matching the query.
  • total - The total number of flow sequences matching the search criteria, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure JSON inputs (filter, sort, post-filter, associations, aggregations, grouping, fields, ids, includes) are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times due to the calculation of the exact total hits.
  • Verify that the API credentials and base URL are correctly configured to avoid authentication or connection errors.

Links

Discussion