Shopware icon

Shopware

Shopware

Actions778

Custom Field → Update Custom Field

AI-generated

Overview

This node operation updates a custom field in the Shopware system. It is useful for scenarios where you need to modify the properties of an existing custom field, such as changing its name, type, configuration, or activation status. For example, you might update a custom field to change its visibility, adjust its configuration JSON, or link it to a different custom field set.

Use Case Examples

  1. Updating the name and type of a custom field identified by its ID.
  2. Activating or deactivating a custom field by setting the 'Active' property.
  3. Modifying the configuration JSON of a custom field to change its behavior or validation rules.

Properties

Name Meaning
Id Identifier for the custom_field, used to specify which custom field to update.
Response Data format for response; controls the response format returned by the API.
Name The new name for the custom field.
Type The type of the custom field (e.g., string, boolean, etc.).
Config JSON configuration object for the custom field, parsed from string input.
Active Boolean flag indicating whether the custom field is active.
Custom Field Set Id Identifier of the custom field set to which this custom field belongs.
Allow Customer Write Boolean flag indicating if customers are allowed to write to this custom field.
Allow Cart Expose Boolean flag indicating if the custom field is exposed in the cart.
Created At Timestamp string indicating when the custom field was created.
Updated At Timestamp string indicating when the custom field was last updated.
Custom Field Set JSON object representing the custom field set details, parsed from string input.
Product Search Config Fields JSON array representing product search configuration fields related to the custom field, parsed from string input.

Output

JSON

  • id - The identifier of the updated custom field.
  • name - The updated name of the custom field.
  • type - The updated type of the custom field.
  • config - The updated configuration JSON object of the custom field.
  • active - The updated active status of the custom field.
  • customFieldSetId - The updated custom field set identifier.
  • allowCustomerWrite - The updated flag indicating if customers can write to the custom field.
  • allowCartExpose - The updated flag indicating if the custom field is exposed in the cart.
  • createdAt - The creation timestamp of the custom field.
  • updatedAt - The last updated timestamp of the custom field.
  • customFieldSet - The updated custom field set details as a JSON object.
  • productSearchConfigFields - The updated product search configuration fields as a JSON array.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the 'Id' property is correctly set to the identifier of an existing custom field; otherwise, the update will fail.
  • Verify that the JSON inputs for 'Config', 'Custom Field Set', and 'Product Search Config Fields' are valid 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 the API returns errors related to permissions, verify that the API key has sufficient rights to update custom fields.

Discussion