Shopware icon

Shopware

Shopware

Actions778

Country State → Search Country State

AI-generated

Overview

This node operation allows searching for country states within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific subsets of country state data efficiently. This is useful for scenarios where you need to display or process country state information based on dynamic criteria, such as filtering states by certain attributes or sorting them in a particular order.

Use Case Examples

  1. Retrieve the first page of country states with a limit of 10 items per page.
  2. Search country states filtered by a specific attribute using JSON filters.
  3. Sort country states by name or other fields.
  4. Select specific fields to be returned in the search results for optimized data handling.

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 A JSON array of filters applied after aggregations, not affecting 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 groupings over certain fields in the search results.
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: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control returned data at the API level.
Request Options Node-level request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The search results containing country state records matching the query.
  • total - The total number of hits found for the search query, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure JSON inputs for filters, sort, post-filter, 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 and proxy settings if requests fail or time out.
  • If SSL certificate validation is disabled, be cautious of security risks.

Links

Discussion