Shopware icon

Shopware

Shopware

Actions778

Mail Template → Search Mail Template

AI-generated

Overview

This node operation allows searching for mail templates within the Shopware system. It is useful for retrieving mail templates based on various search criteria such as pagination, filtering, sorting, and field selection. Practical applications include automating the retrieval of specific mail templates for review, modification, or integration with other workflows.

Use Case Examples

  1. Retrieve the first page of mail templates with a limit of 10 items per page.
  2. Search mail templates using specific filters to find templates matching certain criteria.
  3. Sort mail templates by creation date or name.
  4. Select specific fields to be returned in the search results for optimized data handling.

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, 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 specifying fields to group the search results by.
Fields A JSON list of fields to be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids A JSON list of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, affecting API-level field stripping.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The search results containing mail template data returned from the API.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access mail templates.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If using SSL, ensure the certificate is valid or enable the option to ignore SSL issues if necessary.

Links

Discussion