Shopware icon

Shopware

Shopware

Actions778

Custom Entity → Search Custom Entity

AI-generated

Overview

This node operation allows searching within a Custom Entity in the Shopware system. It supports detailed search queries with pagination, filtering, sorting, and other advanced search options. This is useful for retrieving specific subsets of data from custom entities based on complex criteria, such as filtering by attributes, sorting results, and controlling the number of results per page.

Use Case Examples

  1. Retrieve a paginated list of custom entities filtered by specific attributes.
  2. Sort custom entity search results by a particular field.
  3. Apply complex filters and aggregations to analyze custom entity data.

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 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 specifying aggregations to perform on the search results.
Grouping JSON array defining groupings over certain fields in the search results.
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 return for given entities, used to control API-level field stripping.
Request Options Settings for batching, SSL certificate validation, proxy usage, and request timeout.

Output

JSON

  • data - The search results returned from the Custom Entity 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

  • Invalid JSON in filter, sort, or other JSON input fields can cause errors; ensure valid JSON format.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • Misconfigured request options like proxy or SSL settings can cause connection failures.
  • If total count mode is set to 'exact', the query may be slow on large datasets.

Links

Discussion