Shopware icon

Shopware

Shopware

Actions778

Tag → Search Tag

AI-generated

Overview

This node performs a search operation for tags within the Shopware platform. It allows users to specify 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 retrieving tag data based on complex search criteria, which can be applied in scenarios like filtering tags for product categorization, analytics, or content management within Shopware.

Use Case Examples

  1. Retrieve a paginated list of tags with specific filters applied to find tags related to a certain category.
  2. Sort tags by name or creation date and limit the number of results per page for display in a custom dashboard.
  3. Use aggregations and groupings to analyze tag usage statistics across the Shopware store.

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 Filters applied after aggregations that do not affect the aggregation results.
Associations JSON object defining related entities to include in the search results.
Aggregations JSON array specifying aggregations to perform on the search results.
Grouping JSON array defining groupings over certain fields in the search results.
Fields 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. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page calculation).
Ids JSON array of specific tag IDs to search for.
Includes JSON object specifying fields to be returned for given entities, used to control the response content.

Output

JSON

  • data - The array of tag objects returned from the search query.
  • total - The total number of tags matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations were requested.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access tag data.
  • Verify that JSON inputs for filters, sorting, post-filters, associations, aggregations, grouping, fields, ids, and includes are correctly formatted to avoid parsing errors.
  • If the total count mode is set to exact, be aware that the query might be slow for large datasets.
  • 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 only if safe to do so.

Links

Discussion