Shopware icon

Shopware

Shopware

Actions778

System Config → Search System Config

AI-generated

Overview

This node operation allows searching system configuration data within the Shopware platform. It is useful for retrieving specific system configuration entries based on various search criteria such as pagination, filtering, sorting, and grouping. Practical applications include automating the retrieval of system settings for monitoring, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of system configuration entries with a limit of 10 items per page.
  2. Search system configurations with specific filters to find configurations matching certain criteria.
  3. Sort system configuration results by a specific field in ascending or descending order.

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 list of filters to restrict the search results based on specific conditions.
Sort Sorting criteria to order the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations Associations to include in the search results.
Aggregations Aggregation criteria to summarize data in the search results.
Grouping Fields over which to perform groupings in the search results.
Fields Specific fields to be returned in the search results.
Total Count Mode Determines 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).
Ids List of specific IDs to search for.
Includes Specify fields to be returned for given entities, improving performance by limiting returned data.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The array of system configuration entries returned by the search.
  • total - The total number of matching system configuration entries found.
  • aggregations - Aggregation results based on the search criteria, if any.

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 system configuration data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If using batching, adjust batch size and interval to avoid rate limiting or timeouts.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity issues.

Links

Discussion