Shopware icon

Shopware

Shopware

Actions778

Tax Rule Type → Search Tax Rule Type

AI-generated

Overview

This node performs a search operation for Tax Rule Types in the Shopware system. It allows users to query tax rule types with various parameters such as pagination (page and limit), filtering, sorting, and specifying fields to return. This is useful for retrieving specific tax rule types based on complex search criteria, which can be applied in e-commerce platforms to manage tax rules effectively.

Use Case Examples

  1. Retrieve a paginated list of tax rule types with a limit of 10 per page.
  2. Search tax rule types with specific filters to find those applicable to certain regions or conditions.
  3. Sort tax rule types by a specific attribute and return only selected fields for performance optimization.

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 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: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of tax rule type objects returned from the search query.
  • total - The total number of tax rule types 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

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause errors. Ensure JSON is well-formed.
  • Incorrect pagination values (page or limit) may result in empty or unexpected results.
  • Using 'exact' total count mode can slow down the query significantly on large datasets.
  • SSL certificate validation errors can occur if 'Ignore SSL Issues' is not enabled when using self-signed certificates.

Links

Discussion