Shopware icon

Shopware

Shopware

Actions778

Country → Search Country

AI-generated

Overview

This node operation allows searching for countries using various search parameters. It is useful for retrieving country data from a Shopware API with flexible filtering, sorting, pagination, and field selection options. For example, it can be used to fetch a paginated list of countries filtered by specific criteria, sorted by certain fields, or to retrieve only selected fields for performance optimization.

Use Case Examples

  1. Search for countries with a specific filter and sort order, limiting results to 10 per page.
  2. Retrieve country data including specific associations and aggregations for analytics purposes.

Properties

Name Meaning
Page The page number of the search results to retrieve.
Limit The number of items to return per page in the search results.
Filter A JSON list of filters to restrict the search results based on specific criteria.
Sort A JSON list defining the sorting order of the search results.
Post Filter A JSON list 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 list defining aggregations to perform on the search results.
Grouping A JSON list defining groupings over certain fields in the search results.
Fields A JSON list 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), or next-pages (fast).
Ids A JSON list of specific country IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.

Output

JSON

  • data - The array of country objects returned by the search.
  • total - The total number of matching countries found.
  • aggregations - Aggregation results based on the search query.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Invalid JSON in filter, sort, or other JSON input fields can cause errors. Ensure valid JSON format.
  • Incorrect pagination parameters (page or limit) may result in empty or incomplete results.
  • API authentication errors if credentials are missing or invalid.
  • Timeouts or SSL issues if network settings are misconfigured.

Links

Discussion