Shopware icon

Shopware

Shopware

Actions778

Custom Field Set Relation → Search Custom Field Set Relation

AI-generated

Overview

This node performs a search operation on Custom Field Set Relations within the Shopware platform. It allows users to query and retrieve data about custom field set relations by specifying various search parameters such as pagination (page and limit), filters, sorting, post-filters, associations, aggregations, grouping, fields to return, total count mode, specific IDs, and includes. This node is useful for scenarios where detailed and customized search queries are needed to fetch specific custom field set relation data from Shopware, such as filtering relations by certain criteria, sorting results, or limiting the fields returned for performance optimization.

Use Case Examples

  1. A user wants to retrieve the first page of custom field set relations with a limit of 10 items per page, filtered by a specific condition, and sorted by a particular field.
  2. A user needs to get aggregated data on custom field set relations with specific groupings and post-filters applied.
  3. A user wants to fetch only certain fields of custom field set relations to reduce data size and improve performance.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result.
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 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 fields over which to perform groupings 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 for the search query, with options for none, exact, or next-pages.
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the API-level response fields.

Output

JSON

  • data - The array of custom field set relation objects returned from the search query.
  • total - The total number of matching custom field set relations found.
  • aggregations - Aggregation results based on the search query, if any.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access custom field set relations.
  • Verify that the JSON syntax for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes is correct 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 connectivity and proxy settings if requests fail or time out.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be cautious about security implications.

Links

Discussion