Shopware icon

Shopware

Shopware

Actions778

Custom Field Set → Search Custom Field Set

AI-generated

Overview

This node operation allows searching for Custom Field Sets in the Shopware system. It is useful for retrieving specific sets of custom fields based on various search criteria, filters, sorting, and pagination. For example, a user can search for custom field sets with certain attributes, limit the number of results per page, and sort them by specific fields.

Use Case Examples

  1. Search for custom field sets with a filter to find only active sets.
  2. Retrieve a paginated list of custom field sets with a limit of 10 per page.
  3. Sort custom field sets by creation date in 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 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 defining 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 Determines how the total number of hits is calculated for the search query. Options are none (disabled), exact (slow but exact count), and next-pages (fast count for next pages only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, optimizing the response by including only necessary fields.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • data - The array of custom field sets returned by the search query.
  • total - The total number of custom field sets matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are requested.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access custom field sets.
  • 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', expect slower response times for large datasets; consider using 'next-pages' or 'none' for better performance.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.

Links

Discussion