Shopware icon

Shopware

Shopware

Actions778

Mail Header Footer → Search Mail Header Footer

AI-generated

Overview

This node operation allows searching for mail header and footer entities within the Shopware platform. It is useful for retrieving specific mail header/footer configurations based on various search criteria such as pagination, filtering, sorting, and field selection. Practical applications include automating the retrieval of mail header/footer templates for customization, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of mail header/footer entries with a limit of 10 items per page.
  2. Search mail header/footer entries filtered by specific criteria such as creation date or status.
  3. Sort mail header/footer results by name or creation date.
  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, 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 conditions.
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 related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array defining 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 only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to control the data returned at the API level.
Request Options Node-level settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout settings.

Output

JSON

  • data - The search results containing mail header/footer entities matching the query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access mail header/footer data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If using pagination, ensure the page and limit values are within valid ranges to avoid empty results.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security implications.

Links

Discussion