Shopware icon

Shopware

Shopware

Actions778

Custom Entity → Update Custom Entity

AI-generated

Overview

This node operation updates a Custom Entity in the Shopware system. It is useful for scenarios where you need to modify existing custom entities by specifying their identifier and providing updated data fields. For example, you can update the name, fields, flags, and other metadata of a custom entity programmatically within an automation workflow.

Use Case Examples

  1. Updating a custom entity's name and fields after receiving new data from an external source.
  2. Modifying flags or metadata of a custom entity based on business logic triggers.

Properties

Name Meaning
Id Identifier for the custom_entity, used to specify which entity to update.
Response Data format for the response; controls how the response data is returned.
Name The new name to assign to the custom entity.
Fields JSON object representing the fields and their values to update in the custom entity.
Flags JSON object representing flags associated with the custom entity.
App Id Application identifier related to the custom entity.
Plugin Id Plugin identifier related to the custom entity.
Cms Aware Boolean flag indicating if the entity is CMS aware; a runtime field not used as criteria.
Store Api Aware Boolean flag indicating if the entity is aware of the Store API; a runtime field not used as criteria.
Custom Fields Aware Boolean flag indicating if the entity supports custom fields.
Label Property Label property of the custom entity.
Deleted At Timestamp string indicating when the entity was deleted.
Created At Timestamp string indicating when the entity was created.
Updated At Timestamp string indicating when the entity was last updated.

Output

JSON

  • id - Identifier of the updated custom entity.
  • name - Name of the updated custom entity.
  • fields - Fields and their updated values in the custom entity.
  • flags - Flags associated with the updated custom entity.
  • appId - Application ID related to the updated custom entity.
  • pluginId - Plugin ID related to the updated custom entity.
  • cmsAware - Indicates if the updated entity is CMS aware.
  • storeApiAware - Indicates if the updated entity is Store API aware.
  • customFieldsAware - Indicates if the updated entity supports custom fields.
  • labelProperty - Label property of the updated custom entity.
  • deletedAt - Deletion timestamp of the updated custom entity.
  • createdAt - Creation timestamp of the updated custom entity.
  • updatedAt - Last update timestamp of the custom entity.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the identifier of an existing custom entity; otherwise, the update will fail.
  • Verify that JSON fields such as 'Fields' and 'Flags' are valid JSON strings to avoid parsing errors.
  • Check API credentials and base URL configuration to ensure connectivity to the Shopware Admin API.
  • Timeouts or SSL issues can be troubleshooted by adjusting the 'Timeout' and 'Ignore SSL Issues' options in the request settings.

Links

Discussion