Shopware icon

Shopware

Shopware

Actions778

Rule Condition → Search Rule Condition

AI-generated

Overview

This node operation allows searching for rule conditions within the Shopware system. It supports pagination, filtering, sorting, and various advanced search query options to refine the search results. This is useful for scenarios where you need to retrieve specific rule conditions based on complex criteria, such as filtering by attributes, sorting results, or limiting the fields returned.

Use Case Examples

  1. Retrieve a paginated list of rule conditions with specific filters applied.
  2. Search for rule conditions sorted by creation date.
  3. Fetch rule conditions with only selected fields to optimize performance.

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 Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object defining associations 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).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, affecting API-level field stripping.

Output

JSON

  • data - The array of rule condition objects returned from the search.
  • total - The total number of rule conditions matching the search criteria.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the JSON inputs for filters, sorting, and other advanced options 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 count.
  • Verify that the API credentials and base URL are correctly configured to avoid authentication or connection errors.

Links

Discussion