Shopware icon

Shopware

Shopware

Actions778

App Template → Search App Template

AI-generated

Overview

This node operation allows searching for app templates within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific app template data efficiently. This is useful for scenarios where you need to find app templates based on various criteria, such as filtering by attributes, sorting results, or limiting the fields returned for performance optimization.

Use Case Examples

  1. Searching for app templates with specific filters and sorting to display in a dashboard.
  2. Paginating through app template search results to process or display them in batches.
  3. Retrieving only certain fields of app templates to reduce data size and improve performance.

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 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 related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining groupings over certain fields in the search results.
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.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The search results containing app template data matching the query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure JSON inputs for filters, sorting, and other parameters 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 total hits.
  • Check network settings if using proxy or if SSL certificate validation fails and 'Ignore SSL Issues' is disabled.
  • Verify that the API credentials are valid and have sufficient permissions to perform search operations.

Links

Discussion