Shopware icon

Shopware

Shopware

Actions778

Theme → Search Theme

AI-generated

Overview

This node operation performs a search query for themes in a Shopware environment. It allows users to specify various parameters to control the search results, such as pagination (page and limit), filtering, sorting, and field selection. This is useful for retrieving theme data based on specific criteria, for example, to display available themes in a storefront or to manage themes programmatically.

Use Case Examples

  1. Search for themes with specific filters and sorting criteria.
  2. Retrieve a paginated list of themes with selected fields only.

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 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 control how the total count of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
Ids JSON array of specific theme IDs to search for.
Includes JSON object specifying fields to include for given entities, overriding default field stripping at the API level.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout.

Output

JSON

  • data - The search results containing theme data matching the query parameters.
  • total - The total number of themes matching the search criteria, if total count mode is enabled.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is correctly formatted.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the request significantly on large datasets.
  • SSL certificate validation errors can be bypassed by enabling 'Ignore SSL Issues' but this is insecure.
  • Proxy misconfiguration can cause connection failures. Verify proxy URL and credentials if used.

Links

Discussion