Shopware icon

Shopware

Shopware

Actions778

Mail Header Footer → Create Mail Header Footer

AI-generated

Overview

This node operation allows users to create a Mail Header Footer entity in the Shopware system. It is useful for managing email templates by defining headers and footers in both HTML and plain text formats, along with metadata such as name, description, and system default status. This operation is beneficial for automating email template management in e-commerce workflows, ensuring consistent branding and messaging in customer communications.

Use Case Examples

  1. Creating a new mail header and footer template with custom HTML and plain text content for marketing emails.
  2. Setting up system default mail header and footer for transactional emails in an online store.

Properties

Name Meaning
Response Specifies the data format for the response, either basic or detailed.
Id Unique identifier for the mail header footer entity.
System Default Indicates if this mail header footer is the system default.
Name Name of the mail header footer.
Description Description of the mail header footer.
Header Html HTML content for the mail header.
Header Plain Plain text content for the mail header.
Footer Html HTML content for the mail footer.
Footer Plain Plain text content for the mail footer.
Created At Timestamp for when the mail header footer was created.
Updated At Timestamp for when the mail header footer was last updated.
Translated JSON object containing translations for the mail header footer.
Sales Channels JSON array defining sales channels associated with the mail header footer.
Request Options Node-level request options such as batching, SSL handling, proxy, and timeout settings.

Output

JSON

  • id - Unique identifier of the created mail header footer.
  • name - Name of the created mail header footer.
  • description - Description of the created mail header footer.
  • systemDefault - Indicates if the created mail header footer is the system default.
  • headerHtml - HTML content of the mail header.
  • headerPlain - Plain text content of the mail header.
  • footerHtml - HTML content of the mail footer.
  • footerPlain - Plain text content of the mail footer.
  • createdAt - Creation timestamp of the mail header footer.
  • updatedAt - Last update timestamp of the mail header footer.
  • translated - Translations associated with the mail header footer.
  • salesChannels - Sales channels linked to the mail header footer.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure all required fields such as 'Id' and 'Name' are provided to avoid validation errors.
  • Check API credentials and base URL configuration if authentication errors occur.
  • If the response format is not as expected, verify the '_response' property value (basic or detail).
  • For large payloads in 'Sales Channels' or 'Translated' JSON fields, ensure the JSON is correctly formatted to prevent parsing errors.

Discussion