Shopware icon

Shopware

Shopware

Actions778

App → Search App

AI-generated

Overview

This node performs a search operation on the 'App' resource within the Shopware platform. It allows users to query and retrieve app data based on various search parameters such as pagination, filtering, sorting, and field selection. This node is useful for scenarios where you need to programmatically search for apps with specific criteria, for example, retrieving a list of apps that match certain filters or sorting them by a particular attribute.

Use Case Examples

  1. Search for apps with specific filters and sorting criteria.
  2. Retrieve a paginated list of apps with a limit on the number of items per page.
  3. Fetch specific fields and associations related to apps for detailed data retrieval.

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 conditions.
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 the aggregation results.
Associations A JSON object specifying related entities 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 for the search query. Options include none (disabled), exact (slow but accurate), and 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 the list of apps matching the query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access the Shopware Admin API.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower due to the calculation of the exact total number of hits.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.

Links

Discussion