Shopware icon

Shopware

Shopware

Actions778

Tax Provider → Search Tax Provider

AI-generated

Overview

This node operation allows searching for tax providers within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific tax provider data efficiently. This is useful in scenarios where you need to integrate or analyze tax provider information programmatically, such as in e-commerce platforms or financial applications.

Use Case Examples

  1. Retrieve a paginated list of tax providers with specific filters applied to narrow down results.
  2. Sort tax providers by a particular attribute and limit the fields returned for performance optimization.
  3. Use aggregations and groupings to analyze tax provider data distribution.

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.

Output

JSON

  • data - The array of tax provider objects returned from the search query.
  • total - The total number of tax providers matching the search criteria, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication and access.

Troubleshooting

  • Ensure the JSON input for filters, sorting, and other JSON properties is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times due to the calculation overhead.
  • Verify that the API credentials are valid and have sufficient permissions to perform search operations.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion