Shopware icon

Shopware

Shopware

Actions778

Salutation → Update Salutation

AI-generated

Overview

This node operation updates a Salutation resource in the Shopware system. It allows users to modify details of an existing salutation by specifying its identifier and providing updated fields such as salutation key, display name, letter name, and various related JSON objects like custom fields, customers, customer addresses, order customers, order addresses, and newsletter recipients. This operation is useful for managing and maintaining accurate salutation data in an e-commerce or CRM system integrated with Shopware.

Use Case Examples

  1. Updating a salutation's display name and letter name to reflect a new company policy.
  2. Modifying the salutation key and associated customer data to correct errors or add new information.

Properties

Name Meaning
Id Identifier for the salutation, required to specify which salutation to update.
Salutation Key The key representing the salutation, used to identify or categorize it.
Display Name The display name of the salutation, shown in user interfaces.
Letter Name The letter name associated with the salutation, often used in formal communications.
Custom Fields Custom JSON fields for additional salutation data.
Created At Timestamp string indicating when the salutation was created.
Updated At Timestamp string indicating when the salutation was last updated.
Translated JSON object containing translated versions of the salutation data.
Customers JSON array representing customers associated with the salutation.
Customer Addresses JSON array representing customer addresses linked to the salutation.
Order Customers JSON array representing customers related to orders with this salutation.
Order Addresses JSON array representing order addresses associated with the salutation.
Newsletter Recipients JSON array representing newsletter recipients linked to the salutation.
_response Data format for the response, used as a query parameter to specify response details.

Output

JSON

  • id - The unique identifier of the updated salutation.
  • salutationKey - The key of the updated salutation.
  • displayName - The display name of the updated salutation.
  • letterName - The letter name of the updated salutation.
  • customFields - Custom fields associated with the updated salutation.
  • createdAt - Creation timestamp of the updated salutation.
  • updatedAt - Last update timestamp of the updated salutation.
  • translated - Translated data of the updated salutation.
  • customers - Customers associated with the updated salutation.
  • customerAddresses - Customer addresses linked to the updated salutation.
  • orderCustomers - Order customers related to the updated salutation.
  • orderAddresses - Order addresses associated with the updated salutation.
  • newsletterRecipients - Newsletter recipients linked to the updated salutation.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the salutation you want to update; otherwise, the update will fail or affect the wrong record.
  • Verify that JSON fields like 'customFields', 'customers', 'customerAddresses', 'orderCustomers', 'orderAddresses', and 'newsletterRecipients' are properly formatted JSON strings to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure successful authentication and connection to the Shopware Admin API.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option in request settings, but be aware of security implications.

Discussion