Shopware icon

Shopware

Shopware

Actions778

Tax Rule → Search Tax Rule

AI-generated

Overview

This node operation allows searching for tax rules within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific tax rule data efficiently. This is useful for scenarios where you need to programmatically access tax rule information, such as integrating tax data into financial systems or automating tax-related workflows.

Use Case Examples

  1. Retrieve a paginated list of tax rules with specific filters applied to find tax rules relevant to a particular region or product category.
  2. Sort tax rules by a certain attribute and limit the fields returned to optimize data processing in an external application.

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: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
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 objects returned from the search query.
  • total - The total number of tax rules 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 authenticating with the Shopware Admin API.

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access tax rule data.
  • 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 performance.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.

Links

Discussion