Shopware icon

Shopware

Shopware

Actions778

Tax → Search Tax

AI-generated

Overview

This node operation performs a search query on the Tax resource in the Shopware system. It allows users to retrieve tax-related data based on various search parameters such as pagination (page, limit), filters, sorting, post-filters, associations, aggregations, grouping, and specific fields to be returned. This operation is useful for scenarios where detailed tax information is needed, filtered and sorted according to specific business requirements, such as generating tax reports or integrating tax data into other systems.

Use Case Examples

  1. Retrieve a paginated list of tax entries with specific filters applied to only include active tax rates.
  2. Sort tax entries by their rate or name and limit the number of results per page for efficient data handling.
  3. Use aggregations and groupings to analyze tax data across different categories or regions.

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, controlling the size of each page.
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 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 how to group the search results over certain fields.
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 within the Tax resource.
Includes A JSON object specifying which fields should be returned for given entities, used to control the data returned at the API level for performance optimization.

Output

JSON

  • data - The array of tax records returned from the search query.
  • total - The total number of tax records matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the specified aggregation parameters.

Dependencies

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

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access the Tax resource.
  • Verify that JSON inputs for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times due to the calculation of the exact total number of hits.
  • Check network settings such as proxy configuration and SSL certificate validation if requests fail or time out.

Links

Discussion