Shopware icon

Shopware

Shopware

Actions778

Product Stream → Search Product Stream

AI-generated

Overview

This node operation allows searching within the Product Stream resource in Shopware. It supports detailed search queries with pagination, filtering, sorting, and other advanced search options. This is useful for retrieving specific product streams based on complex criteria, such as filtering by attributes, sorting results, and controlling the number of results per page.

Use Case Examples

  1. Retrieve the first page of product streams with a limit of 10 items per page.
  2. Search product streams with specific filters applied to narrow down results.
  3. Sort product streams by a certain field and apply post-filters without affecting aggregations.

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 criteria.
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).
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.
Request Options Settings for request behavior such as batching, SSL validation, proxy, and timeout.

Output

JSON

  • data - The search results returned from the Product Stream query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON input for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes is 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.
  • Check network settings if using proxy or if SSL validation issues occur, especially when 'Ignore SSL Issues' is enabled.
  • Timeout errors may occur if the server takes too long to respond; adjust the timeout setting accordingly.

Links

Discussion