Shopware icon

Shopware

Shopware

Actions778

Integration → Search Integration

AI-generated

Overview

This node operation performs a search query on the Integration resource within the Shopware platform. It allows users to retrieve integration data based on various search parameters such as pagination (page and limit), filters, sorting, and specific fields to return. This operation is useful for scenarios where you need to find specific integrations or analyze integration data with customized search criteria, for example, filtering integrations by certain attributes or sorting them by creation date.

Use Case Examples

  1. Retrieve the first page of integrations with a limit of 10 items per page.
  2. Search integrations using specific filters to find those matching certain criteria.
  3. Sort the search results by a particular field such as name or creation date.
  4. Return only selected fields of the integration data to optimize 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 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 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 exact count), or next-pages (fast count for next pages).
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 Node-level settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout settings.

Output

JSON

  • data - The search results data containing the list of integrations matching the query.
  • total - The total number of matching integrations found (if total count mode is enabled).
  • aggregations - Aggregation results if aggregations were requested in the search query.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the JSON input for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes is correctly formatted to avoid parsing errors.
  • If the search returns no results, verify that the filter criteria and IDs are correct and exist in the Shopware system.
  • Timeout errors may occur if the server is slow or the timeout setting is too low; increase the timeout value if needed.
  • SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but use with caution as it reduces security.

Links

Discussion