Shopware icon

Shopware

Shopware

Actions778

Mail Template Type → Search Mail Template Type

AI-generated

Overview

This node operation allows searching for mail template types within the Shopware system. It is useful for retrieving mail template type data based on various search criteria such as pagination, filtering, sorting, and field selection. Practical applications include automating the retrieval of specific mail template types for further processing or integration with other systems.

Use Case Examples

  1. Retrieve the first page of mail template types with a limit of 10 items per page.
  2. Search mail template types with specific filters to find templates matching certain criteria.
  3. Sort mail template types by a specific field and limit the fields returned for performance optimization.

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 conditions.
Sort A JSON list defining the sorting order of the search results.
Post Filter A JSON list of filters applied after aggregations, not affecting the 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 accurate), and next-pages (fast for next page only).
Ids A JSON list of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used for API-level field filtering.
Request Options Node-level request options including batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The array of mail template type objects returned from the search.
  • total - The total number of mail template types matching the search criteria.
  • aggregations - Aggregation results if any aggregations were requested in the search.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to perform search operations.
  • 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 search may 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