Shopware icon

Shopware

Shopware

Actions778

Custom Field → Search Custom Field

AI-generated

Overview

This node operation allows users to search for custom fields within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and aggregation options, making it useful for retrieving specific custom field data based on complex criteria. Practical examples include searching for custom fields with certain attributes, filtering results by specific conditions, or sorting the fields by creation date.

Use Case Examples

  1. Search custom fields with a filter to find only active fields.
  2. Retrieve a paginated list of custom fields with a limit of 10 per page.
  3. Sort custom fields by name in ascending order.

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 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 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 accurate), or 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, optimizing the returned data.

Output

JSON

  • data - The array of custom fields returned by the search query.
  • total - The total number of custom fields matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if any aggregations were specified.

Dependencies

  • An API key credential for authenticating with the Shopware Admin API.

Troubleshooting

  • Ensure the JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', the query may be slow for large datasets; consider using 'next-pages' for faster performance.
  • Check that the API credentials are valid and have sufficient permissions to access custom field data.

Links

Discussion