Shopware icon

Shopware

Shopware

Actions778

Locale → Search Locale

AI-generated

Overview

This node performs a search operation for locales in the Shopware system. It allows users to query locale data with various parameters such as pagination, filtering, sorting, and field selection. This is useful for retrieving specific locale information or lists of locales based on custom search criteria, which can be applied in scenarios like localization management or content customization.

Use Case Examples

  1. Retrieve a paginated list of locales with a limit on the number of items per page.
  2. Search for locales using specific filters to narrow down results based on locale attributes.
  3. Sort the search results by certain locale fields.
  4. Select specific fields to be returned in the search results to optimize data usage.

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 Filters applied to the search results without affecting aggregations.
Associations JSON object defining associations to include in the search results.
Aggregations JSON list defining aggregations to be included in the search results.
Grouping JSON list specifying groupings over certain fields in the search results.
Fields JSON list specifying which fields should be returned in the search results.
Total Count Mode Determines how the total number of hits is calculated for the search query.
Ids A JSON list of specific locale IDs to search for.
Includes JSON object specifying fields to be returned for given entities, used to control the response content.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The main search result data containing locale information.
  • total - The total number of matching locales found by the search.
  • aggregations - Aggregated data based on the search query, if any aggregations were requested.

Dependencies

  • Requires an API key credential for Shopware Admin API access.

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is correctly formatted.
  • Setting an excessively high limit or requesting exact total count mode may slow down the search or cause timeouts.
  • Incorrect API credentials or base URL configuration will result in authentication errors.
  • SSL certificate validation errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this is insecure.

Links

Discussion