Shopware icon

Shopware

Shopware

Actions778

Language → Search Language

AI-generated

Overview

This node operation performs a search query for languages in the Shopware system. It allows users to specify various parameters to filter, sort, and customize the search results for language entities. This is useful for scenarios where you need to retrieve language data based on specific criteria, such as filtering by certain attributes, sorting results, or limiting the number of returned items. For example, you could use this node to fetch a paginated list of languages with specific filters applied or to get detailed language information with custom fields.

Use Case Examples

  1. Retrieve the first page of languages with a limit of 10 items per page.
  2. Search for languages with specific filters applied, such as languages enabled for a particular sales channel.
  3. Sort languages by name or other attributes and include only selected fields in the response.

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, which do not affect aggregation results.
Associations A JSON object defining associations to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying 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 for the search query. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page calculation).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, allowing fine-grained control over returned data.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • data - The main search result data containing language entities matching the query.
  • total - The total number of language entities matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregated data based on the search query, if aggregations are requested.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access language data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower due to the calculation of the exact total number of hits.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion