Shopware icon

Shopware

Shopware

Actions778

Currency → Search Currency

AI-generated

Overview

This node performs a search operation for currencies in the Shopware system. It allows users to specify various search parameters such as pagination (page and limit), filters, sorting, post-filters, associations, aggregations, grouping, fields to return, total count mode, specific IDs, and includes. This is useful for retrieving currency data based on complex search criteria, for example, to display available currencies in an e-commerce platform or to analyze currency-related data.

Use Case Examples

  1. Retrieve a paginated list of currencies with specific filters applied.
  2. Sort currencies by a particular attribute and limit the number of results per page.
  3. Use aggregations and groupings to analyze currency data.

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, which do not affect 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 for the search query. Options include none (disabled), exact (slow but exact count), and next-pages (fast count for next pages).
Ids A JSON list of specific currency IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, improving performance by limiting returned data.

Output

JSON

  • data - The array of currency objects returned from the search.
  • total - The total number of currencies matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are used.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access currency data.
  • Verify that JSON inputs for filters, sorting, post-filters, associations, aggregations, grouping, fields, ids, and includes 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 count.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion